sindresorhus/eslint-plugin-unicorn

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

Closed

#1,858 opened on Jul 13, 2022

View on GitHubContributor guide
 (8 comments) (2 reactions) (0 assignees)JavaScript (468 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

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?

Contributor guide

Research direction
Study the existing expiring todo comments rule implementation and explore how to detect issue closure from changelog entries. Consider parsing the changelog file for patterns like 'Fixes #1234' and cross referencing with TODO issue references.
Tech stack
javascript
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65