максимальное количество строк

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

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

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

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

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

Параметры

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

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

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

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

макс

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

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

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

var a,
    b,c;

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

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

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

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

var a, b, c;

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

skipBlankLines

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

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

var a,
    b,
    c;

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

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

var a,
    b, c;

skipComments

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

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

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

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

Когда от него следует отказаться

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

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

• JSCS: maximumNumberOfLines

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

• complexity
• max-depth
• max-строк-на-функцию
• max-вложенных-обработчиков-событий
• max-параметров
• max-операторов

Версия

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

Дополнительные материалы

Ресурсы

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