Chaque raccourci délibéré est marqué par un commentaire shortcut: nommant
sa limite et son chemin de mise à niveau (le code plus ancien peut dire ponytail:). Cela les rassemble dans un registre afin qu'un report
ne puisse pas devenir silencieusement permanent.
Analyse
Grep le dépôt pour les marqueurs de commentaires, en ignorant .git et tout ce que
les fichiers .gitignore ignorent (dépendances, sorties de build, caches, dans n'importe quelle pile) :
git grep --no-index --exclude-standard -nE '(#|//|/[*]) ?(shortcut|ponytail):' (ajoutez d'autres préfixes de commentaires si votre pile les utilise)
Si l'utilisateur nomme son propre mot marqueur (/ponytail-debt TODO), grep pour ce mot à la place.
Chaque résultat est une ligne du registre. Le préfixe de commentaire empêche que du texte qui mentionne simplement la convention ne soit inclus dans le registre. Ignorez les résultats qui ne sont pas un report, comme une note sur un raccourci clavier.
Sortie
Une ligne par marqueur, groupée par fichier :
<fichier>:<ligne>, <ce qui a été simplifié>. limite : <la limite nommée>. déclencheur : <le déclencheur pour réviser>.
La convention est shortcut: <limite>, <chemin de mise à niveau>, donc extrayez la limite
et le déclencheur directement du commentaire. Vous voulez un propriétaire par ligne aussi ? ajoutez
git blame -L<ligne>,<ligne>.
Signalez le risque de pourriture : tout commentaire marqueur qui ne nomme pas de chemin de mise à niveau ou de
déclencheur reçoit une balise no-trigger, ce sont ceux qui pourrissent silencieusement.
Terminez par <N> marqueurs, <M> sans déclencheur. Rien trouvé : Aucune dette de raccourci. Registre propre.
Périmètre
Lecture et rapport uniquement, ne modifie rien. Pour le persister, demandez et il écrit le
registre dans un fichier (par exemple PONYTAIL-DEBT.md). Unique.