版本

no-extra-parens

禁止不必要的括号

🔧 可修复

此规则报告的一些问题可以通过 --fix 命令行 选项自动修复。

此规则在 ESLint v8.53.0 中已 **弃用**。请在 @stylistic/eslint-plugin-js 中使用相应的规则。

此规则限制仅在必要时才使用括号。

规则详情

此规则始终忽略以下内容周围的多余括号

  • 正则表达式字面量,例如 (/abc/).test(var),以避免与 wrap-regex 规则冲突。
  • 立即调用函数表达式(也称为 IIFE),例如 var x = (function () {})();var x = (function () {}());,以避免与 wrap-iife 规则冲突。
  • 箭头函数参数,以避免与 arrow-parens 规则冲突。

此规则报告的问题可以自动修复,除非移除括号会创建新的指令,因为这可能会更改代码的语义。例如,以下脚本将 object 打印到控制台,但如果移除 "use strict" 周围的括号,则会改为打印 undefined

<!--
// this is a script
// -->

("use strict");

function test() {
    console.log(typeof this);
}

test();

在这种情况下,规则不会尝试移除 "use strict" 周围的括号,但仍会将其报告为问题。

选项

此规则有一个字符串选项

  • "all"(默认)禁止围绕任何表达式的多余括号。
  • "functions" 仅禁止围绕函数表达式的多余括号。

此规则有一个对象选项,用于 "all" 选项的例外情况。

  • "conditionalAssign": false 允许在条件测试表达式中的赋值周围使用多余的括号。
  • "returnAssign": false 允许在 return 语句中的赋值周围使用多余的括号。
  • "nestedBinaryExpressions": false 允许在嵌套的二元表达式中使用多余的括号。
  • "ternaryOperandBinaryExpressions": false 允许围绕作为三元 ?: 操作数的二元表达式的多余括号。
  • "ignoreJSX": "none|all|multi-line|single-line" 允许围绕无/所有/多行/单行 JSX 组件的多余括号。默认为 none
  • "enforceForArrowConditionals": false 允许围绕作为箭头函数体的三元表达式的多余括号。
  • "enforceForSequenceExpressions": false 允许围绕序列表达式的多余括号。
  • "enforceForNewInMemberExpressions": false 允许围绕成员表达式中的 new 表达式的多余括号。
  • "enforceForFunctionPrototypeMethods": false 允许围绕函数表达式上的立即 .call.apply 方法调用以及同一上下文中的函数表达式周围的多余括号。
  • "allowParensAfterCommentPattern": "any-string-pattern" 允许在由与正则表达式匹配的注释前置的多余括号。

all

此规则使用默认 "all" 选项的错误代码示例

在在线运行中打开
/* eslint no-extra-parens: "error" */

a = (b * c);

(a * b) + c;

for (a in (b, c));

for (a in (b));

for (a of (b));

typeof (a);

(Object.prototype.toString.call());

class A {
    [(x)] = 1;
}

class B {
    x = (y + z);
}

此规则使用默认 "all" 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: "error" */

(0).toString();

({}.toString.call());

(function(){}) ? a() : b();

(/^a$/).test(x);

for (a of (b, c));

for (a of b);

for (a in b, c);

for (a in b);

class A {
    [x] = 1;
}

class B {
    x = y + z;
}

conditionalAssign

此规则使用 "all"{ "conditionalAssign": false } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { "conditionalAssign": false }] */

while ((foo = bar())) {}

if ((foo = bar())) {}

do; while ((foo = bar()))

for (;(a = b););

returnAssign

此规则使用 "all"{ "returnAssign": false } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { "returnAssign": false }] */

function a1(b) {
  return (b = 1);
}

function a2(b) {
  return b ? (c = d) : (c = e);
}

b => (b = 1);

b => b ? (c = d) : (c = e);

nestedBinaryExpressions

此规则使用 "all"{ "nestedBinaryExpressions": false } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { "nestedBinaryExpressions": false }] */

x = a || (b && c);
x = a + (b * c);
x = (a * b) / c;

ternaryOperandBinaryExpressions

此规则使用 "all"{ "ternaryOperandBinaryExpressions": false } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { "ternaryOperandBinaryExpressions": false }] */

(a && b) ? foo : bar;

(a - b > a) ? foo : bar;

foo ? (bar || baz) : qux;

foo ? bar : (baz || qux);

ignoreJSX

此规则使用 all{ "ignoreJSX": "all" } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { ignoreJSX: "all" }] */
const ThisComponent = (<div />)
const ThatComponent = (
    <div
        prop={true}
    />
)

此规则使用 all{ "ignoreJSX": "multi-line" } 选项的错误代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { ignoreJSX: "multi-line" }] */
const ThisComponent = (<div />)
const ThatComponent = (<div><p /></div>)

此规则使用 all{ "ignoreJSX": "multi-line" } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { ignoreJSX: "multi-line" }] */
const ThisComponent = (
    <div>
        <p />
    </div>
)
const ThatComponent = (
    <div
        prop={true}
    />
)

此规则使用 all{ "ignoreJSX": "single-line" } 选项的错误代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { ignoreJSX: "single-line" }] */
const ThisComponent = (
    <div>
        <p />
    </div>
)
const ThatComponent = (
    <div
        prop={true}
    />
)

此规则使用 all{ "ignoreJSX": "single-line" } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { ignoreJSX: "single-line" }] */
const ThisComponent = (<div />)
const ThatComponent = (<div><p /></div>)

enforceForArrowConditionals

此规则使用 "all"{ "enforceForArrowConditionals": false } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { "enforceForArrowConditionals": false }] */

const b = a => 1 ? 2 : 3;
const d = c => (1 ? 2 : 3);

enforceForSequenceExpressions

此规则使用 "all"{ "enforceForSequenceExpressions": false } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { "enforceForSequenceExpressions": false }] */

(a, b);

if ((val = foo(), val < 10)) {}

while ((val = foo(), val < 10));

enforceForNewInMemberExpressions

此规则使用 "all"{ "enforceForNewInMemberExpressions": false } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { "enforceForNewInMemberExpressions": false }] */

const foo = (new Bar()).baz;

const quux = (new Bar())[baz];

(new Bar()).doSomething();

enforceForFunctionPrototypeMethods

此规则使用 "all"{ "enforceForFunctionPrototypeMethods": false } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { "enforceForFunctionPrototypeMethods": false }] */

const foo = (function () {}).call();

const bar = (function () {}).apply();

const baz = (function () {}.call());

const quux = (function () {}.apply());

allowParensAfterCommentPattern

要使此规则允许由特定注释前置的多余括号,请将此选项设置为将传递给 RegExp 构造函数 的字符串模式。

此规则使用 "all"{ "allowParensAfterCommentPattern": "@type" } 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "all", { "allowParensAfterCommentPattern": "@type" }] */

const span = /**@type {HTMLSpanElement}*/(event.currentTarget);

if (/** @type {Foo | Bar} */(options).baz) console.log('Lint free');

foo(/** @type {Bar} */ (bar), options, {
    name: "name",
    path: "path",
});

if (foo) {
    /** @type {Bar} */
    (bar).prop = false;
}

functions

此规则使用 "functions" 选项的错误代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "functions"] */

((function foo() {}))();

var y = (function () {return 1;});

此规则使用 "functions" 选项的正确代码示例

在在线运行中打开
/* eslint no-extra-parens: ["error", "functions"] */

(0).toString();

(Object.prototype.toString.call());

({}.toString.call());

(function(){} ? a() : b());

(/^a$/).test(x);

a = (b * c);

(a * b) + c;

typeof (a);

版本

此规则在 ESLint v0.1.4 中引入。

进一步阅读

资源

更改语言