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-depth for class static blocks #15316

Merged
merged 1 commit into from Nov 21, 2021
Merged

Conversation

mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Nov 15, 2021

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-depth.

What changes did you make? (Give an overview)

Updated the max-depth rule to treat class static blocks as separate contexts when calculating depth.

Before this change:

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

function foo() {
    if (true) { // 1, ok
        class C {
            static { // does not count as a nested block, but it's still the same context
                if (true) { // 2, ok
                    if (true) { // 3, report as depth 3
                        if (true) { // 4, report as depth 4
                        }
                    }
                }
            }
        }
    }
}

After this change:

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

function foo() {
    if (true) { // 1, ok
        class C {
            static { // separate context
                if (true) { // 1, ok
                    if (true) { // 2, ok
                        if (true) { // 3, report as depth 3
                        }
                    }
                }
            }
        }
    }
}

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

This is somewhat similar to #15315, but unlike max-statements this rule does not report functions. It reports blocks that are nested too deeply, relative to something (program, or function body). I think it makes sense to report blocks inside static blocks, and to calculate depth relative to the top level of static blocks.

Updates the `max-depth` rule to treat class static blocks as separate contexts when calculating depth.

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 15, 2021
Copy link
Member

@btmills btmills 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 resetting depth in static blocks makes sense.

@btmills btmills merged commit b171cd7 into main Nov 21, 2021
@btmills btmills deleted the staticblocks-maxdepth branch November 21, 2021 04:16
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators May 21, 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 21, 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

2 participants