Directory support/hook-pre-commit-pkg

Pre-commit hook for LaTeX package developers


=== What it is ?
A pre-commit hook to check basic LaTeX syntax for developer of package.

==== How to install
Copy pre-commit in the .git/hooks file
Add execution right (chmod +x)
Enjoy !

====Checked files
    - .sty
    - .dtx
    - .bbx
    - .cbx
    - .lbx

====What are checked
Only for new line, these properties are checked:
    - All line must finish by a %, without space before.
    Empty line are allowed, but not line with blank space.
    - \begin{macro} and \end{macro} must be paired.
    - \begin{macrocode} and \end{macrocode} must be paired.
    - \begin{macro} must have a second argument.
    - 1 space must be printed between % and \begin{macro} of \end{macro}. % Must be the first line character.
    - 4 spaces must be printed between % and \begin{macrocode} or \end{macrocode}.
    - \cs argument must NOT start by an \

=== Licence and copyright
Maïeul Rouquette 2014-....
v 1.1.2
Licence GPl3 https://www.gnu.org/licenses/gpl-3.0.txt

=== Help and github repository
https://github.com/maieul/git-hooks
Open an issue for any needs.

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

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

This package provides a pre-commit git hook to check basic LaTeX 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.

Package	hook-pre-commit-pkg
Repository	https://github.com/maieul/git-hooks
Version	1.1.2
Licenses	GNU General Public License, version 3
Copyright	2014–2016 Maïeul Rouquette
Maintainer	Maïeul Rouquette
Contained in	TeX Live as hook-pre-commit-pkg
Topics	Package development