max-lines

Ограничивает максимальное количество строк в файле

Некоторые считают большие файлы признаком плохого кода. В больших файлах обычно выполняется много разных задач, и бывает сложно понять, что происходит. Хотя объективного максимального количества строк, допустимого в файле, не существует, большинство согласится, что их не должно быть несколько тысяч. Обычно рекомендуемое количество составляет от 100 до 500 строк.

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

Это правило ограничивает максимальное количество строк в файле, чтобы упростить его сопровождение и снизить сложность.

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

Параметры

Это правило принимает числовой параметр или объект:

• "max" (по умолчанию 300) задаёт максимальное количество строк в файле.

• "skipBlankLines": true игнорирует строки, состоящие только из пробельных символов.

• "skipComments": true игнорирует строки, содержащие только комментарии.

max

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

/*eslint max-lines: ["error", 3]*/
let a,
    b,
    c;

/*eslint max-lines: ["error", 3]*/

let a,
    b,c;

/*eslint max-lines: ["error", 3]*/
// a comment
let a,
    b,c;

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

/*eslint max-lines: ["error", 3]*/
let a,
    b, c;

/*eslint max-lines: ["error", 3]*/

let a, b, c;

/*eslint max-lines: ["error", 3]*/
// a comment
let a, b, c;

skipBlankLines

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

/*eslint max-lines: ["error", {"max": 3, "skipBlankLines": true}]*/

let a,
    b,
    c;

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

/*eslint max-lines: ["error", {"max": 3, "skipBlankLines": true}]*/

let a,
    b, c;

skipComments

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

/*eslint max-lines: ["error", {"max": 2, "skipComments": true}]*/
// a comment
let a,
    b,
    c;

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

/*eslint max-lines: ["error", {"max": 2, "skipComments": true}]*/
// a comment
let a,
    b, c;

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

Вы можете отключить это правило, если количество строк в файлах вас не беспокоит.

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

• JSCS: maximumNumberOfLines

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

• complexity
• max-depth
• max-lines-per-function
• max-nested-callbacks
• max-params
• max-statements

Версия

Это правило появилось в ESLint v2.12.0.

Дополнительная литература

Ресурсы

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