max-lines
强制执行每个文件最大行数
有些人认为大型文件是代码异味。大型文件往往会做很多事情,并且可能难以跟踪正在发生的事情。虽然没有一个客观的最大行数被认为在一个文件中是可以接受的,但大多数人都会同意它不应该达到数千行。建议通常在 100 到 500 行之间。
规则详情
此规则强制执行每个文件最大行数,以帮助提高可维护性和降低复杂性。
请注意,如果文件以换行符结尾,大多数编辑器会在末尾显示一个额外的空行。此规则不计算该额外行。
选项
此规则有一个数字或对象选项
-
"max"
(默认值为300
)强制执行文件中最大行数 -
"skipBlankLines": true
忽略仅由空白字符组成的行。 -
"skipComments": true
忽略仅包含注释的行
max
对于此规则,使用最大值为 3
的错误代码示例
在 Playground 中打开
/*eslint max-lines: ["error", 3]*/
var a,
b,
在 Playground 中打开
/*eslint max-lines: ["error", 3]*/
var a,
在 Playground 中打开
/*eslint max-lines: ["error", 3]*/
// a comment
var a,
对于此规则,使用最大值为 3
的正确代码示例
在 Playground 中打开
/*eslint max-lines: ["error", 3]*/
var a,
b, c;
在 Playground 中打开
/*eslint max-lines: ["error", 3]*/
var a, b, c;
在 Playground 中打开
/*eslint max-lines: ["error", 3]*/
// a comment
var a, b, c;
skipBlankLines
对于此规则,使用 { "skipBlankLines": true }
选项的错误代码示例
在 Playground 中打开
/*eslint max-lines: ["error", {"max": 3, "skipBlankLines": true}]*/
var a,
b,
对于此规则,使用 { "skipBlankLines": true }
选项的正确代码示例
在 Playground 中打开
/*eslint max-lines: ["error", {"max": 3, "skipBlankLines": true}]*/
var a,
b, c;
skipComments
对于此规则,使用 { "skipComments": true }
选项的错误代码示例
在 Playground 中打开
/*eslint max-lines: ["error", {"max": 2, "skipComments": true}]*/
// a comment
var a,
b,
对于此规则,使用 { "skipComments": true }
选项的正确代码示例
在 Playground 中打开
/*eslint max-lines: ["error", {"max": 2, "skipComments": true}]*/
// a comment
var a,
b, c;
何时不使用它
如果您不关心文件中的行数,可以关闭此规则。
兼容性
- JSCS:maximumNumberOfLines
相关规则
版本
此规则在 ESLint v2.12.0 中引入。