-
Notifications
You must be signed in to change notification settings - Fork 195
Open
Labels
featurea feature request or enhancementa feature request or enhancement
Description
Unsure if a new linter or an extension to todo_comment_linter(); #2047 is related.
In codebases encouraging TODO to be linked to a GitHub issue, there's a tendency for these comments to stale out eventually:
# TODO(#1234): Improve thisLater issue #1234 is fixed, but this TODO is still sitting around in the codebase.
We can lint for some common issues:
TODO(#N)for#Nthat is not a valid issueTODO(#M)for#Mthat is a valid, but already closed issue
There are two things to consider for design:
- How do we populate the list of valid issues and their statuses? If we just assume
GitHub, it's pretty straightforward: use {gh} or just {httr2} (Use {httr2}, not {httr} #2148) to hit the GitHub API. But it would be nice to make a flexible enough design so that users hosting packages/projects on other VCS or even using Jira/Bugzilla/etc. can make use of the functionality. - When do we so? I think the most natural way is at linter creation time (i.e. in the factory environment) since this will likely be slow.
Metadata
Metadata
Assignees
Labels
featurea feature request or enhancementa feature request or enhancement