Skip to content

docs: add Rule Deprecations page #6156

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
Dec 7, 2022
Merged

docs: add Rule Deprecations page #6156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
501f70b
docs: add Rule Deprecations page
JoshuaKGoldberg Dec 2, 2022
3208dd3
Update docs/maintenance/issues/Rule_Deprecations.md
JoshuaKGoldberg Dec 7, 2022
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
1 change: 0 additions & 1 deletion docs/maintenance/ISSUES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
id: issues
sidebar_label: Issues
title: Issues
---

Expand Down
34 changes: 34 additions & 0 deletions docs/maintenance/issues/Rule_Deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: rule-deprecations
title: Rule Deprecations
---

Sometimes a rule that used to be 👍 does not age well and becomes 👎.
In the past, these cases have included:

- Overly opinionated and/or stylistic rules that don't represent a universal best practice
- Renames
- Rules moved to an external plugin

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).

Provide it an `## Overview` containing:

- The rule name & link to its documentation page
- A clear explanation of why you believe it should be deprecated
- 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

> See [#6036](https://github.com/typescript-eslint/typescript-eslint/issues/6036) for examples of those links and queries.

## Timeline

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`](https://typescript-eslint.io/rules/camelcase/) as an example)
11 changes: 10 additions & 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 @@ -67,7 +67,16 @@ module.exports = {
},
{
items: [
'maintenance/issues',
{
collapsible: false,
items: ['maintenance/issues/rule-deprecations'],
label: 'Issues',
link: {
id: 'maintenance/issues',
type: 'doc',
},
type: 'category',
},
'maintenance/pull-requests',
'maintenance/releases',
'maintenance/versioning',
Expand Down