Skip to content

Plan for replacing valid-jsdoc and require-jsdoc #691

@vibhavsinha

Description

@vibhavsinha

Motivation

Eslint rules for valid-jsdoc and require-jsdoc are deprecated.

The require-jsdoc and valid-jsdoc rules will be deprecated. These two rules will remain in ESLint but we will no longer add new features or fix bugs for them. These rules may be removed in a future major release of ESLint.

Desired behavior

The official documentation recommends using eslint-plugin-jsdoc for this purpose.

Suggested Replacement
If you would like to continue checking JSDoc comments using ESLint, we suggest using the community-supported eslint-plugin-jsdoc plugin. This plugin contains several rules that are more specific than the core ESLint rules being deprecated and may actually be a better fit for most projects.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions