Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Warn TODOs without comment

See original GitHub issue

When does this rule warn? Please describe and show example code:

// Good
// TODO: I'd like to find a way to make this faster

// Bad

Is this rule preventing an error or is it stylistic?


Why is this rule a candidate for inclusion instead of creating a custom rule?

It is specified in official code conventions:

Comments may be used to annotate pieces of code with additional information. TODO - indicates that the code is not yet complete. Information about the next steps should be included.

Also implemented by rubocop (linter for ruby).

Are you willing to create the rule yourself?


Issue Analytics

  • State:closed
  • Created 7 years ago
  • Comments:14 (8 by maintainers)

github_iconTop GitHub Comments

nzakascommented, Sep 1, 2016

@ypresto I’m sorry, there’s not enough support on the team for this. If you still want the rule, you can always create a custom rule instead.

platinumazurecommented, Aug 24, 2016

I think maybe it should be a separate rule after all. Yes, I know I advocated the opposite earlier but I’ve come around.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Warn About TODOs - Visual Studio Marketplace
Visual Studio automatically takes code comments that include TODO and turns them into User Tasks that are displayed on the Task List.
Read more >
TODO comments are not clean code. Use them correctly!
I have realized TODO comments should not be part of the production code. They can be practical in the development process. There is...
Read more >
no-warning-comments - ESLint - Pluggable JavaScript Linter
A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript. Maintain your code quality with ease.
Read more >
Replace TODO comments in your code with WARNING log ...
About a year ago I stopped writing TODO comments in my code. I always forget about them and they rarely get found and...
Read more >
How do I disable "TODO" warnings in pylint? - Stack Overflow
Note that if your # TODO comment starts at the start of a line (i.e. it's a block comment rather than an inline...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found