Skip to content

Commit 07d603a

Browse files
docs: mention non-semver guarantees in Shared Configs docs (typescript-eslint#9257)
* docs: mention non-semver guarantees in Shared Configs docs * Switch to warnings
1 parent 81fd60b commit 07d603a

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

docs/users/Shared_Configurations.mdx

+27-2
Original file line numberDiff line numberDiff line change
@@ -184,10 +184,15 @@ module.exports = {
184184
Some rules also enabled in `recommended` default to more strict settings in this configuration.
185185
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.
186186

187-
:::caution
187+
:::tip
188188
We recommend a TypeScript project extend from `plugin:@typescript-eslint/strict` only if a nontrivial percentage of its developers are highly proficient in TypeScript.
189189
:::
190190

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+
191196
### `strict-type-checked`
192197

193198
Contains all of `recommended`, `recommended-type-checked`, and `strict`, along with additional strict rules that require type information.
@@ -215,10 +220,15 @@ module.exports = {
215220
Some rules also enabled in `recommended-type-checked` default to more strict settings in this configuration.
216221
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.
217222

218-
:::caution
223+
:::tip
219224
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.
220225
:::
221226

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+
222232
### `stylistic`
223233

224234
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
293303
Many rules conflict with each other and/or are intended to be configured per-project.
294304
:::
295305

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+
296311
### `base`
297312

298313
A minimal ruleset that sets only the required parser and plugin options needed to run typescript-eslint.
@@ -366,6 +381,11 @@ module.exports = {
366381
</TabItem>
367382
</Tabs>
368383

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+
369389
### `eslint-recommended`
370390

371391
This ruleset is meant to be used after extending `eslint:recommended`.
@@ -427,6 +447,11 @@ module.exports = {
427447

428448
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.
429449

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+
430455
### `stylistic-type-checked-only`
431456

432457
A version of `stylistic` that _only_ contains type-checked rules and disables of any corresponding core ESLint rules.

0 commit comments

Comments
 (0)