sort-keys

Require object keys to be sorted

当声明多个属性时，一些开发者喜欢按字母顺序对属性名称进行排序，以便在以后更容易找到和/或区别必要的属性。其他人则认为这增加了复杂性，成为维护的负担。

规则细节

该规则检查对象表达式的所有属性定义，并验证所有变量是否按字母顺序排序。

使用此规则的错误示例：

/*eslint sort-keys: "error"*/
/*eslint-env es6*/

let obj = {a: 1, c: 3, b: 2};
let obj = {a: 1, "c": 3, b: 2};

// Case-sensitive by default.
let obj = {a: 1, b: 2, C: 3};

// Non-natural order by default.
let obj = {1: a, 2: c, 10: b};

// This rule checks computed properties which have a simple name as well.
// Simple names are names which are expressed by an Identifier node or a Literal node.
const S = Symbol("s")
let obj = {a: 1, ["c"]: 3, b: 2};
let obj = {a: 1, [S]: 3, b: 2};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

使用此规则的正确示例：

Open in Playground

/*eslint sort-keys: "error"*/
/*eslint-env es6*/

let obj = {a: 1, b: 2, c: 3};
let obj = {a: 1, "b": 2, c: 3};

// Case-sensitive by default.
let obj = {C: 3, a: 1, b: 2};

// Non-natural order by default.
let obj = {1: a, 10: b, 2: c};

// This rule checks computed properties which have a simple name as well.
let obj = {a: 1, ["b"]: 2, c: 3};
let obj = {a: 1, [b]: 2, c: 3};

// This rule ignores computed properties which have a non-simple name.
let obj = {a: 1, [c + d]: 3, b: 2};
let obj = {a: 1, ["c" + "d"]: 3, b: 2};
let obj = {a: 1, [`${c}`]: 3, b: 2};
let obj = {a: 1, [tag`c`]: 3, b: 2};

// This rule does not report unsorted properties that are separated by a spread property.
let obj = {b: 1, ...c, a: 2};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

选项

{
    "sort-keys": ["error", "asc", {"caseSensitive": true, "natural": false, "minKeys": 2}]
}
1
2
3

第 1 个选项是 "asc" 或 "desc"。

"asc"（默认值） - 执行属性的升序。
"desc" - 强制执行属性的降序。

第二个选项是一个有 3 个属性的对象：

caseSensitive - 如果是 true，强制要求属性以大小写为序。默认是 true。
minKeys - 指定一个对象应该有的最小键数，以便该对象的未排序键产生错误。默认为 2，这意味着默认情况下，所有具有未排序键的对象将导致检查抛出错误。
natural - 如果是 true 则强制要求属性以自然顺序排列。默认是 false。自然顺序是以人类排序的方式比较包含字母和数字组合的字符串。它基本上是按数字排序，而不是按字母表排序。所以在自然排序中，数字 10 排在数字 3 之后。
allowLineSeparatedGroups - 如果 true 则该规则允许通过换行来分组对象键。换句话说，一个属性后的空行将重置键值的排序。默认是 false。

列表示例：

如果 natural 为真，排序将是 1 3 6 8 10

如果 natural 为假，排序将是 1 10 3 6 8

desc

使用 "desc" 选项的错误示例：

Open in Playground

/*eslint sort-keys: ["error", "desc"]*/
/*eslint-env es6*/

let obj = {b: 2, c: 3, a: 1};
let obj = {"b": 2, c: 3, a: 1};

// Case-sensitive by default.
let obj = {C: 1, b: 3, a: 2};

// Non-natural order by default.
let obj = {10: b, 2: c, 1: a};
1
2
3
4
5
6
7
8
9
10
11

使用 "desc" 选项的正确示例：

Open in Playground

/*eslint sort-keys: ["error", "desc"]*/
/*eslint-env es6*/

let obj = {c: 3, b: 2, a: 1};
let obj = {c: 3, "b": 2, a: 1};

// Case-sensitive by default.
let obj = {b: 3, a: 2, C: 1};

// Non-natural order by default.
let obj = {2: c, 10: b, 1: a};
1
2
3
4
5
6
7
8
9
10
11

insensitive

使用 {caseSensitive: false} 选项的错误示例：

Open in Playground

/*eslint sort-keys: ["error", "asc", {caseSensitive: false}]*/
/*eslint-env es6*/

let obj = {a: 1, c: 3, C: 4, b: 2};
let obj = {a: 1, C: 3, c: 4, b: 2};
1
2
3
4
5

使用 {caseSensitive: false} 选项的正确示例：

Open in Playground

/*eslint sort-keys: ["error", "asc", {caseSensitive: false}]*/
/*eslint-env es6*/

let obj = {a: 1, b: 2, c: 3, C: 4};
let obj = {a: 1, b: 2, C: 3, c: 4};
1
2
3
4
5

natural

使用 {natural: true} 选项的错误示例：

Open in Playground

/*eslint sort-keys: ["error", "asc", {natural: true}]*/
/*eslint-env es6*/

let obj = {1: a, 10: c, 2: b};
1
2
3
4

使用 {natural: true} 选项的正确示例：

Open in Playground

/*eslint sort-keys: ["error", "asc", {natural: true}]*/
/*eslint-env es6*/

let obj = {1: a, 2: b, 10: c};
1
2
3
4

minKeys

使用 {minKeys: 4} 选项的错误示例：

Open in Playground

/*eslint sort-keys: ["error", "asc", {minKeys: 4}]*/
/*eslint-env es6*/

// 4 keys
let obj = {
    b: 2,
    a: 1, // not sorted correctly (should be 1st key)
    c: 3,
    d: 4,
};

// 5 keys
let obj = {
    2: 'a',
    1: 'b', // not sorted correctly (should be 1st key)
    3: 'c',
    4: 'd',
    5: 'e',
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

使用 {minKeys: 4} 选项的正确示例：

Open in Playground

/*eslint sort-keys: ["error", "asc", {minKeys: 4}]*/
/*eslint-env es6*/

// 3 keys
let obj = {
    b: 2,
    a: 1,
    c: 3,
};

// 2 keys
let obj = {
    2: 'b',
    1: 'a',
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

allowLineSeparatedGroups

使用 {allowLineSeparatedGroups: true} 选项的错误示例：

Open in Playground

/*eslint sort-keys: ["error", "asc", {allowLineSeparatedGroups: true}]*/
/*eslint-env es6*/

let obj1 = {
    b: 1,
    c () {

    },
    a: 3
}

let obj2 = {
    b: 1,
    c: 2,

    z () {

    },
    y: 3
}

let obj3 = {
    b: 1,
    c: 2,

    z () {

    },
    // comment
    y: 3,
}

let obj4 = {
    b: 1
    // comment before comma
    , a: 2
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

使用 {allowLineSeparatedGroups: true} 选项的正确示例：

Open in Playground

/*eslint sort-keys: ["error", "asc", {allowLineSeparatedGroups: true}]*/
/*eslint-env es6*/

let obj = {
    e: 1,
    f: 2,
    g: 3,

    a: 4,
    b: 5,
    c: 6
}

let obj = {
    b: 1,

    // comment
    a: 4,
    c: 5,
}

let obj = {
    c: 1,
    d: 2,

    b () {

    }, 
    e: 3,
}

let obj = {
    c: 1,
    d: 2,
    // comment

    // comment
    b() {

    },
    e: 4
}

let obj = {
    b,

    [foo + bar]: 1,
    a
}

let obj = {
    b: 1
    // comment before comma

    ,
    a: 2
};

var obj = {
    b: 1,

    a: 2,
    ...z,
    c: 3
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

何时不用

如果你不关心属性对顺序，你可以安全地禁用此规则。

兼容

JSCS：validateOrderInObjectKeys

Version

This rule was introduced in ESLint v3.3.0.

Resources

编辑此页

sort-keys

规则细节

选项

desc

insensitive

natural

minKeys

allowLineSeparatedGroups

何时不用

兼容

Related Rules

Version

Resources