跳至内容

@stylistic/

rest-spread-spacing

ES2015 引入了剩余和展开运算符,它们将可迭代结构扩展为其各个部分。以下是一些使用示例

js
let numArr = [1, 2, 3];
function add(a, b, c) {
    return a + b + c;
}
add(...numArr); // -> 6

let arr1 = [1, 2, 3];
let arr2 = [4, 5, 6];
arr1.push(...arr2); // -> [1, 2, 3, 4, 5, 6]

let [a, b, ...arr] = [1, 2, 3, 4, 5];
a; // -> 1
b // -> 2
arr; // ->  [3, 4, 5]

function numArgs(...args) {
  return args.length;
}
numArgs(a, b, c); // -> 3

除了以上内容外,目前还提议在规范中添加对象剩余和展开属性。它们可以按如下方式使用

js

let { x, y, ...z } = { x: 1, y: 2, a: 3, b: 4 };
x; // -> 1
y; // -> 2
z; // -> { a: 3, b: 4 }

let n = { x, y, ...z };
n; // -> { x: 1, y: 2, a: 3, b: 4 }

与其他运算符一样,在剩余或展开运算符与其操作的表达式之间允许使用空格,这会导致代码库中出现不一致的间距。

规则详细信息

此规则旨在强制执行剩余和展开运算符与其表达式之间的一致间距。该规则还支持 ES2018 中的对象剩余和展开属性

json
{
    "parserOptions": {
        "ecmaVersion": 2018
    }
}

请阅读用户指南中关于 配置解析器选项 的部分,以了解更多信息。

选项

此规则接受一个选项:一个值为 "never""always" 的字符串。默认值为 "never"

"never"

使用默认的 "never" 选项时,在展开运算符与其表达式之间不允许使用空格。

json
rest-spread-spacing: ["error"]

json
rest-spread-spacing: ["error", "never"]

此规则使用 "never"不正确代码示例

js
/*eslint @stylistic/rest-spread-spacing: ["error", "never"]*/

fn(...
args);
[...
arr, 4, 5, 6];
let [a, b, ...
arr] = [1, 2, 3, 4, 5];
function fn(...
args) { console.log(args); }
let { x, y, ...
z } = { x: 1, y: 2, a: 3, b: 4 };
let n = { x, y, ...
z };
incorrect

此规则使用 "never"正确代码示例

js
/*eslint @stylistic/rest-spread-spacing: ["error", "never"]*/

fn(...args);
[...arr, 4, 5, 6];
let [a, b, ...arr] = [1, 2, 3, 4, 5];
function fn(...args) { console.log(args); }
let { x, y, ...z } = { x: 1, y: 2, a: 3, b: 4 };
let n = { x, y, ...z };
correct

"always"

使用 "always" 选项时,在展开运算符与其表达式之间需要使用空格。

json
rest-spread-spacing: ["error", "always"]

此规则使用 "always"不正确代码示例

js
/*eslint @stylistic/rest-spread-spacing:["error", "always"]*/

fn(
...
args);
[
...
arr, 4, 5, 6];
let [a, b,
...
arr] = [1, 2, 3, 4, 5];
function fn(
...
args) { console.log(args); }
let { x, y,
...
z } = { x: 1, y: 2, a: 3, b: 4 };
let n = { x, y,
...
z };
incorrect

此规则使用 "always"正确代码示例

js
/*eslint @stylistic/rest-spread-spacing: ["error", "always"]*/

fn(... args);
[... arr, 4, 5, 6];
let [a, b, ... arr] = [1, 2, 3, 4, 5];
function fn(... args) { console.log(args); }
let { x, y, ... z } = { x: 1, y: 2, a: 3, b: 4 };
let n = { x, y, ... z };
correct

何时不使用它

如果您不关心强制执行展开运算符与其表达式之间的一致间距,则可以安全地禁用此规则。