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 lines-around-comment for class static blocks #15323

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 lines-around-comment.

What changes did you make? (Give an overview)

Updated the lines-around-comment rule so that options "allowBlockStart" and "allowBlockEnd" apply to class static blocks.

These options already apply to both block statements and function bodies.

/*eslint lines-around-comment: ["error", { "beforeLineComment": true, "allowBlockStart": true }]*/

if (bar) {
    // allowed
    foo();
}
class C {    
    method() {
        // allowed
        foo();
    }
    static {
        // should be allowed, too
        foo();
    }
}

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

By the existing code, these options also apply to SwitchCase, but that wasn't documented and it looks broken, so I didn't document that now.

Updates the `lines-around-comment` rule so that options `"allowBlockStart"` and `"allowBlockEnd"` apply to class static blocks.

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 16, 2021
@mdjermanovic
Copy link
Member Author

CLA check is still pending, and the commit message check is missing. I'll close-reopen to see if that will fix the checks on this PR.

@mdjermanovic
Copy link
Member Author

Looks good now.

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

@mdjermanovic mdjermanovic merged commit f03cd14 into main Nov 19, 2021
@mdjermanovic mdjermanovic deleted the staticblocks-linesaroundcomment branch November 19, 2021 10:58
@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

2 participants