Spec-Zone.ru › ESLint

сортировка-переменных

Требует, чтобы переменные в одном блоке объявления были отсортированы

🔧 Исправимо

Некоторые проблемы, выявленные этим правилом, могут быть автоматически исправлены с помощью параметра --fix командной строки

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

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

Это правило проверяет все блоки объявления переменных и проверяет, что все переменные отсортированы по алфавиту. По умолчанию правило чувствительно к регистру.

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

Открыть в Playground
/*eslint sort-vars: "error"*/

var b, a;

var a, B, c;

var a, A;

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

Открыть в Playground
/*eslint sort-vars: "error"*/

var a, b, c, d;

var _a = 10;
var _b = 20;

var A, a;

var B, a, c;

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

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

var c, d, a, b;

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

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

var c, d, a, e;

Параметры

Это правило имеет параметр в виде объекта:

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

ignoreCase

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

Открыть в Playground
/*eslint sort-vars: ["error", { "ignoreCase": true }]*/

var a, A;

var a, B, c;

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

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

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

  • sort-keys
  • sort-imports

Версия

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

Ресурсы

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

© OpenJS Foundation and other contributors
Licensed under the MIT License.
https://eslint.org/docs/latest/rules/sort-vars

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API