docs: Add private class features info to no-underscore-dangle #17386
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
nzakas
requested changes
Jul 19, 2023
matwilko
force-pushed
the
no-underscore-dangle-private-fields-update
branch
from
14071a0
to
cec536d
Compare
|
Put the history back in, but tried to tighten it up a bit. Put the Private class features notice in an |
nzakas
reviewed
Jul 20, 2023
matwilko
force-pushed
the
no-underscore-dangle-private-fields-update
branch
3 times, most recently
from
8582d83
to
49e273a
Compare
nzakas
reviewed
Jul 21, 2023
matwilko
force-pushed
the
no-underscore-dangle-private-fields-update
branch
from
49e273a
to
f126324
Compare
eslint-github-bot
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
no-underscore-dangledocs currently state that 'JavaScript doesn’t have truly private members' and go into detail around the history of underscored identifiers.Since ES2022/ES13 brought in truly private members, I've slimmed down the historical context and added info about private members and a recommendation to use them instead of underscored identifiers.
Is there anything you'd like reviewers to focus on?
I removed the historical context because it seems less relevant now that actual private fields can be recommended, but I can restore it if you think it still provides useful context.
As a follow-up, would a proposal for a new rule that highlights leading-underscore members and suggests they be refactored as private members be reasonable? Or should that perhaps be rolled into this rule to prevent any overlap?