max-lines

強制每個檔案的最大行數

有些人認為大型檔案是程式碼異味。大型檔案往往會做很多事情，並且可能難以追蹤發生了什麼。雖然在一個檔案中可接受的最大行數沒有客觀的標準，但大多數人都會同意它不應該達到數千行。建議通常範圍從 100 行到 500 行不等。

規則詳細資訊

此規則強制每個檔案的最大行數，以幫助維護並降低複雜性。

請注意，如果檔案以換行符號結束，則大多數編輯器會在末尾顯示一個額外的空白行。此規則不計算該額外的行。

選項

此規則具有數字或物件選項

• "max" (預設值 300) 強制檔案中的最大行數

• "skipBlankLines": true 忽略完全由空白組成的行。

• "skipComments": true 忽略僅包含註解的行

max

此規則在最大值為 3 時的不正確程式碼範例

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

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

var a,
    b,c;
1
2
3
4

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

此規則在最大值為 3 時的正確程式碼範例

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

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

var a, b, c;
1
2
3

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

skipBlankLines

此規則使用 { "skipBlankLines": true } 選項時的不正確程式碼範例

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

var a,
    b,
    c;
1
2
3
4
5

此規則使用 { "skipBlankLines": true } 選項時的正確程式碼範例

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

var a,
    b, c;
1
2
3
4

skipComments

此規則使用 { "skipComments": true } 選項時的不正確程式碼範例

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

此規則使用 { "skipComments": true } 選項時的正確程式碼範例

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

何時不使用它

如果您不關心檔案中的行數，則可以關閉此規則。

相容性

• JSCS: maximumNumberOfLines

相關規則

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

版本

此規則是在 ESLint v2.12.0 中引入的。

延伸閱讀

軟體模組大小和檔案大小
web.archive.org

資源

• 規則來源
• 測試來源