sort-vars

Требует сортировки переменных в одном блоке объявлений

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

Описание правила

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

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

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

let b, a;

let c, D, e;

let f, F;

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

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

let a, b, c, d;

let _a = 10;
let _b = 20;

let E, e;

let G, f, h;

Алфавитный порядок поддерживается, начиная с первой переменной и пропуская переменные, которые считаются проблемными. Поэтому следующий код вызовет две проблемы:

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

let c, d, a, b;

А этот код вызовет только одну:

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

let c, d, a, e;

Параметры

У этого правила есть параметр-объект:

• "ignoreCase": true (по умолчанию false) игнорирует регистр при проверке порядка переменных

ignoreCase

Примеры правильного кода для этого правила с параметром { "ignoreCase": true }:

/*eslint sort-vars: ["error", { "ignoreCase": true }]*/

let a, A;

let c, D, e;

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

Это правило задаёт предпочтительный стиль форматирования, и его несоблюдение не влияет отрицательно на качество кода. Если алфавитная сортировка переменных не входит в ваши стандарты кодирования, это правило можно отключить.

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

• sort-keys
• sort-imports

Версия

Это правило появилось в ESLint v0.2.0.

Ресурсы

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