google / eslint-config-google

ESLint shareable config for the Google JavaScript style guide
Apache License 2.0
1.75k stars 139 forks source link

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

Closed vibhavsinha closed 5 months ago

vibhavsinha commented 3 years ago

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?