# no-restricted-syntax

禁止指定的语法

JavaScript 有很多语言特性，并不是每个人都喜欢。因此，一些项目选择完全禁止使用某些语言特性。例如，您可能决定禁止使用 try-catch 或 class，或者您可能决定禁止使用 in 运算符。

此规则允许您配置要限制使用的语法元素，而不是为您要关闭的每个语言功能创建单独的规则。这些元素由它们的 ESTree 节点类型表示。例如，函数声明用 FunctionDeclaration 表示，with 语句用 WithStatement 表示。您可以找到 AST 节点名称的完整列表，您可以使用 在 GitHub 上 并将 AST Explorer 与 espree 解析器一起使用，以查看您的代码包含哪些类型的节点。

您还可以指定 AST 选择器 进行限制，从而更精确地控制语法模式。

# 规则详情

此规则不允许指定的（即用户定义的）语法。

# 选项

此规则接受一个字符串列表，其中每个字符串都是一个 AST 选择器：

{
    "rules": {
        "no-restricted-syntax": ["error", "FunctionExpression", "WithStatement", "BinaryExpression[operator='in']"]
    }
}

或者，该规则还接受对象，其中指定了选择器和可选的自定义消息：

{
    "rules": {
        "no-restricted-syntax": [
            "error",
            {
                "selector": "FunctionExpression",
                "message": "Function expressions are not allowed."
            },
            {
                "selector": "CallExpression[callee.name='setTimeout'][arguments.length!=2]",
                "message": "setTimeout must always be invoked with two arguments."
            }
        ]
    }
}

如果使用 message 属性指定了自定义消息，ESLint 将在报告出现 selector 属性中指定的语法时使用该消息。

字符串和对象格式可以根据需要在配置中自由混合。

此规则使用 "FunctionExpression", "WithStatement", BinaryExpression[operator='in'] 选项的错误代码示例：

/* eslint no-restricted-syntax: ["error", "FunctionExpression", "WithStatement", "BinaryExpression[operator='in']"] */

with (me) {
    dontMess();
}

var doSomething = function () {};

foo in bar;

此规则使用 "FunctionExpression", "WithStatement", BinaryExpression[operator='in'] 选项的正确代码示例：

/* eslint no-restricted-syntax: ["error", "FunctionExpression", "WithStatement", "BinaryExpression[operator='in']"] */

me.dontMess();

function doSomething() {};

foo instanceof bar;

# 何时不使用

如果您不想限制代码使用任何 JavaScript 功能或语法，则不应使用此规则。

← no-restricted-properties no-return-assign →