key-spacing

强制对象字面量属性中键和值之间保持一致的间距

🔧

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

重要提示

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

了解更多

此规则强制对象字面量属性中冒号周围的间距。它可以单独验证每个属性，或者它可以确保对象字面量中相邻属性的水平对齐。

规则详情

此规则强制对象字面量属性中键和值之间保持一致的间距。对于长行，可以在允许空格的任何位置添加新行。

选项

此规则有一个对象选项

"beforeColon": false (默认) | true
- false: 禁止对象字面量中键和冒号之间的空格。
- true: 要求对象字面量中键和冒号之间至少有一个空格。
"afterColon": true (默认) | false
- true: 要求对象字面量中冒号和值之间至少有一个空格。
- false: 禁止对象字面量中冒号和值之间的空格。
"mode": "strict" (默认) | "minimum"
- "strict": 强制对象字面量中冒号前后只有一个空格。
- "minimum": 强制对象字面量中冒号前后有一个或多个空格。
"align": "value" | "colon"
- "value": 强制对象字面量中值的水平对齐。
- "colon" 强制对象字面量中冒号和值的水平对齐。
带有对象值的 "align" 允许在对象字面量中对齐值时进行细粒度的间距设置。
"singleLine" 指定单行对象字面量的间距样式。
"multiLine" 指定多行对象字面量的间距样式。

请注意，您可以选择使用顶层选项或分组选项（singleLine 和 multiLine），但不能同时使用两者。

beforeColon

使用默认 { "beforeColon": false } 选项时，不正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "beforeColon": false }]*/

var obj = { "foo" : 42 };
1
2
3

使用默认 { "beforeColon": false } 选项时，正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "beforeColon": false }]*/

var obj = { "foo": 42 };
1
2
3

使用 { "beforeColon": true } 选项时，不正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "beforeColon": true }]*/

var obj = { "foo": 42 };
1
2
3

使用 { "beforeColon": true } 选项时，正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "beforeColon": true }]*/

var obj = { "foo" : 42 };
1
2
3

afterColon

使用默认 { "afterColon": true } 选项时，不正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "afterColon": true }]*/

var obj = { "foo":42 };
1
2
3

使用默认 { "afterColon": true } 选项时，正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "afterColon": true }]*/

var obj = { "foo": 42 };
1
2
3

使用 { "afterColon": false } 选项时，不正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "afterColon": false }]*/

var obj = { "foo": 42 };
1
2
3

使用 { "afterColon": false } 选项时，正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "afterColon": false }]*/

var obj = { "foo":42 };
1
2
3

mode

使用默认 { "mode": "strict" } 选项时，不正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "mode": "strict" }]*/

call({
    foobar: 42,
    bat:    2 * 2
});
1
2
3
4
5
6

使用默认 { "mode": "strict" } 选项时，正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "mode": "strict" }]*/

call({
    foobar: 42,
    bat: 2 * 2
});
1
2
3
4
5
6

使用 { "mode": "minimum" } 选项时，正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "mode": "minimum" }]*/

call({
    foobar: 42,
    bat:    2 * 2
});
1
2
3
4
5
6

align

使用 { "align": "value" } 选项时，不正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "align": "value" }]*/

var obj = {
    a: value,
    bcde:  42,
    fg :   foo()
};
1
2
3
4
5
6
7

使用 { "align": "value" } 选项时，正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "align": "value" }]*/

var obj = {
    a:    value,
    bcde: 42,

    fg: foo(),
    h:  function() {
        return this.a;
    },
    ijkl: 'Non-consecutive lines form a new group'
};

var obj = { a: "foo", longPropertyName: "bar" };
1
2
3
4
5
6
7
8
9
10
11
12
13
14

使用 { "align": "colon" } 选项时，不正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "align": "colon" }]*/

call({
    foobar: 42,
    bat:    2 * 2
});
1
2
3
4
5
6

使用 { "align": "colon" } 选项时，正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", { "align": "colon" }]*/

call({
    foobar: 42,
    bat   : 2 * 2
});
1
2
3
4
5
6

align

align 选项可以通过 beforeColon、afterColon、mode 和 on 选项进行额外的配置。

如果 align 定义为对象，但并非所有参数都已提供，则未定义的参数将默认为以下值

// Defaults
align: {
    "beforeColon": false,
    "afterColon": true,
    "on": "colon",
    "mode": "strict"
}
1
2
3
4
5
6
7

使用示例 { "align": { } } 选项时，正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", {
    "align": {
        "beforeColon": true,
        "afterColon": true,
        "on": "colon"
    }
}]*/

var obj = {
    "one"   : 1,
    "seven" : 7
}
1
2
3
4
5
6
7
8
9
10
11
12

在 Playground 中打开

/*eslint key-spacing: ["error", {
    "align": {
        "beforeColon": false,
        "afterColon": false,
        "on": "value"
    }
}]*/

var obj = {
    "one":  1,
    "seven":7
}
1
2
3
4
5
6
7
8
9
10
11
12

align 和 multiLine

multiLine 和 align 选项可以不同，这允许对文件的 key-spacing 进行微调控制。如果 align 配置为对象，则 align 将不会从 multiLine 继承。

multiLine 在对象字面量跨越多行时使用。当同一对象中存在一组属性时，将使用 align 配置。例如

var myObj = {
  key1: 1, // uses multiLine

  key2: 2, // uses align (when defined)
  key3: 3, // uses align (when defined)

  key4: 4 // uses multiLine
}

1
2
3
4
5
6
7
8
9

使用示例 { "align": { }, "multiLine": { } } 选项时，不正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", {
    "multiLine": {
        "beforeColon": false,
        "afterColon":true
    },
    "align": {
        "beforeColon": true,
        "afterColon": true,
        "on": "colon"
    }
}]*/

var obj = {
    "myObjectFunction": function() {
        // Do something
    },
    "one"             : 1,
    "seven"           : 7
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

使用示例 { "align": { }, "multiLine": { } } 选项时，正确代码示例

在 Playground 中打开

/*eslint key-spacing: ["error", {
    "multiLine": {
        "beforeColon": false,
        "afterColon": true

    },
    "align": {
        "beforeColon": true,
        "afterColon": true,
        "on": "colon"
    }
}]*/

var obj = {
    "myObjectFunction": function() {
        // Do something
        //
    }, // These are two separate groups, so no alignment between `myObjectFunction` and `one`
    "one"   : 1,
    "seven" : 7 // `one` and `seven` are in their own group, and therefore aligned
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

singleLine 和 multiLine

使用示例 { "singleLine": { }, "multiLine": { } } 选项时，正确代码示例

在 Playground 中打开

/*eslint "key-spacing": [2, {
    "singleLine": {
        "beforeColon": false,
        "afterColon": true
    },
    "multiLine": {
        "beforeColon": true,
        "afterColon": true,
        "align": "colon"
    }
}]*/
var obj = { one: 1, "two": 2, three: 3 };
var obj2 = {
    "two" : 2,
    three : 3
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

何时不使用

如果您有另一种属性间距约定，可能与可用选项不一致，或者如果您想同时允许多种样式，您可以安全地禁用此规则。

版本

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

资源

编辑此页面