search

gajus / eslint-plugin-jsdoc

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

fix: add names to flat configs #1238

Closed voxpelli closed 3 months ago

voxpelli commented 3 months ago

See https://eslint.org/docs/latest/use/configure/configuration-files#configuration-naming-conventions and eg https://github.com/eslint-community/eslint-plugin-eslint-plugin/pull/459

Improves presentation in the config inspector: https://github.com/eslint/config-inspector

github-actions[bot] commented 3 months ago

:tada: This PR is included in version 48.2.10 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

brettz9 commented 3 months ago

@voxpelli : A belated thanks for this PR. Do you think we should prefix the name with jsdoc/ though? Seems the docs suggest incorporating the plugin name too.

voxpelli commented 3 months ago

For example, if you are creating a configuration object for a plugin named eslint-plugin-example, you might add name to the configuration objects with the example/ prefix

@brettz9 🙏 that's what I'm reading in the docs?

brettz9 commented 3 months ago

Ok, I can add that

brettz9 commented 3 months ago

Released in v48.2.12.