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

docs: add examples for block-scoped-var with class static blocks #15302

Merged
merged 1 commit into from Nov 12, 2021

Conversation

mdjermanovic
Copy link
Member

Prerequisites checklist

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

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] 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 block-scoped-var.

What changes did you make? (Give an overview)

This change documents examples for block-scoped-var with class static blocks, and adds a few tests.`

There's also a change in the code, but it's only for clarity. It doesn't change the behavior of this rule, because var variables defined in a static block cannot be referenced outside of it. Without this change, variables defined at the top-level of a static block would have been treated as if they were defined in an upper surrounding block, but the end result would be the same.

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

Documents examples for `block-scoped-var` with class static blocks.

The code change is only for clarity. It doesn't change the behavior of this rule.

Refs #15016
@mdjermanovic mdjermanovic added rule Relates to ESLint's core rules documentation Relates to ESLint's documentation 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 12, 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. Note that because this did change functionality, I'll merge with "feat:" commit message.

@nzakas
Copy link
Member

nzakas commented Nov 12, 2021

Er sorry, rather, because there was a code change, I'm merging with "feat". Even though it technically didn't change the behavior, we should always flag code changes as separate from docs changes.

@nzakas nzakas merged commit abe740c into main Nov 12, 2021
@nzakas nzakas deleted the staticblocks-blockscopedvar branch November 12, 2021 17:41
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators May 12, 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 12, 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 documentation Relates to ESLint's documentation 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