sindresorhus/eslint-plugin-unicorn

idea: for `expiring-todo-comments`: warn when GitHub issue is closed

Chiusa

#1858 aperta il 13 lug 2022

Vedi su GitHubGuida contributor
 (8 commenti) (2 reazioni) (0 assegnatari)JavaScript (468 fork)user submission
enhancementhelp wanted

Metriche repository

Star
 (5022 stelle)
Metriche merge PR
 (Merge medio 4h 30m) (26 PR mergiate in 30 g)

Descrizione

I think this idea has been raised before, but I'm not sure it has with this specific restriction:

For a todo written like

// todo [#1234] until we refactor fooService, this hack prevents bar from bazing
delete bar.baz

Previously (I think) this idea has been rejected because hitting the GitHub API is an inappropriate thing to do from a lint rule, which is true. But there are many projects which keep a changelog.md file using a format like the one suggested by https://keepachangelog.com. If that changelog.md happens to include the words Fixes #1234 or Resolves #1234 or Closes #1234, then this plugin could assume that that issue is closed, and turn this todo into an "expired" one.

It wouldn't be 100% accurate, or work with 100% of projects, but might be better than not having it?

Guida contributor

Direzione di ricerca
Esamina la regola esistente 'expiring todo comments' nel repository eslint plugin unicorn per capire come attualmente rileva i commenti scaduti. Verifica se ci sono riferimenti esistenti al parsing del changelog. Quindi, progetta un metodo per analizzare un file changelog.md (assumendo che segua il formato keepachangelog) alla ricerca di pattern di chiusura issue come 'Fixes #1234'. Considera le implicazioni sulle prestazioni e se questo dovrebbe essere un'opzione o una regola separata. Rivedi i commenti nell'issue #1858 per ulteriori vincoli e feedback della comunità.
Tech stack
javascript
Dominio
developer experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
JavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65