Skip to content

docs: expand rule deprecation docs to also include renames #9237

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 3 commits into from
Jun 4, 2024
Merged

docs: expand rule deprecation docs to also include renames #9237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9c9556
docs: expand rule deprecation docs to also include renames
JoshuaKGoldberg Jun 3, 2024
137eb40
Update docs/maintenance/issues/Rule_Deprecations_And_Deletions.mdx
JoshuaKGoldberg Jun 3, 2024
932404b
Merge branch 'main' into docs-rule-deprecations-and-deletions
Josh-Cena 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
15 changes: 9 additions & 6 deletions .../maintenance/issues/Rule_Deprecations.mdx → ...ssues/Rule_Deprecations_And_Deletions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: rule-deprecations
title: Rule Deprecations
id: rule-deprecations-and-deletions
title: Rule Deprecations, Renames, And Deletions
---

Sometimes a rule that used to be 👍 does not age well and becomes 👎.
Expand All @@ -14,12 +14,12 @@ In these cases, we aim to remove the old rule with minimal user disruption.

## Filing the Issue

Rule deprecations can be filed as a [new issue bypassing templates](https://github.com/typescript-eslint/typescript-eslint/issues/new).
Rule deprecations and renames can be filed as a [new issue bypassing templates](https://github.com/typescript-eslint/typescript-eslint/issues/new).

Provide it an `## Overview` containing:

- The rule name & link to its documentation page
- A clear explanation of why you believe it should be deprecated
- A clear explanation of why you believe it should be deprecated and/or renamed
- Whether it exists in popular configs such as `eslint-config-airbnb-typescript` and `eslint-config-standard-with-typescript`
- Sourcegraph queries showing how often it appears in user configs

Expand All @@ -30,5 +30,8 @@ Provide it an `## Overview` containing:
1. In any minor/patch version, add [rule `meta` properties](https://eslint.org/docs/latest/developer-guide/working-with-rules#rule-basics):
- `deprecated: true`
- `replacedBy`, if applicable
2. In the next major version, you may delete the rule
- If the rule is relatively popular with users, consider leaving a documentation page as a tombstone pointing to the new relevant rule or docs (see [`camelcase`](/rules/camelcase/) as an example)
2. Search through open issues and PRs, and update the name in them accordingly:
- Deletions: close them with a link to the issue and deprecation PR
- Renames: update their title and explicitly mention in a comment that the rule has been renamed
3. In the next major version, you may delete the deprecated rule
- Leave a documentation page as a tombstone pointing to the new relevant rule or docs (see [`camelcase`](/rules/camelcase) as an example)
4 changes: 4 additions & 0 deletions packages/website/docusaurus.config.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,10 @@ const redirects: PluginRedirectOptions = {
from: '/linting/typed-linting/monorepos',
to: '/getting-started/typed-linting/monorepos',
},
{
from: '/maintenance/issues/rule-deprecations',
to: '/maintenance/issues/rule-deprecations-and-deletions',
},
],
};

Expand Down
2 changes: 1 addition & 1 deletion packages/website/sidebars/sidebar.base.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ module.exports = {
'maintenance/contributor-tiers',
{
collapsible: true,
items: ['maintenance/issues/rule-deprecations'],
items: ['maintenance/issues/rule-deprecations-and-deletions'],
label: 'Issues',
link: {
id: 'maintenance/issues',
Expand Down
Loading