Skip to content

Commit 8a998e9

Browse files
committed
docs: add rationales section
1 parent 06ba1a7 commit 8a998e9

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

.README/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,28 @@ export default [
9797
];
9898
```
9999

100+
##### Why certain rules were excluded from the granular configs
101+
102+
A few rules were left out of the granular configs. Here is why:
103+
104+
Rules which might have been added to `required`:
105+
- [`require-throws`](./docs/rules/require-throws.md#readme) - Since this can't enforce all cases, some may not wish this rule enforced.
106+
- [`require-file-overview`](./docs/rules/require-file-overview.md#readme) - Too demanding for all projects
107+
- [`convert-to-jsdoc-comments`](./docs/rules/convert-to-jsdoc-comments.md#readme) - Overly aggressive for some projects
108+
109+
Rules which might have been added to `logical`:
110+
- [`no-missing-syntax`](./docs/rules/no-missing-syntax.md#readme) - Has no default options.
111+
- [`no-restricted-syntax`](./docs/rules/no-restricted-syntax.md#readme) - Has no default options.
112+
113+
Rules which might have been added to `contents`:
114+
- [`match-name`](./docs/rules/match-name.md#readme) - Has no default options.
115+
- [`require-description`](./docs/rules/require-description.md#readme) - Too demanding for all projects
116+
- [`require-description-complete-sentence`](./docs/rules/require-description-complete-sentence.md#readme) - Too demanding for all projects
117+
118+
Rules which might have been added to `stylistic`:
119+
- [`check-indentation`](./docs/rules/check-indentation.md#readme) - May not be desired by all projects
120+
- [`sort-tags`](./docs/rules/sort-tags.md#readme) - Too project-specific
121+
100122
### `eslintrc`
101123

102124
Add `plugins` section to [.eslintrc.*](https://eslint.org/docs/user-guide/configuring#configuration-file-formats)

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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

Comments
 (0)