Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update max-statements for class static blocks #15315

Merged
merged 1 commit into from Nov 19, 2021

Conversation

mdjermanovic
Copy link
Member

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[x] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

Refs #15016, fixes max-statements.

What changes did you make? (Give an overview)

Updated the max-statements rule so that it does not apply to class static blocks and does not count statements in them as statements of the enclosing function.

Is there anything you'd like reviewers to focus on?

Before this change, the behavior of this rule was:

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

function foo() {
    var x; // 1
    return class { // 2
        static {
            var y; // doesn't count
            var z; // doesn't count
            var p; // doesn't count
            {
                var q; // 3
                var r; // 4
                var s; // 5
            }
        }
    }
}
 Function 'foo' has too many statements (5). Maximum allowed is 2. (max-statements)

Statements at the top level of static blocks did not count at all. Statements in nested blocks of static blocks did count, as statements of the enclosing function.

This didn't make sense, and possible fixes were:

  1. Treat static blocks as blocks in the enclosing function, and count all statements. In that case, foo would have 8 statements.
  2. Treat static blocks as inner functions. In that case, foo would have 2 statements, while the static block itself would be reported as it would have 6 statements.
  3. Ignore all statements in static blocks. In that case, foo would have 2 statements, while the static block and its nested blocks would be ignored.

I implemented option 3.

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

function foo() {
    var x; // 1
    return class { // 2
        static { // ignored, the rule does not apply
            var y; // doesn't count
            var z; // doesn't count
            var p; // doesn't count
            {
                var q; // doesn't count
                var r; // doesn't count
                var s; // doesn't count
            }
        }
    }
}

I think that static block shouldn't be seen as a block in the function (option 1). Both options 2 and 3 make sense to me, but the documentation for this rule states multiple times that it applies to "functions", so given the conversation in #15016, it looked like this rule should not apply to static blocks, or at least not by default.

Updates the `max-statements` rule so that it does not apply to class static blocks and does not count statements in them as statements in the enclosing function.

Refs #15016
@mdjermanovic mdjermanovic added rule Relates to ESLint's core rules accepted There is consensus among the team that this change meets the criteria for inclusion new syntax This issue is related to new syntax that has reached stage 4 labels Nov 14, 2021
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I agree with the treatment of static blocks. 👍

@mdjermanovic mdjermanovic merged commit df2f1cc into main Nov 19, 2021
@mdjermanovic mdjermanovic deleted the staticblocks-maxstatements branch November 19, 2021 10:40
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators May 19, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label May 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion new syntax This issue is related to new syntax that has reached stage 4 rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants