Rome Lint 规则 noDoubleEquals强制使用 与 ! 的 Lint 规则及自动修复实现【免费下载链接】toolsUnified developer tools for JavaScript, TypeScript, and the web项目地址: https://gitcode.com/gh_mirrors/to/tools本文以 Rome 官方文档中的noDoubleEquals规则说明为主体系统讲解该规则的设计动机、检测语义、 null例外、诊断输出格式与 Quick Fix 自动修复机制并结合 Rome 仓库中该规则的真实源码与测试用例说明它如何在JsBinaryExpression上触发诊断、如何生成修复补丁以及如何在 rome.json 中配置或在代码中抑制该规则。规则定位v0.7.0 引入的推荐规则noDoubleEquals是 Rome Linter 中suspicious可疑代码分组下的一条规则自v0.7.0引入并被 Rome 标记为推荐规则recommended。规则文档见 noDoubleEquals.md规则源码位于 no_double_equals.rs。文档给出的核心要求是Require the use ofand!要求使用和!设计动机在于用代替进行比较通常是不好的实践。双等号运算符会触发隐式的类型强制转换type coercion——例如1 1为true、[] false为true——这类行为依赖语言规范中繁琐的抽象相等比较算法容易写出难以推理的代码。因此使用严格相等运算符/!几乎总是最佳实践。从 declare_rule 宏声明可以确认规则的元信息pub(crate) NoDoubleEquals { version: 0.7.0, name: noDoubleEquals, recommended: true, }该规则被注册进suspicious分组见 suspicious.rs 中的self::no_double_equals::NoDoubleEquals因此它的完整诊断 ID 为lint/suspicious/noDoubleEquals。检测语义哪些/!会被报告规则的检测范围是二元表达式JsBinaryExpression当运算符是或!且比较的两侧都不是null字面量时就会报告诊断。文档给出的示例与源码行为完全一致无效示例会被报告foo bar运行rome lint后输出suspicious/noDoubleEquals.js:1:5 lint/suspicious/noDoubleEquals FIXABLE ! Use instead of 1 │ foo bar │ ^^ i is only allowed when comparing against null i Using may be unsafe if you are relying on type coercion i Suggested fix: Use 1 │ foo··bar │ 诊断包含四层信息主消息Useinstead of、detail只允许用于与null比较、note如果依赖类型转换改用可能不安全以及建议修复。有效示例例外与null比较出于易用性考虑该规则对 null做了专门豁免——因为x null同时匹配null和undefined是 JavaScript 社区公认的空值检查惯用法。以下写法均合法foo null foo ! null null foo null ! foo这一豁免在源码中体现为 run 函数对左右操作数的检查fn run(ctx: RuleContextSelf) - OptionSelf::State { let n ctx.query(); let op n.operator_token().ok()?; // 只关心 和 ! 两种运算符 if !matches!(op.kind(), EQ2 | NEQ) { return None; } // 左侧或右侧是 null 字面量则放行 if is_null_literal(n.left()) || is_null_literal(n.right()) { return None; } Some(op) }其中 is_null_literal 精确匹配 AST 中的JsNullLiteralExpression所以只有null这一个字面量触发豁免undefined或其他常量不在此列。同时注意运算符判断同时覆盖了EQ2和!NEQ即foo ! bar同样会被要求写成foo ! bar。另外该规则没有可配置选项规则实现中type Options ();见 no_double_equals.rs 中type Options ();一处意味着它只有开或关两种状态行为完全由上述语义决定。诊断的生成细节diagnostic方法根据运算符种类动态生成提示文案提示改用!提示改用!并将诊断锚定在运算符 token 的精确范围上op.text_trimmed_range()这就是输出中^^只下划线覆盖两个字符的原因。完整实现见 diagnostic 函数fn diagnostic(_ctx: RuleContextSelf, op: Self::State) - OptionRuleDiagnostic { let text_trimmed op.text_trimmed(); let suggestion if op.kind() EQ2 { } else { ! }; // ... Some(RuleDiagnostic::new( rule_category!(), op.text_trimmed_range(), markup! { Use Emphasis{suggestion}/Emphasis instead of Emphasis{text_trimmed}/Emphasis }, ) .detail(...) // is only allowed when comparing against null .note(...) // Using may be unsafe if you are relying on type coercion .description(description)) }Quick Fix单字符替换式自动修复诊断头部的FIXABLE标记来自规则的action方法。它通过 Rome 的语法树批量变异BatchMutation把运算符 token原地替换为三字符运算符fn action(ctx: RuleContextSelf, op: Self::State) - OptionJsRuleAction { let mut mutation ctx.root().begin(); let suggestion if op.kind() EQ2 { T![] } else { T![!] }; mutation.replace_token(op.clone(), make::token(suggestion)); Some(JsRuleAction { category: ActionCategory::QuickFix, applicability: Applicability::MaybeIncorrect, message: markup! { Use Emphasis{suggestion.to_string().unwrap()}/Emphasis }.to_owned(), mutation, }) }见 action 函数。两个实现细节值得注意修复方式极简不是重写表达式而是把token 换成token只增加一个字符因此在模板字符串、if条件等任何上下文都安全适用性级别为MaybeIncorrect因为诊断中已经提示“如果代码依赖类型转换改用可能不安全”所以自动修复被标记为“可能不正确”由用户自行决定是否应用而非无条件安全的修复。测试用例对检测边界的覆盖仓库中的规格测试 invalid.js 覆盖了 5 种典型场景对应快照 invalid.js.snapconst foo text ${a b} // 模板字符串插值中的 ; // existing comment a b; // 独立表达式语句 if (a b) { // if 条件中的 false; } if (/** some weird comment **/ a b) { // 操作符前有注释的边界情况 } let a Output of rome rage: formatter enabled: ${formatter true} // 与布尔字面量比较 linter: ${linter} ;5 处全部被报告为FIXABLE诊断包括注释紧邻运算符、模板字符串内部等容易影响列号计算的位置。有效用例 valid.jsonc 则确认了a null与a ! null不产生任何诊断。此外JSONC 用例 invalid.jsonc 还专门覆盖了a 0/a ! 0这类容易被误判为“空值检查”的场景——它们不属于null豁免会被正常报告。实战使用检查、修复与抑制运行规则noDoubleEquals是推荐规则默认随rome lint/rome check生效无需在配置中显式开启npx rome lint ./your_project命中违规时编辑器如 VS Code 扩展或 LSP与 CLI 均会展示上文所述的诊断并可通过 Quick Fix 一键应用替换。关闭规则或逐行豁免规则文档末尾的两个相关链接Disable a rule 与 Rule options指向 Linter 配置章节说明了两条标准路径配置级关闭在项目根目录的rome.json中通过linter.rules将该规则设为off即可对整个项目禁用noDoubleEquals行级抑制对确实依赖类型转换的个别比较可以插入rome-ignore注释抑制单条诊断。抑制功能有专门的测试验证见 noDoubleEquals.js.snap其中展示了自动修复会把代码改写为带抑制注释的形式// rome-ignore lint/suspicious/noDoubleEquals: explanation a b;注释后必须跟一句解释explanation这是 Rome 抑制注释的约定格式。小结noDoubleEquals虽然只针对两个运算符但它完整展示了 Rome 一条 Lint 规则的全貌declare_rule!声明元信息版本、名称、推荐级别→run在JsBinaryExpressionAST 上精确匹配/!并豁免null比较 →diagnostic锚定运算符范围生成多层级提示 →action以单 token 替换提供MaybeIncorrect级别的 Quick Fix。理解这条规则的实现路径no_double_equals.rs后再阅读suspicious分组下的其他规则时模式是相通的。【免费下载链接】toolsUnified developer tools for JavaScript, TypeScript, and the web项目地址: https://gitcode.com/gh_mirrors/to/tools创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考