From a3c3038c9f08e6517401d368c55cf6d26d591278 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Tue, 4 Jun 2024 10:11:13 -0400 Subject: [PATCH 1/2] docs: mention non-semver guarantees in Shared Configs docs --- docs/users/Shared_Configurations.mdx | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/users/Shared_Configurations.mdx b/docs/users/Shared_Configurations.mdx index c9a1325a8dc6..86102ed05555 100644 --- a/docs/users/Shared_Configurations.mdx +++ b/docs/users/Shared_Configurations.mdx @@ -188,6 +188,11 @@ See [`configs/strict.ts`](https://github.com/typescript-eslint/typescript-eslint We recommend a TypeScript project extend from `plugin:@typescript-eslint/strict` only if a nontrivial percentage of its developers are highly proficient in TypeScript. ::: +:::note +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. @@ -219,6 +224,11 @@ See [`configs/strict-type-checked.ts`](https://github.com/typescript-eslint/type 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. ::: +:::note +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. ::: +:::note +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 = { +:::note +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. +:::note +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. From cf3861e052a5652330c3c038ec58068e53b42d04 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Tue, 4 Jun 2024 13:32:08 -0400 Subject: [PATCH 2/2] Switch to warnings --- docs/users/Shared_Configurations.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/users/Shared_Configurations.mdx b/docs/users/Shared_Configurations.mdx index 86102ed05555..59c7e26cb66d 100644 --- a/docs/users/Shared_Configurations.mdx +++ b/docs/users/Shared_Configurations.mdx @@ -184,11 +184,11 @@ 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. ::: -:::note +:::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. ::: @@ -220,11 +220,11 @@ 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. ::: -:::note +:::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. ::: @@ -303,7 +303,7 @@ 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. ::: -:::note +:::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. ::: @@ -381,7 +381,7 @@ module.exports = { -:::note +:::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. ::: @@ -447,7 +447,7 @@ 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. -:::note +:::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. :::