gajus / eslint-plugin-jsdoc

JSDoc specific linting rules for ESLint.
Other
1.1k stars 159 forks source link

Add a config with ALL options turned on ("plugin:jsdoc/all") #701

Open mkvlrn-cm42 opened 3 years ago

mkvlrn-cm42 commented 3 years ago

Motivation

Enabling all rules without having to add each rule or the ones missing from the recommended config

Current behavior

There is no extensible "all" config like there is a recommended one "plugin:jsdoc/recommended"

Desired behavior

I would like to be able to enable all rules just by extending such configuration

Alternatives considered

Adding each missing rule from the recommended config or creating/publishing a custom config would do, but I rather stick to the tried and true, reliable configs out there

--- Want to back this issue? **[Post a bounty on it!](https://app.bountysource.com/issues/96849685-add-a-config-with-all-options-turned-on-plugin-jsdoc-all?utm_campaign=plugin&utm_content=tracker%2F23037809&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://app.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F23037809&utm_medium=issues&utm_source=github).
brettz9 commented 3 years ago

This is a good idea, but we should note that we will really need environment-specific "all" configs, e.g., we wouldn't want no-types applying for regular jsdoc.

Note that this issue also ties into #615 where environment-specific "recommended" configs were requested. So this can I think essentially become an issue requesting environment-specific "all" configs.