CTAN Comprehensive TeX Archive Network

New on CTAN: hook-pre-commit-pkg

Date: February 23, 2015 10:38:34 AM CET
Maïeul Rouquette submitted the hook-pre-commit-pkg package. Version number: 1.1.0 License type: gpl3 Summary description: Pre-commit git hook for LaTeX package developpers. Announcement text:
Pre-commit hook for LaTeX package developpers === What it is ? A pre-commit hook to check basic LaTeX syntax for package developers. ==== 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 is checked Only for new line, these properties are checked: - All lines must finish by a %, without space before. Empty lines are allowed, but not lines 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} or \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.0 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.
This package is located at http://mirror.ctan.org/support/hook-pre-commit-pkg/ More information is at http://www.ctan.org/pkg/hook-pre-commit-pkg We are supported by the TeX Users Group http://www.tug.org . Please join a users group; see http://www.tug.org/usergroups.html .
Thanks for the upload. For the CTAN Team Petra Rübe-Pugliese

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.

Packagehook-pre-commit-pkg
Version1.1.2
Copyright2014–2016 Maïeul Rouquette
MaintainerMaïeul Rouquette

Announcements

more

Guest Book Sitemap Contact Contact Author