diff --git a/docs/users/Shared_Configurations.mdx b/docs/users/Shared_Configurations.mdx index c9a1325a8dc6..59c7e26cb66d 100644 --- a/docs/users/Shared_Configurations.mdx +++ b/docs/users/Shared_Configurations.mdx @@ -184,10 +184,15 @@ module.exports = { Some rules also enabled in `recommended` default to more strict settings in this configuration. 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. -:::caution +:::tip We recommend a TypeScript project extend from `plugin:@typescript-eslint/strict` only if a nontrivial percentage of its developers are highly proficient in TypeScript. ::: +:::warning +This configuration is not considered "stable" under Semantic Versioning (semver). +Its enabled rules and/or their options may change outside of major version updates. +::: + ### `strict-type-checked` Contains all of `recommended`, `recommended-type-checked`, and `strict`, along with additional strict rules that require type information. @@ -215,10 +220,15 @@ module.exports = { Some rules also enabled in `recommended-type-checked` default to more strict settings in this configuration. 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. -:::caution +:::tip 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. ::: +:::warning +This configuration is not considered "stable" under Semantic Versioning (semver). +Its enabled rules and/or their options may change outside of major version updates. +::: + ### `stylistic` 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 Many rules conflict with each other and/or are intended to be configured per-project. ::: +:::warning +This configuration is not considered "stable" under Semantic Versioning (semver). +Its enabled rules and/or their options may change outside of major version updates. +::: + ### `base` A minimal ruleset that sets only the required parser and plugin options needed to run typescript-eslint. @@ -366,6 +381,11 @@ module.exports = { </TabItem> </Tabs> +:::warning +This configuration is not considered "stable" under Semantic Versioning (semver). +Its enabled rules and/or their options may change outside of major version updates. +::: + ### `eslint-recommended` This ruleset is meant to be used after extending `eslint:recommended`. @@ -427,6 +447,11 @@ module.exports = { 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. +:::warning +This configuration is not considered "stable" under Semantic Versioning (semver). +Its enabled rules and/or their options may change outside of major version updates. +::: + ### `stylistic-type-checked-only` A version of `stylistic` that _only_ contains type-checked rules and disables of any corresponding core ESLint rules.