ESLint 项目中关于冻结规则的文档改进说明

在 JavaScript 代码质量检查工具 ESLint 的规则文档中，对于"冻结规则"的描述存在不够清晰的问题。本文将详细介绍这一改进的背景、讨论过程和最终解决方案。

背景

ESLint 中的某些规则被标记为"冻结状态"，当前文档中的描述是"该规则目前处于冻结状态，不接受任何更改"。这种表述容易让开发者产生误解，认为包括错误修复和文档更新在内的所有修改都不会被接受。

实际上，冻结规则的真实含义是：

• 不再接受新功能或选项的添加
• 但仍会接受针对现有功能的错误修复
• 文档改进建议仍然会被考虑

问题分析

这种表述不清可能导致以下问题：

1. 开发者可能不会提交合理的错误修复
2. 文档改进建议可能被错误地忽略
3. 与"已废弃规则"的区分度不够明显

解决方案讨论

项目维护者经过讨论后，决定采用更精确的表述方式。最终确定的改进方案是修改冻结规则的描述文本，使其更准确地反映实际情况。

新的描述将明确区分：

• 不接受新功能请求
• 但仍欢迎错误修复和文档改进

实施细节

具体实现上，将把原来的描述： "该规则目前处于冻结状态，不接受任何更改"

修改为： "该规则目前处于冻结状态，不接受功能请求"

这种修改既保持了简洁性，又更准确地传达了冻结状态的真实含义，避免了开发者的误解。

意义与影响

这一文档改进将带来以下好处：

1. 提高开发者对规则状态的理解
2. 鼓励开发者继续提交有价值的错误修复
3. 保持文档的持续改进
4. 明确区分冻结规则与废弃规则的不同处理方式

对于使用 ESLint 的开发者来说，了解这一改进有助于更准确地理解规则状态，并在适当的情况下继续为冻结规则贡献改进。