Skip to content

docs: mention non-semver guarantees in Shared Configs docs #9257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 5, 2024
Merged

docs: mention non-semver guarantees in Shared Configs docs #9257

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3c3038
docs: mention non-semver guarantees in Shared Configs docs
JoshuaKGoldberg Jun 4, 2024
cf3861e
Switch to warnings
JoshuaKGoldberg Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions docs/users/Shared_Configurations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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`.
Expand Down Expand Up @@ -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.
Expand Down