require object keys to be sorted (sort-keys)

要求对象属性按序排列 (sort-keys)

When declaring multiple properties, some developers prefer to sort property names alphabetically to be able to find necessary property easier at the later time. Others feel that it adds complexity and becomes burden to maintain.

当声明多个属性是,一些开发人员倾向于属性按字母顺序进行排列,可以在以后更容易地找到必要的属性。其他人则认为对属性进行排序增加了复杂性,并成为维护的负担。

Rule Details

This rule checks all property definitions of object expressions and verifies that all variables are sorted alphabetically.

该规则检查对象表达式中所有属性的定义,确认所有变量都是按字母顺序排序的。

Examples of incorrect code for this rule:

错误 代码示例:

/*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};

Examples of correct code for this rule:

正确 代码示例:

/*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};

Options

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

The 1st option is "asc" or "desc".

第一个选项是 "asc""desc"

The 2nd option is an object which has 2 properties.

第二个选项是个对象,有 2 个属性。

Example for a list:

比如:

With natural as true, the ordering would be

natural 为 true,排序结果为:

1
3
6
8
10

With natural as false, the ordering would be

natural 为 false,排序结果为:

1
10
3
6
8

desc

Examples of incorrect code for the "desc" option:

选项 "desc"错误 代码示例:

/*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};

Examples of correct code for the "desc" option:

选项 "desc"正确 代码示例:

/*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};

insensitive

Examples of incorrect code for the {caseSensitive: false} option:

选项 {caseSensitive: false}错误 代码示例:

/*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};

Examples of correct code for the {caseSensitive: false} option:

选项 {caseSensitive: false}正确 代码示例:

/*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};

natural

Examples of incorrect code for the {natural: true} option:

选项 {natural: true}错误 代码示例:

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

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

Examples of correct code for the {natural: true} option:

选项 {natural: true}正确 代码示例:

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

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

When Not To Use It

If you don’t want to notify about properties’ order, then it’s safe to disable this rule.

如果你想收到关于属性顺序的通知,可以禁用此规则。

Compatibility

Version

This rule was introduced in ESLint 3.3.0.

该规则在 ESLint 3.3.0 中被引入。

Resources