Skip to content

Docs: Add maintenance guide for renaming a rule #8548

Closed
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Coming over from #8544 (comment): occasionally in the past we've felt a need to rename rules. For example, #5841 -> #5879.

This generally involves:

  1. Copying the old name rule to a new name
  2. Adding replacedBy to the meta of the old rule
  3. Later, removing the old rule as a breaking change

Let's add docs around this.

Affected URL(s)

https://typescript-eslint.io/maintenance/issues/rule-renames

Metadata

Metadata

Labels

documentationDocumentation ("docs") that needs adding/updatinglocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.team assignedA member of the typescript-eslint team should work on this.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions