@@ -117,6 +117,30 @@ export default [
117117];
118118```
119119
120+ <a name =" user-content-eslint-plugin-jsdoc-configuration-flat-config-granular-flat-configs-why-certain-rules-were-excluded-from-the-granular-configs " ></a >
121+ <a name =" eslint-plugin-jsdoc-configuration-flat-config-granular-flat-configs-why-certain-rules-were-excluded-from-the-granular-configs " ></a >
122+ ##### Why certain rules were excluded from the granular configs
123+
124+ A few rules were left out of the granular configs. Here is why:
125+
126+ Rules which might have been added to ` required ` :
127+ - [ ` require-throws ` ] ( ./docs/rules/require-throws.md#readme ) - Since this can't enforce all cases, some may not wish this rule enforced.
128+ - [ ` require-file-overview ` ] ( ./docs/rules/require-file-overview.md#readme ) - Too demanding for all projects
129+ - [ ` convert-to-jsdoc-comments ` ] ( ./docs/rules/convert-to-jsdoc-comments.md#readme ) - Overly aggressive for some projects
130+
131+ Rules which might have been added to ` logical ` :
132+ - [ ` no-missing-syntax ` ] ( ./docs/rules/no-missing-syntax.md#readme ) - Has no default options.
133+ - [ ` no-restricted-syntax ` ] ( ./docs/rules/no-restricted-syntax.md#readme ) - Has no default options.
134+
135+ Rules which might have been added to ` contents ` :
136+ - [ ` match-name ` ] ( ./docs/rules/match-name.md#readme ) - Has no default options.
137+ - [ ` require-description ` ] ( ./docs/rules/require-description.md#readme ) - Too demanding for all projects
138+ - [ ` require-description-complete-sentence ` ] ( ./docs/rules/require-description-complete-sentence.md#readme ) - Too demanding for all projects
139+
140+ Rules which might have been added to ` stylistic ` :
141+ - [ ` check-indentation ` ] ( ./docs/rules/check-indentation.md#readme ) - May not be desired by all projects
142+ - [ ` sort-tags ` ] ( ./docs/rules/sort-tags.md#readme ) - Too project-specific
143+
120144<a name =" user-content-eslint-plugin-jsdoc-configuration-eslintrc " ></a >
121145<a name =" eslint-plugin-jsdoc-configuration-eslintrc " ></a >
122146### <code >eslintrc</code >
0 commit comments