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

Feature request - add comment style to eslint.codeAction.disableRuleComment #1490

Closed
OneHoopyFrood opened this issue Jun 29, 2022 · 2 comments
Labels
feature-request Request for new features or functionality
Milestone

Comments

@OneHoopyFrood
Copy link

OneHoopyFrood commented Jun 29, 2022

TLDR:

I'd like a setting added to eslint.codeAction.disableRuleComment to have it inject block-style comments (/* */) rather than line style (//)

Context:

I use eslint-require-description to enforce the use of comments for eslint-ignore comments. (See eslint/rfcs#33).

This helps us reduce abuse of ignore comments and to aid in code review. We also have a formatting rule that limits comment line length and wraps them.

The automatic injection of ignore rules is very useful, but when adding descriptions to said ignore comments I nearly always overrun our line length and have to convert the comment to a block style. This does look nicer and I don't want to disable this feature.
It would be very nice to be able to have a setting to have the ignore rule use block-style comments. The most logical place I see to attach such a setting is to eslint.codeAction.disableRuleComment.

@dbaeumer dbaeumer added the feature-request Request for new features or functionality label Jun 30, 2022
@dbaeumer dbaeumer added this to the Backlog milestone Jun 30, 2022
@MariaSolOs
Copy link
Member

I think we can close this now @dbaeumer :)
@OneHoopyFrood see #1499 for info on using the new setting!

@dbaeumer dbaeumer modified the milestones: Backlog, 2.2.next Sep 14, 2022
@dbaeumer
Copy link
Member

@MariaSolOs thanks for pointing this out.

Closing the issue.

@dbaeumer dbaeumer modified the milestones: 2.2.next, 2.4.0 Nov 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request for new features or functionality
Projects
None yet
Development

No branches or pull requests

3 participants