Accueil > LaTeX > Package > Hook de pre-commit pour fichier .dtx, .sty et autres fichiers de package
Hook de pre-commit pour fichier .dtx, .sty et autres fichiers de package
samedi 21 février 2015, par
Dans un précédent article, je parlais de mon hook de pré-commit pour vérifier l’ajout de de %
à la fin de chaque ligne dans un fichier .dtxy
ou .sty
.
J’ai amélioré ce hook pour lui ajouter d’autres fonctions de vérifications utiles lorsqu’on crée des packages LaTeX.
Principe
Les fichiers .dtx
permettent de documenter un code LaTeX en même temps qu’on le saisit. Il nécessite cependant une syntaxe rigoureuse, et il m’arrive parfois de faire quelques erreurs.
Installation
Rien ne changer : télécharger le hook, l’installer dans le dossier .git/hook
, le renommer pre-commit
, et faire un chmod +x
dessus.
Fonctionnalité
**Fins de ligne
La fonction principale reste, bien sûr : impossibilité de commiter si un ligne non vide ne finit pas par un %
, ou si ce %
est précédé d’un ou plusieurs espaces.
**Commande \cs{}
Impossible de commiter si l’argument d’une commande \cs
commence par un \
**Environnement macro
et macrocode
– Impossible de commiter si le début ou la fin de l’environnement n’est pas sur une ligne spécifique.
– Vérification du nombre d’espaces entre le %<code> et le <code>\begin
ou \end
: 1 pour macro
et 4 pour macrocode
. Impossible de commiter dans le cas contraire.
– Vérification des appareillement d’environnement. Attention, on ne vérifie pas les éventuelles suppressions de début/fin d’environnement. Impossible de vérifier dans le cas contraire.
– Vérifier que le nom de la macro est bien mentionné après \begin{macro}
.
Comme avant, le code est versionné sur Github.