Skip to content

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

Closed
@aduth

Description

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

Metadata

Assignees

No one assigned

    Labels

    Good First IssueAn issue that's suitable for someone looking to contribute for the first timeNeeds DevReady for, and needs developer efforts[Tool] ESLint plugin/packages/eslint-plugin[Type] TaskIssues or PRs that have been broken down into an individual action to take

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions