Repository navigation
Meta: silence delayed TODOs - #9538
Conversation
Agent-Logs-Url: https://github.com/refined-github/refined-github/sessions/0277a686-89e5-4f8c-a040-38c3d47cb3e1 Co-authored-by: fregante <1402241+fregante@users.noreply.github.com>
Agent-Logs-Url: https://github.com/refined-github/refined-github/sessions/06e2b684-b4b2-4e17-86b8-03f88bddc3c1 Co-authored-by: fregante <1402241+fregante@users.noreply.github.com>
unicorn/expiring-todo-comments formatunicorn/expiring-todo-comments warnings
Agent-Logs-Url: https://github.com/refined-github/refined-github/sessions/9d6e7d09-b0b5-4bde-824b-0f76522092bf Co-authored-by: fregante <1402241+fregante@users.noreply.github.com>
|
This is much less readable for me. Anyway, what's the benefit? Feels like that rule that requires comments to begin with a capital letter |
|
The benefit is that we have a million TODO comments that cannot BE DONE today, completely overshadowing those that can. I had to disable the "todo" eslint rule because each eslint call would print 100 lines of noise. At this point I'm not even sure what TODOs we have in the repo because the vast majority of them are just reminders for later this year. What's the purpose of a comment you can read but can't act on? With this rule we'll actually be notified of the comment once it's ready to be acted on. They won't even be underlined yellow in the IDE, so you'll know you don't have to read them. |
|
It is true that "Drop in October 2026" is better than "[2026-10-01]: Drop" but the former shows up as a warning in the IDE, taking your attention, the latter does not. So in a way it's the opposite of the capitalization rule, because it reduces the noise. If I look at the lint step now, I can see that there are 19 issues we can address today. I'd like to merge this PR and then immediately address them or postpone their dates. |
fregante
changed the title
unicorn/expiring-todo-comments warnings
| } | ||
|
|
||
| // Legacy PR files view -- TODO: Drop after it is removed | ||
| // TODO [2027-01-01]: Drop after legacy PR files view is removed |
There was a problem hiding this comment.
I also set "2027" as a date for legacy PRs since we certainly won't be able to drop it before then (today + 6 months).
When the comments expire, we can review and delete or postpone them again by changing 1 character.
The advantage is that our lint step now prints 0 lines (other than the expired comments that I will address in the followup PR)
Ain't that better?
| // https://github.com/refined-github/refined-github/issues/9496 | ||
| // TODO: Too many. Too noisy. Re-enable after resolving some. | ||
| 'no-warning-comments': 'off', | ||
| 'unicorn/expiring-todo-comments': 'warn', |
There was a problem hiding this comment.
OK, I just noticed this. This is great, I agree 👍
Date parser could be smarter, though.
|
I ended up removing warnings altogether after this discussion: sindresorhus/eslint-plugin-unicorn#1207 (comment) No more lint output, no more |
Uh oh!
There was an error while loading. Please reload this page.