search

mysticatea / eslint-plugin-eslint-comments

Additional ESLint rules for directive comments of ESLint.
https://mysticatea.github.io/eslint-plugin-eslint-comments/
MIT License
354 stars 44 forks source link

[require-description] duplicated description UX for use with disable-enable-pair #49

Closed dimitropoulos closed 8 months ago

dimitropoulos commented 3 years ago

consider the following example:

/*eslint eslint-comments/disable-enable-pair: error */
/*eslint eslint-comments/require-description: error */

/*eslint-disable no-undef, no-unused-vars -- My reason for doing this is XYZ */
var foo = bar()
/*eslint-enable no-undef, no-unused-vars -- see above */

I love the new require-description rule, but I find that in practice, when it's used for disable-enable-pair enables... it can be a little clunky. Any ideas on how to improve the user experience in this case? Maybe we can give require-description an option to not require descriptions on eslint-enable lines? Personally, turning a rule back on isn't something I really need a description for so this would work for me. Any other ideas?

I'm happy to make a PR - just lemme know.

MichaelDeBoey commented 8 months ago

Hi @dimitropoulos!

Since this repo is unmaintained, you might want to re-open this issue in the @eslint-community fork https://github.com/eslint-community/eslint-plugin-eslint-comments

For more info about why we created this organization, you can read https://eslint.org/blog/2023/03/announcing-eslint-community-org

dimitropoulos commented 8 months ago

sure thing: thanks @MichaelDeBoey for all your work for so many years on this stuff!