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
no-warning-comments
should include the comment itself in the report (UX only)
#12327
Comments
I'll champion this. |
We need at least 3 upvotes from @eslint/eslint-team to accept this enhancement. |
In general, I'm in support of this, though I do think we want to have some kind of prepended message so it's clear what is being warned about. |
Should we truncate the comment in case it's really long? Should we show only the first line in a multiple-line block comment? |
I think we can set a number of char to show in the message report followed by I think 30-40 chars limit can be good. |
@g-plane as the champion, it's up to you to get the support of others on the ESLint team. It looks like we are still missing two more 👍s. |
@eslint/eslint-team Would we like to support this? |
+1 for this. I can think of something like this
I can take this if this gets accepted 👍 |
There are 3 👍 from team members now, so marking as accepted. |
@g-plane are you working in this? |
Currently, no. |
I can work on this if it's ok? |
Sure. Feel free to do it. |
I think the point of this rule is to keep track of TODO comments, however this is hard to follow; I'd have to open each file separately to see if I can handle a task.
What rule do you want to change?
no-warning-comments
Does this change cause the rule to produce more or fewer warnings?
Unchanged. It's only about UX
How will the change be implemented? (New option, new default behavior, etc.)?
New default
What does the rule currently do for this code?
Shown above
What will the rule do after it's changed?
The text was updated successfully, but these errors were encountered: