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

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

Closed
vibhavsinha opened this issue Feb 13, 2021 · 0 comments · Fixed by #72
Closed

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

vibhavsinha opened this issue Feb 13, 2021 · 0 comments · Fixed by #72

Comments

@vibhavsinha
Copy link

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.

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.

Both of these deprecated rules are still in use with this style guide. I am hoping that we can have a change in this project to use alternatives instead of these two rules, or just remove these rules. It is possible to specify the eslint-plugin-jsdoc as part of this configuration.

I have also observed that this project currently does not have any plugins and this might be an intentional decision to keep things simple. Do you plan removing these two rules from this configuration in future?

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 a pull request may close this issue.

1 participant