-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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(eslint-plugin): fix ignorePrimitives examples in prefer-nullish-coalescing docs #7650
docs(eslint-plugin): fix ignorePrimitives examples in prefer-nullish-coalescing docs #7650
Conversation
The examples for the `ignorePrimitives` option were flipped. Setting `ignorePrimitives` to true means that any logical OR expression with a primitive operand is ignored by the lint rule. I also made two other edits to this docs page. The first is to change "you can safely replace" to "you may consider replacing" in the lint rule's description. The reason for this change is that this lint rule suggests changes that alter the code's behavior in subtle cases where `x || y !== x ?? y`. There is also a small change to reword the tense in one of the sentences to help it read more smoothly.
Thanks for the PR, @ide! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💯 love it, thanks!
7826910
into
typescript-eslint:main
PR Checklist
Overview
The examples for the
ignorePrimitives
option were flipped. SettingignorePrimitives
to true means that any logical OR expression with a primitive operand is ignored by the lint rule.I also made two other edits to this docs page. The first is to change "you can safely replace" to "you may consider replacing" in the lint rule's description. The reason for this change is that this lint rule suggests changes that alter the code's behavior in subtle cases where
x || y !== x ?? y
. My interpretation of "safe" for lint suggestions is they don't change the behavior of the code, please let me know if this expectation isn't correct!There is also a small change to reword the tense in one of the sentences to help it read more smoothly.