跳至主要内容

规则弃用、重命名和删除

有时,一条曾经 👍 的规则会随着时间的推移而变得 👎。过去,这些情况包括

  • 过于主观和/或风格化的规则,不代表普遍的最佳实践
  • 重命名
  • 规则移至外部插件

在这些情况下,我们的目标是在尽可能减少用户干扰的情况下删除旧规则。

提交问题

规则弃用和重命名可以作为 绕过模板的新问题 提交。

提供一个 ## Overview,其中包含

  • 规则名称及其文档页面的链接
  • 清楚地解释为什么你认为它应该被弃用和/或重命名
  • 它是否存在于流行的配置中,例如 eslint-config-airbnb-typescripteslint-config-standard-with-typescript
  • Sourcegraph 查询,显示它在用户配置中出现的频率

请参阅 #6036,了解这些链接和查询的示例。

时间线

  1. 在任何次要/补丁版本中,添加 规则 meta 属性
    • deprecated: true
    • replacedBy(如果适用)
  2. 搜索开放问题和 PR,并相应地更新其中的名称
    • 删除:使用指向问题和弃用 PR 的链接关闭它们
    • 重命名:更新它们的标题,并在评论中明确提及规则已重命名
  3. 在下一个主要版本中,您可以删除弃用的规则
    • 留下一个文档页面作为墓碑,指向新的相关规则或文档(例如,请参阅 camelcase)。