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

Make require-description message clear about the format #54

Open bisubus opened 3 years ago

bisubus commented 3 years ago

That the rule expects a specific format makes it uncomfortable to use when you see it the first time, as opposed to e.g. TS @ts-ignore directive that allows to provide a description in free form.

The message is already verbose enough:

Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary.

Could be more friendly:

Unexpected undescribed directive comment. Include a description separated with -- to explain why the comment is necessary.

MichaelDeBoey commented 8 months ago

Hi @bisubus!

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