feat: suggest to add comments inside empty blocks #16096
Conversation
eslint-github-bot
bot
added
triage
✅ Deploy Preview for docs-eslint canceled.
|
mdjermanovic
added
rule
There was a problem hiding this comment.
Can you add suggestions property to errors in "invalid" test cases, to test this change?
Example: https://github.com/eslint/eslint/blob/main/tests/lib/rules/no-useless-escape.js
amareshsm
force-pushed
the
add-comments-in-empty-blocks
branch
from
24c281d
to
f0638f4
Compare
|
@amareshsm PR is still missing the tests update (#16096 (review)) |
| @@ -51,6 +53,7 @@ module.exports = { | |||
|
|
|||
| return { | |||
| BlockStatement(node) { | |||
| const range = [node.range[0] + 1, node.range[1] - 1]; | |||
There was a problem hiding this comment.
Can we move this into fix(fixer), since it's needed only for the fix, and at this point it isn't clear what the range represents.
| suggest: [ | ||
| { | ||
| messageId: "suggestComment", | ||
| data: { type: "switch" }, | ||
| fix(fixer) { | ||
| return fixer.replaceTextRange(range, " /* empty */ "); | ||
| } | ||
| } | ||
| ] |
There was a problem hiding this comment.
The implementation is correct, but adding a comment inside an empty SwitchStatement doesn't really help, because it's still considered an error by this rule (playground link) so it seems we should provide these suggestions only for BlockStatement nodes.
There was a problem hiding this comment.
In other words, this rule shouldn't provide suggestion to add a comment inside an empty switch statement, because that won't fix the lint problem reported by this rule.
|
@amareshsm are you still working on this? |
|
I'll finish this. |
|
Closing in favor of #16470 |
eslint-github-bot
bot
added
the
archived due to age
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[x] Changes an existing rule (template)
[ ] Add auto fix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Suggest adding comments inside empty block statements.
Fixes #15899
Is there anything you'd like reviewers to focus on?