sort-keys

Требовать сортировку ключей объекта

При объявлении нескольких свойств некоторые разработчики предпочитают сортировать имена свойств по алфавиту, чтобы легче было найти и/или сравнить необходимые свойства в дальнейшем. Другие считают, что это добавляет сложности и становится обременительным для поддержания.

Подробное описание правила

Это правило проверяет все определения свойств выражений объекта и проверяет, что все переменные отсортированы в алфавитном порядке.

Примеры некорректного кода для этого правила:

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

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

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

// Non-natural order by default.
let obj4 = {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 obj5 = {a: 1, ["c"]: 3, b: 2};
let obj6 = {a: 1, [S]: 3, b: 2};

Примеры корректного кода для этого правила:

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

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

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

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

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

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

// This rule does not report unsorted properties that are separated by a spread property.
let obj11 = {b: 1, ...c, a: 2};

Параметры

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

Первый параметр "asc" или "desc".

• "asc" (по умолчанию) — принудительная сортировка свойств в возрастающем порядке.
• "desc" — принудительная сортировка свойств в убывающем порядке.

Второй параметр — объект, имеющий следующие свойства.

• caseSensitive — если true, принудительная сортировка свойств в регистрозависимом порядке. Значение по умолчанию — true.
• minKeys — Указывает минимальное количество ключей, которые должен иметь объект, чтобы несортированные ключи объекта породили ошибку. Значение по умолчанию — 2, что означает, что по умолчанию все объекты с несортированными ключами приведут к ошибкам проверки.
• natural — если true, принудительная сортировка свойств в естественном порядке. Значение по умолчанию — false. Естественный порядок сравнивает строки, содержащие сочетание букв и цифр, так, как это сделал бы человек. В основном он сортирует по числовому значению, а не по алфавиту. Таким образом, число 10 идёт после числа 3 в естественной сортировке.
• allowLineSeparatedGroups — если true, правило разрешает группировать ключи объекта с помощью переносов строк. Другими словами, пустая строка после свойства сбросит сортировку ключей. Значение по умолчанию — false.

Пример для списка:

Если natural установлено в true, порядок будет 1 3 6 8 10

Если natural установлено в false, порядок будет 1 10 3 6 8

desc

Примеры некорректного кода для параметра "desc":

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

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

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

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

Примеры корректного кода для параметра "desc":

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

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

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

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

insensitive

Примеры некорректного кода для параметра {caseSensitive: false}:

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

let obj1 = {a: 1, c: 3, C: 4, b: 2};
let obj2 = {a: 1, C: 3, c: 4, b: 2};

Примеры корректного кода для параметра {caseSensitive: false}:

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

let obj1 = {a: 1, b: 2, c: 3, C: 4};
let obj2 = {a: 1, b: 2, C: 3, c: 4};

естественный

Примеры некорректного кода для параметра {natural: true}:

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

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

Примеры корректного кода для параметра {natural: true}:

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

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

minKeys

Примеры некорректного кода для параметра {minKeys: 4}:

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

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

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

Примеры корректного кода для параметра {minKeys: 4}:

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

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

// 2 keys
let obj2 = {
    2: 'b',
    1: 'a',
};

Разрешить разделение групп по строкам

Примеры некорректного кода для параметра {allowLineSeparatedGroups: true}:

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

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

Примеры корректного кода для параметра {allowLineSeparatedGroups: true}:

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

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

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

let obj2 = {
    b: 1,

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

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

    b () {

    },
    e: 3,
}

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

    // comment
    b() {

    },
    e: 4
}

let obj5 = {
    b,

    [foo + bar]: 1,
    a
}

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

    ,
    a: 2
};

var obj7 = {
    b: 1,

    a: 2,
    ...z,
    c: 3
}

Когда не следует его использовать

Если вы не хотите получать уведомления о порядке свойств, то безопасно отключить это правило.

Совместимость

• JSCS: validateOrderInObjectKeys

Связанные правила

• sort-imports
• sort-vars

Версия

Эта правила была добавлена в ESLint v3.3.0.

Ресурсы

• Исходный код правила
• Исходный код тестов