ponytail-debt

Todo atalho de rabo de cavalo deliberado é marcado com um comentário shortcut: nomeando seu teto e caminho de atualização (código mais antigo pode dizer ponytail:). Isso os coleta em um único registro para que um adiamento não possa se tornar permanentemente silencioso.

Escanear

Use grep no repositório para marcadores de comentário, pulando .git e tudo que os arquivos .gitignore ignoram (dependências, saída de compilação, caches, em qualquer pilha):

git grep --no-index --exclude-standard -nE '(#|//|/[*]) ?(shortcut|ponytail):' (adicione outros prefixos de comentário se sua pilha os usar)

Se o usuário nomear sua própria palavra marcadora (/ponytail-debt TODO), use grep para essa palavra em vez disso.

Cada correspondência é uma linha do registro. O prefixo do comentário impede que prosa que apenas menciona a convenção entre no registro. Pule correspondências que não são um adiamento, como uma nota sobre um atalho de teclado.

Saída

Uma linha por marcador, agrupada por arquivo:

<file>:<line>, <what was simplified>. ceiling: <the limit named>. upgrade: <the trigger to revisit>.

A convenção é shortcut: <ceiling>, <upgrade path>, então puxe o teto e o gatilho diretamente do comentário. Quer um proprietário por linha também? adicione git blame -L<line>,<line>.

Marque o risco de deterioração: qualquer comentário marcador que não nomeie um caminho de atualização ou gatilho recebe uma tag no-trigger, esses são os que se deterioram silenciosamente.

Termine com <N> markers, <M> with no trigger. Nada encontrado: No shortcut debt. Clean ledger.

Limites

Lê e relata apenas, não altera nada. Para persistir, peça e ele escreverá o registro em um arquivo (por exemplo, PONYTAIL-DEBT.md). Execução única.