Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Rule: TODO in comments #382

Open
kivra-pauoli opened this issue Feb 14, 2025 · 3 comments
Open

New Rule: TODO in comments #382

kivra-pauoli opened this issue Feb 14, 2025 · 3 comments
Labels
Milestone

Comments

@kivra-pauoli
Copy link
Contributor

Name

todo_in_comments

Brief Description

It'd detect TODO and/or FIXME in comments, for example (or a reserved list that could start small) and tell the developer what it found. It not be in the regular ruleset, but in the strict one, by default.

Reasoning

Inspiration: https://hexdocs.pm/credo/Credo.Check.Design.TagTODO.html

Refactoring Proposal

Remove TODO.

@elbrujohalcon
Copy link
Member

It should deal with @todo (the official edoc format for todo's), too.
In fact… if it finds "TODO" or "FIXME" it should recommend using @todo :)

@kivra-pauoli
Copy link
Contributor Author

So, 2 rules? One to remove @todo (for the "strict" ruleset), the other one to convert TODO to @todo (for all rulesets)?

@elbrujohalcon
Copy link
Member

Cool. Yeah.

@elbrujohalcon elbrujohalcon added this to the 4.0.0 milestone Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants