You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sometimes a rule that used to be 👍 does not age well and becomes 👎.
7
+
In the past, these cases have included:
8
+
9
+
- Overly opinionated and/or stylistic rules that don't represent a universal best practice
10
+
- Renames
11
+
- Rules moved to an external plugin
12
+
13
+
In these cases, we aim to remove the old rule with minimal user disruption.
14
+
15
+
## Filing the Issue
16
+
17
+
Rule deprecations can be filed as a [new issue bypassing templates](https://github.com/typescript-eslint/typescript-eslint/issues/new).
18
+
19
+
Provide it an `## Overview` containing:
20
+
21
+
- The rule name & link to its documentation page
22
+
- A clear explanation of why you believe it should be deprecated
23
+
- Whether it exists in popular configs such as `eslint-config-airbnb-typescript` and `eslint-config-standard-with-typescript`
24
+
- Sourcegraph queries showing how often it appears in user configs
25
+
26
+
> See [#6036](https://github.com/typescript-eslint/typescript-eslint/issues/6036) for examples of those links and queries.
27
+
28
+
## Timeline
29
+
30
+
1. In any minor/patch version, add [rule `meta` properties](https://eslint.org/docs/latest/developer-guide/working-with-rules#rule-basics):
31
+
-`deprecated: true`
32
+
-`replacedBy`, if applicable
33
+
2. In the next major version, you may delete the rule
34
+
- 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)
0 commit comments