max-lines.md

规则名	规则类型	关联规则	深入了解
max-lines	suggestion	complexity max-depth max-lines-per-function max-nested-callbacks max-params max-statements	https://web.archive.org/web/20160725154648/http://www.mind2b.com/component/content/article/24-software-module-size-and-file-size

Some people consider large files a code smell. Large files tend to do a lot of things and can make it hard following what's going. While there is not an objective maximum number of lines considered acceptable in a file, most people would agree it should not be in the thousands. Recommendations usually range from 100 to 500 lines.

规则详解

This rule enforces a maximum number of lines per file, in order to aid in maintainability and reduce complexity.

Please note that most editors show an additional empty line at the end if the file ends with a line break. This rule does not count that extra line.

配置项

This rule has a number or object option:

• "max" (default 300) enforces a maximum number of lines in a file

• "skipBlankLines": true ignore lines made up purely of whitespace.

• "skipComments": true ignore lines containing just comments

max

Examples of incorrect code for this rule with a max value of 2:

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

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

var a,
    b,c;

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

Examples of correct code for this rule with a max value of 2:

::: correct

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

::: correct

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

var a, b, c;

::: correct

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

skipBlankLines

选项 { "skipBlankLines": true } 的 错误 代码示例：

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

var a,
    b,
    c;

选项 { "skipBlankLines": true } 的 正确 代码示例：

::: correct

/*eslint max-lines: ["error", {"max": 2, "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 } 的 正确 代码示例：

::: correct

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

禁用建议

You can turn this rule off if you are not concerned with the number of lines in your files.

兼容

• JSCS: maximumNumberOfLines