CTAN Comprehensive TeX Archive Network

hook-pre-commit-pkg – Pre-commit git hook for package developpers

This package provides a pre-commit git hook to check basic syntax for the use of package developers.

It is installed by copying it into the .git/.hooks file.

It then checks the following file types: .sty, .dtx, .bbx, .cbx, and .lbx.

List of performed checks:

  • Each line must be terminated by a %, without a space before it. Empty lines are allowed, but not lines with nothing but spaces in them.
  • \begin{macro} and \end{macro} must be paired.
  • \begin{macrocode} and \end{macrocode} must be paired.
  • \begin{macro} must have a second argument.
  • One space must be printed between % and \begin{macro} or \end{macro}. % must be the first character in the line.
  • Four spaces must be printed between % and \begin{macrocode} or \end{macrocode}.
  • \cs argument must not start with a backslash.

Sources/support/hook-pre-commit-pkg
Documentation
Repositoryhttps://github.com/maieul/git-hooks
Version1.1.2
LicensesGNU General Public License, version 3
Copyright2014–2016 Maïeul Rouquette
MaintainerMaïeul Rouquette
Contained inTeX Live as hook-pre-commit-pkg
TopicsPackage development

Download the contents of this package in one zip archive (3.4k).

Export the package reference as file

Community Comments

Loading...

Announcements

Here you can see a respective diagram in newer browsers.

more

Package Links

Guest Book Sitemap Contact Contact Author