自定义ESLint规则运行时能否替换模板字符串${}变量为实际值？

核心结论 #

直接在ESLint规则运行时将${variable}替换为变量的实际值不可行，因为ESLint是静态代码分析工具，只处理代码的语法结构，不执行代码，无法获取变量在运行时的实际值。

可行替代方案 #

• 追踪变量的静态定义：
  通过ESLint的AST遍历能力，追踪变量的声明和赋值：
  • 当遇到模板字符串中的变量占位符时，通过scope对象找到该变量的定义节点
  • 分析变量的赋值内容（比如变量是字符串字面量、静态模板字符串等），提取其中的静态部分
  • 示例逻辑：

    // 在规则的遍历函数中
    function TemplateLiteral(node) {
      node.expressions.forEach(expr => {
        if (expr.type === 'Identifier') {
          const variable = context.getScope().variables.find(v => v.name === expr.name);
          if (variable && variable.defs.length) {
            const defNode = variable.defs[0].node;
            // 处理变量赋值为字符串字面量的情况
            if (defNode.type === 'VariableDeclarator' && defNode.init?.type === 'Literal') {
              const variableValue = defNode.init.value;
              // 这里可拿到变量的静态值，用于后续检查
              console.log(variableValue);
            }
          }
        }
      });
    }
    

• 限制变量的使用场景：
  如果场景允许，可约定变量只能是静态字符串或符合特定格式的表达式，降低分析复杂度，避免匹配偏差。
• 结合代码重构与计数：
  按你之前的思路，通过代码重构统一变量使用方式，配合计数逻辑覆盖大部分场景，比如统计模板字符串中变量占位符和对应变量内部关键字的出现次数，做一致性校验。

注意事项 #

• 对于动态生成的变量值（比如函数返回、运行时计算的值），ESLint无法获取实际内容，这类场景只能通过约定或其他工具处理
• 复杂的变量赋值链（比如变量赋值给另一个变量再被模板引用）需要递归遍历AST追踪，实现成本较高

内容的提问来源于stack exchange，提问作者kwdrt