Rule Change: Make max-lines-per-function only reports lines that exceed the limit, not all

What rule do you want to change?

max-lines-per-function

What change to do you want to make?

Generate fewer warnings

How do you think the change should be implemented?

A new default behavior

Example code

/* eslint max-lines-per-function: ["error", {"max": 3}] */
export function bulkyFunction() {
  // line 1
  // line 2
  // line 3
}

What does the rule currently do for this code?

Currently it will report the range of line numbers from the beginning of the function to the very last line of it.

What will the rule do after it’s changed?

Following the same spirit of max-lines implemented in #13318, we should only report those lines which exceed the limit. With this example, it should only report line 4 and 5.

Participation

• I am willing to submit a pull request to implement this change.

Additional comments

The current default is annoying because once the function exceeds even a single line, the whole function is highlighted by the editor and other important errors may be suppressed as a result.

[nzakas]

@The-x-Theorist thanks. We already have @LilCthulu volunteering to work on this, so let’s give them the chance to complete the work first.

[LilCthulu]

@nzakas Thanks! I’ll get started right away and keep you posted!