search

gajus / eslint-plugin-jsdoc

JSDoc specific linting rules for ESLint.
Other
1.09k stars 157 forks source link

Code example for eslint-plugin-jsdoc needs to be updated #1302

Closed redrogers closed 1 month ago

redrogers commented 1 month ago

In the example config for eslintrc:

plugins: [ "jsdoc" ]

needs to be updated to: plugins: [ "eslint-plugin-jsdoc ]

brettz9 commented 1 month ago

Thanks, but as per https://eslint.org/docs/latest/use/configure/plugins-deprecated#configure-plugins

The eslint-plugin- prefix can be omitted from the plugin name

So the docs should be all right as they are.

The ESLint 9/Flat Config format is altogether different, but that is documented separately:

import jsdoc from 'eslint-plugin-jsdoc';

export default [
  {
    plugins: {
      jsdoc
  }
];
brettz9 commented 1 month ago

Closing as I think it is ok, but feel free to comment further as needed.