You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/users/Shared_Configurations.mdx
+27-2
Original file line number
Diff line number
Diff line change
@@ -184,10 +184,15 @@ module.exports = {
184
184
Some rules also enabled in `recommended` default to more strict settings in this configuration.
185
185
See [`configs/strict.ts`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts) for the exact contents of this config.
186
186
187
-
:::caution
187
+
:::tip
188
188
We recommend a TypeScript project extend from `plugin:@typescript-eslint/strict` only if a nontrivial percentage of its developers are highly proficient in TypeScript.
189
189
:::
190
190
191
+
:::warning
192
+
This configuration is not considered "stable" under Semantic Versioning (semver).
193
+
Its enabled rules and/or their options may change outside of major version updates.
194
+
:::
195
+
191
196
### `strict-type-checked`
192
197
193
198
Contains all of `recommended`, `recommended-type-checked`, and `strict`, along with additional strict rules that require type information.
@@ -215,10 +220,15 @@ module.exports = {
215
220
Some rules also enabled in `recommended-type-checked` default to more strict settings in this configuration.
216
221
See [`configs/strict-type-checked.ts`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict-type-checked.ts) for the exact contents of this config.
217
222
218
-
:::caution
223
+
:::tip
219
224
We recommend a TypeScript project extend from `plugin:@typescript-eslint/strict-type-checked` only if a nontrivial percentage of its developers are highly proficient in TypeScript.
220
225
:::
221
226
227
+
:::warning
228
+
This configuration is not considered "stable" under Semantic Versioning (semver).
229
+
Its enabled rules and/or their options may change outside of major version updates.
230
+
:::
231
+
222
232
### `stylistic`
223
233
224
234
Rules considered to be best practice for modern TypeScript codebases, but that do not impact program logic.
@@ -293,6 +303,11 @@ We do not recommend TypeScript projects extend from `plugin:@typescript-eslint/a
293
303
Many rules conflict with each other and/or are intended to be configured per-project.
294
304
:::
295
305
306
+
:::warning
307
+
This configuration is not considered "stable" under Semantic Versioning (semver).
308
+
Its enabled rules and/or their options may change outside of major version updates.
309
+
:::
310
+
296
311
### `base`
297
312
298
313
A minimal ruleset that sets only the required parser and plugin options needed to run typescript-eslint.
@@ -366,6 +381,11 @@ module.exports = {
366
381
</TabItem>
367
382
</Tabs>
368
383
384
+
:::warning
385
+
This configuration is not considered "stable" under Semantic Versioning (semver).
386
+
Its enabled rules and/or their options may change outside of major version updates.
387
+
:::
388
+
369
389
### `eslint-recommended`
370
390
371
391
This ruleset is meant to be used after extending `eslint:recommended`.
@@ -427,6 +447,11 @@ module.exports = {
427
447
428
448
See [`configs/strict-type-checked-only.ts`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict-type-checked-only.ts) for the exact contents of this config.
429
449
450
+
:::warning
451
+
This configuration is not considered "stable" under Semantic Versioning (semver).
452
+
Its enabled rules and/or their options may change outside of major version updates.
453
+
:::
454
+
430
455
### `stylistic-type-checked-only`
431
456
432
457
A version of `stylistic` that _only_ contains type-checked rules and disables of any corresponding core ESLint rules.
0 commit comments