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

eslint-plugin: Increase severity of JSDoc rules to error #18458

Closed
aduth opened this issue Nov 12, 2019 · 2 comments · Fixed by #20427
Closed

eslint-plugin: Increase severity of JSDoc rules to error #18458

aduth opened this issue Nov 12, 2019 · 2 comments · Fixed by #20427
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time Needs Dev Ready for, and needs developer efforts [Tool] ESLint plugin /packages/eslint-plugin [Type] Task Issues or PRs that have been broken down into an individual action to take

Comments

@aduth
Copy link
Member

aduth commented Nov 12, 2019

Previously: #16869 (comment)

We should generally seek to avoid any 'warn' severity in our rulesets. If we have a rule, it should be enforced strictly, else it shouldn't be a rule. Exceptions are to be made using inline comments.

Task: In the jsdoc ruleset, all custom rule configurations should be changed from 'warn' to 'error'. Similarly, if we are extending 'plugin:jsdoc/recommended', we should override all rules with equivalents where the severity is changed from 'warn' to 'error'.

Reference for 'jsdoc/recommended' rules: https://github.com/gajus/eslint-plugin-jsdoc/blob/master/src/index.js#L34

@aduth aduth added [Type] Task Issues or PRs that have been broken down into an individual action to take [Tool] ESLint plugin /packages/eslint-plugin labels Nov 12, 2019
@gziolo gziolo added Good First Issue An issue that's suitable for someone looking to contribute for the first time Needs Dev Ready for, and needs developer efforts labels Dec 9, 2019
@gziolo
Copy link
Member

gziolo commented Dec 9, 2019

We should generally seek to avoid any 'warn' severity in our rulesets. If we have a rule, it should be enforced strictly, else it shouldn't be a rule. Exceptions are to be made using inline comments.

Totally agree. Warnings are ignored by contributors. We should stop using them and pick errors instead 👍

@aduth
Copy link
Member Author

aduth commented Jan 21, 2020

Noting that we have a fair few warnings related to invalid syntax caused by TypeScript-specific JSDoc extensions which are not yet supported by eslint-plugin-jsdoc.

See also: jsdoctypeparser/jsdoctypeparser#50, #18838

We could consider to either leave this one specifically as a warning in the meantime (granting that it's blocked by some future compatibility improvements), or disable it altogether.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time Needs Dev Ready for, and needs developer efforts [Tool] ESLint plugin /packages/eslint-plugin [Type] Task Issues or PRs that have been broken down into an individual action to take
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants