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

Enable eslint-comments/require-description #704

Merged
merged 8 commits into from
Jul 21, 2023

Conversation

fregante
Copy link
Member

@fregante fregante commented Feb 20, 2023

Heh, this causes XO itself to be reported 😃

Error: /home/runner/work/xo/xo/cli.js: line 2, col 0, Error - Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary. (eslint-comments/require-description)
Error: /home/runner/work/xo/xo/index.js: line 92, col 0, Error - Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary. (eslint-comments/require-description)
Error: /home/runner/work/xo/xo/lib/options-manager.js: line 532, col 0, Error - Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary. (eslint-comments/require-description)
Error: /home/runner/work/xo/xo/lib/options-manager.js: line 536, col 0, Error - Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary. (eslint-comments/require-description)
Error: /home/runner/work/xo/xo/test/lint-files.js: line 231, col 0, Error - Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary. (eslint-comments/require-description)
Error: /home/runner/work/xo/xo/test/lint-files.js: line 254, col 0, Error - Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary. (eslint-comments/require-description)
Error: /home/runner/work/xo/xo/test/lint-files.js: line 280, col 0, Error - Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary. (eslint-comments/require-description)
Error: /home/runner/work/xo/xo/test/lint-files.js: line 296, col 0, Error - Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary. (eslint-comments/require-description)
Error: /home/runner/work/xo/xo/test/open-report.js: line 1, col 0, Error - Unexpected undescribed directive comment. Include descriptions to explain why the comment is necessary. (eslint-comments/require-description

@fregante
Copy link
Member Author

Any new rules that can be added?

@fregante fregante marked this pull request as draft February 20, 2023 16:53
@fregante
Copy link
Member Author

fregante commented Mar 2, 2023

Kinda weird, there are no further such comments. The errors you can see appear on random lines 🤔

@fregante fregante marked this pull request as ready for review March 2, 2023 03:29
@sindresorhus
Copy link
Member

Not sure I want more rules from that plugin. It has not seen any activity for years: https://github.com/mysticatea/eslint-plugin-eslint-comments

@fregante
Copy link
Member Author

Still worth merging this?

@sindresorhus
Copy link
Member

sindresorhus commented Jul 20, 2023

No, I don't think so. The plugin is unmaintained, and while I think it could be useful to document when you ignore, it's going to be super annoying in practice and cause a huge amount of churn.

I'm happy to merge this PR with just the ignore comment explanations though.

@sindresorhus sindresorhus merged commit 2452616 into main Jul 21, 2023
6 checks passed
@sindresorhus sindresorhus deleted the eslint-comments/require-description branch July 21, 2023 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Require explanation on eslint-disable and ts-expect-error
2 participants