使用 ESLint 限制某些语法-js教程-PHP中文网

ESlint 是一个很棒的工具，可以使我们的代码更加一致，并为我们的团队节省大量时间。有大量的插件可以处理大多数通用用例，但有时我们有一些特定的需求，创建自己的规则会花费太多时间。

对于最简单的情况，当我们只想禁止使用某个函数（或实际上的其他任何内容）时，我们可以利用默认规则：no-restricted-syntax。

理解抽象语法树 (AST)

在编写第一个选择器之前，我们需要了解底层系统。 AST 只是以嵌套对象（因此 AST 中的“树”）形式表示的程序，由“解析器”创建。它非常灵活，因为它可以轻松读取、查询和操作。另一种方法是使用正则表达式，但这会很难读写。所以这基本上是一个中间步骤，通过理解我们的代码，IDE 可以完成所有伟大的事情。

要了解它的工作原理，我们可以使用 AST Explorer，这是一个方便的工具，可以并行显示一些代码及其 AST，您可以将鼠标悬停或单击代码的任何部分以突出显示其相应的 AST 部分:

Restricting some syntax with ESLint

⚠️ 更改语言时请注意正确选择解析器。

例如，在编写 Vue 代码时，请务必在我们的例子中使用 vue-eslint-parser，因为我们要编写一个 ESlint 选择器。您还可以检查 @vue/compiler-dom 输出的内容，但您无法使用 ESlint 规则查询结果树。

创建选择器

我们需要的第二个有用工具是 ESLint 选择器文档。它列出了我们可以用来查询 AST 的表达式，如果您习惯使用 CSS，它可能会感觉很熟悉。它基于相同的“级联”行为，具有后代、兄弟、节点和属性过滤等匹配器。以下是文档中的一些示例：

AST 节点类型：ForStatement
属性值：[attr="foo"]
嵌套属性：[attr.level2="foo"]
字段：函数声明>标识符.id

所以，给出这段代码：

const time = dayjs();

登录后复制

它将使用 @typescript-eslint/parser 生成以下 AST：

Program {
  body: [
    VariableDeclaration {
      declarations: [
        VariableDeclarator {
          id: Identifier
          init: CallExpression {
            callee: Identifier {
              name: "dayjs"
            }
            arguments: []
            optional: false
          }
        }
      ]
      kind: "const"
    }
  ]
  sourceType: "module"
}

登录后复制

在我们的例子中，我们需要匹配一个名为dayjs（带有name属性的标识符）的函数调用（CallExpression）。我们还需要直接后代选择器 >确保我们不匹配任何嵌套有 dayjs 标识符的函数调用。所以选择器将是 CallExpression >标识符[name="dayjs"].

示例

简单的功能选择器

这是我们的选择器，用于防止在没有 UTC 的情况下使用 dayjs，您可以在 ESLint Playground 中尝试：

const time = dayjs();

登录后复制

Program {
  body: [
    VariableDeclaration {
      declarations: [
        VariableDeclarator {
          id: Identifier
          init: CallExpression {
            callee: Identifier {
              name: "dayjs"
            }
            arguments: []
            optional: false
          }
        }
      ]
      kind: "const"
    }
  ]
  sourceType: "module"
}

登录后复制

Vue 模板内部

这是另一个示例，禁止在 Vue 模板中以（相当 hacky）的方式在模板中设置局部变量（请注意，该规则以 vue/ 为前缀，因为它需要 eslint-plugin-vue 包）：

'no-restricted-syntax': [
  'error',
  {
    selector: 'CallExpression > Identifier[name="dayjs"]',
    message: 'Always use dayjs.utc() instead of dayjs() to avoid timezone issues',
  },
]

登录后复制

const foo = dayjs();
//          ^^^^^ Invalid
const bar = dayjs.utc();

登录后复制

顺便说一下，您可以在这里阅读更多关于这个奇怪的技巧的信息，它在过去给我们带来了一些反应性问题，所以我们决定完全禁止它。

使用正则表达式

这是最后一个例子，我们遇到了需要禁止使用一组特定翻译的情况，因此我们必须找到第一个参数以导出开头的 t （或任何变体）函数。 :

'vue/no-restricted-syntax': [
  'error',
  {
    selector: 'VAttribute > VExpressionContainer > AssignmentExpression',
    message: 'Do not assign values in templates as it will not be reactive',
  },
],

登录后复制

<template>
  <div :set="(foo = 'bar')">{{ foo }}</div>
  <!-- Outputs <div>bar</div> -->
  <!--       ^^^^^^^^^^ Invalid -->
</template>

登录后复制

结论

如果您很难找到正确的选择器，您可以向 ChatGPT 寻求帮助！它也很擅长解释选择器：

Restricting some syntax with ESLint

此外，如果您只需要限制进口，使用 no-restricted-imports 规则会更简单：

'no-restricted-syntax': [
  'error',
  {
    selector: 'CallExpression[callee.name=/^(t|tc|tf|te|d|n)$/][arguments.0.value=/^exports./]',
    message: 'Do not assign values in templates as it will not be reactive',
  },
],

登录后复制

这个解决方案在最简单的情况下效果很好，但它不会让你提出自动修复。为了获得更完整的解决方案，应创建自定义规则。

感谢这些规则，我们不会重复同样的错误两次，从而节省了时间！

以上是使用 ESLint 限制某些语法的详细内容。更多信息请关注PHP中文网其他相关文章！