Rome useTemplate 规则详解用模板字符串替代字符串拼接的检测与自动修复【免费下载链接】toolsUnified developer tools for JavaScript, TypeScript, and the web项目地址: https://gitcode.com/gh_mirrors/to/toolsRome当前仓库tools内置的useTemplate代码风格 lint 规则用于检测 JavaScript/TypeScript 代码中不必要的字符串拼接并推荐使用 ES6 模板字符串Template Literal取而代之。本文以该规则为核心完整讲解其触发条件、诊断输出格式、自动修复行为与底层实现原理并结合仓库源码与测试用例帮助你准确理解该规则的使用边界在项目中放心地开启它。规则概览规则名称useTemplate所属分类lint/style/useTemplate引入版本v0.7.0见 use_template.rs 中declare_rule!声明的version: 0.7.0推荐程度recommendedRome 官方推荐启用修复能力可自动修复FIXABLE修复类别为 QuickFix适用性标记为MaybeIncorrect规则的核心主张只有一句话Template literals are preferred over string concatenation——优先使用模板字符串而不是运算符做字符串拼接。这是rome_js_analyze分析器在 style 分类下众多规则之一注册入口见 analyzers/style.rs。触发条件什么代码会被判定为不合规从源码实现use_template.rs 的is_unnecessary_string_concat_expression函数可以归纳出该规则的判定逻辑只检查运算符JsBinaryOperator::Plus的二元表达式其他运算符直接跳过只要表达式左侧或右侧满足以下任一条件即判定为不必要的字符串拼接操作数是字符串字面量且该字符串不含换行符或反引号操作数是模板字符串操作数是另一个被判定为不必要的字符串拼接的表达式递归检查。关键边界两个字符串字面量相加foo bar属于合法写法不会触发规则包含换行符或反引号的字符串也不会被标记因为这类字符串无法无痛地转换为模板字符串见has_new_line_or_tick检查。Invalid会触发诊断的代码以下来自官方文档的示例全部会命中规则console.log(foo baz); console.log(1 * 2 foo); console.log(1 foo 2 bar baz 3); console.log((1 foo) * 2); console.log(foo 1);测试快照 invalid.jsonc 中还有更多覆盖包括const foo bar; console.log(foo bar${baz${bat bam}} boo); // 嵌套模板字符串参与拼接 console.log(foo 1 2); // 数字与字符串混合拼接 foo() bar; // 函数调用结果与字符串拼接 console.log(${foo. bar .baz}); // 字符串中本就有 ${ 占位符值得注意的是即便字符串内部已经包含${、等模板字符串特殊字符例如${foo. bar .baz}规则依然会触发并在修复时对$、等字符进行转义保证修复结果语义不变。Valid不会触发诊断的代码console.log(foo bar); // 两个纯字符串字面量拼接不触发 console.log(foo() \n); // 字符串含换行符不触发对应测试文件 valid.jsonc。诊断输出与自动修复当规则命中时Rome CLI 会输出带FIXABLE标记的详细诊断信息并附上 Suggested fix。以console.log(foo baz)为例官方文档展示了完整输出style/useTemplate.js:1:13 lint/style/useTemplate FIXABLE ✖ Template literals are preferred over string concatenation. 1 │ console.log(foo baz); │ ^^^^^^^^^^^ ℹ Suggested fix: Use a TemplateLiteral. 1 │ console.log(-${foo}baz-); │ console.log(${foo}baz);诊断消息中的核心文案Template literals are preferred over string concatenation.由源码 use_template.rs 中的diagnostic方法生成使用markup!宏强调关键字修复建议Use a TemplateLiteral.则来自action方法同文件 L112-L128。修复示例对照原始代码修复后代码console.log(foo baz)console.log(${foo}baz)console.log(1 * 2 foo)console.log(${1 * 2}foo)console.log(1 foo 2 bar baz 3)console.log(${1}foo${2}bar${3})console.log((1 foo) * 2)console.log((${1}foo) * 2)console.log(foo 1)console.log(foo${1})注意最后一个修复(1 foo) * 2中表达式位于乘法表达式内部修复时只替换被命中的子表达式外层括号与乘法保持不变——说明修复是基于 AST 节点的精准替换不会破坏外层运算语义。底层实现原理从 AST 匹配到模板字符串生成该规则基于rome_js_analyze的规则框架实现通过declare_rule!宏声明主要逻辑分四步use_template.rs1. 查询与筛选run规则的查询类型是AstJsBinaryExpression即每个二元表达式节点都会进入该规则。run方法先调用is_unnecessary_string_concat_expression判断是否为不必要的字符串拼接再调用collect_binary_add_expression把形如1 2 3 (1 * 2)的连续链递归摊平成[1, 2, 3, (1 * 2)]的表达式列表见 collect_binary_add_expression。最后还有一个重要过滤摊平后的列表中必须至少有一个非纯字符串字面量的表达式才报错——这正是foo bar不触发规则的原因。2. 抑制逻辑suppressed_nodes规则遍历查询节点的整棵子树遇到JS_BINARY_EXPRESSION节点就将其标记为可抑制其余子树直接跳过从而保证// rome-ignore等抑制注释能覆盖到所有相关子表达式。3. 诊断生成diagnostic对命中的表达式生成规则诊断消息统一为Template literals are preferred over string concatenation.并标记为可修复FIXABLE。4. 修复动作actionaction是自动修复的核心通过 convert_expressions_to_js_template 把摊平后的表达式列表合并成一个模板字符串字符串字面量→ 去掉引号后作为模板字符串的纯文本块chunk其中${和会被转义为\${、避免破坏模板语义已有的模板字符串→ 通过flatten_template_element_list递归展开嵌套模板如${1 2 ${a}test}bar会被展开为[1, 2, a, test, bar]见 flatten_template_element_list并入外层模板其他表达式→ 作为${expr}插值元素放入模板并去除表达式两侧多余空格让生成的模板更整洁源码注释举例若不 trim1 * (2 foo) bar会生成${1 * (2 foo) }bar这种带多余空格的丑陋结果。最终通过make::js_template_expression构造出...节点用mutation.replace_node替换原二元表达式节点。修复类别为ActionCategory::QuickFix适用性为Applicability::MaybeIncorrect——意味着工具无法 100% 保证修复结果正确建议结合代码评审使用。在项目中启用与使用由于该规则是recommended规则使用 Rome 默认配置rome.json时即会自动启用。如需显式配置可在rome.json的 linter 配置中调整{ linter: { enabled: true, rules: { style: { useTemplate: error // 或 warn、off } } } }规则禁用方法如行内// rome-ignore lint/style/useTemplate: reason与规则选项的完整说明可参考 linter 指南。运行检查与自动修复的命令以本地rome_cli为例# 仅检查输出诊断 cargo run -p rome_cli -- check path/to/file.js # 应用可用的自动修复 cargo run -p rome_cli -- check --apply path/to/file.js注意修复适用性标记为MaybeIncorrect使用--apply批量修复后建议运行测试确认行为无变化尤其是涉及${、、换行等特殊字符的拼接场景。测试覆盖快照驱动的规则质量保障useTemplate的测试采用 Rome 标准的 JSONC 快照测试体系测试框架见 spec_tests.rsinvalid.jsonc24 个不合规用例覆盖纯字符串拼接、混合类型拼接、嵌套模板、${与特殊字符转义、注释保留等边界场景valid.jsonc合规用例验证foo bar与含换行字符串不误报对应的 invalid.jsonc.snap / valid.jsonc.snap 快照文件锁定诊断输出与修复结果防止规则行为在后续迭代中发生无意的回归。总结useTemplate是 Rome 推荐启用的 style 类规则它精准识别字符串与表达式混拼的表达式并提供基于 AST 的自动修复把拼接改写为语义等价的模板字符串。理解它的触发边界两个字符串字面量拼接、含换行/反引号的字符串不触发与修复策略嵌套模板展平、特殊字符转义、表达式去空格有助于你在团队中安全地落地这条规则写出更一致、更可读的字符串构造代码。【免费下载链接】toolsUnified developer tools for JavaScript, TypeScript, and the web项目地址: https://gitcode.com/gh_mirrors/to/tools创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考