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(eslint-plugin): fix ignorePrimitives examples in prefer-nullish-coalescing docs #7650

Merged
merged 1 commit into from
Sep 15, 2023

Conversation

ide
Copy link
Contributor

@ide ide commented Sep 15, 2023

PR Checklist

Overview

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

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.
@typescript-eslint
Copy link
Contributor

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.

@netlify
Copy link

netlify bot commented Sep 15, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit d318fc5
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6503f80e5e219f0008a52b0b
😎 Deploy Preview https://deploy-preview-7650--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 98 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@ide ide changed the title docs: Fix ignorePrimitives examples in prefer-nullish-coalescing docs docs(eslint-plugin): Fix ignorePrimitives examples in prefer-nullish-coalescing docs Sep 15, 2023
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯 love it, thanks!

@JoshuaKGoldberg JoshuaKGoldberg changed the title docs(eslint-plugin): Fix ignorePrimitives examples in prefer-nullish-coalescing docs docs(eslint-plugin): fix ignorePrimitives examples in prefer-nullish-coalescing docs Sep 15, 2023
@JoshuaKGoldberg JoshuaKGoldberg merged commit 7826910 into typescript-eslint:main Sep 15, 2023
48 of 50 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants