Rule Proposal: max-lines

[mysticatea]

From maximumNumberOfLines.

This rule will disallow that a file gets the number of lines more than the specific integer.

{
    "max-lines": ["error", {
        "max": 300,
        "skipBlankLines": false,
        "skipComments": false
    }]
}

• max (default is 300) - The maximum count of lines per file.
• skipBlankLines (default is false) - If this is true, this rule skips blank lines to count lines.
• skipComments (default is false) - If this is true, this rule skips comment lines to count lines.

[alberto]

I'm a champion

[ilyavolodin]

This rule is very close to complexity (no direct correlation, but never the less more lines usually means higher complexity). Do we need this in the core or should it go into a plugin of some kind?

[alberto]

@ilyavolodin there is a bit of correlation, but they are quite different. Also, complexity is per function, same as max-statements

[doberkofler]

+1

[alberto]

@eslint/eslint-team opinions?

[mikesherov]

👍

[qfox]

👍

[nzakas]

👍

[platinumazure]

For skipComments, I assume that refers to lines with only comments and whitespace on them?

Lines I assume count under that definition:

// comment

/* comment */

/* comment one */ /* comment two */

/* comment one */ // comment two

Lines I assume don't count under that definition:

var foo = "bar"; // comment

And I'm happy to take this on if @alberto isn't super attached.