Skip to content

docs: mention strict configs' stricter default rule options #8719

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

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Mar 18, 2024

PR Checklist

Overview

Mentions the differences in configs in two ways:

  • In the Shared Configs page as plain text
  • In relevant rules' docs under Options with two defaultOptions* variables

Screenshot of no-floating-promises' Options docs showing different rule options in strict and strict-type-checked

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

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.

Copy link

netlify bot commented Mar 18, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit c1d6ebf
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/65f8c0ae49efce0008cb87eb
😎 Deploy Preview https://deploy-preview-8719--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 (🟢 up 2 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.

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as draft March 18, 2024 22:30
Copy link

nx-cloud bot commented Mar 18, 2024

`const defaultOptionsRecommended: Options = ${defaults};`,
'',
'// These options are merged on top of the recommended defaults',
`const defaultOptionsStrict: Options = ${JSON.stringify(recommended.strict)};`,
Copy link
Member Author

Choose a reason for hiding this comment

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

I'd have liked to apply the actual merging logic so folks can see what the true defaults are for strict. But that'll be a little more involved. In the interest of getting this done faster I'd rather just merge this PR ASAP. Thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is good for quick fix. I'd like to see the merged config. Tho on second hand, it’s nice to see easily what are the things that changed.
So maybe this needs more thought with time? But for now this looks good to me. 👍

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review March 18, 2024 22:33
@armano2 armano2 added documentation Documentation ("docs") that needs adding/updating package: website Issues related to the @typescript-eslint website labels Mar 21, 2024
@bradzacher bradzacher merged commit db4b5e0 into typescript-eslint:main Apr 4, 2024
@JoshuaKGoldberg JoshuaKGoldberg deleted the document-stricter-default-options branch April 4, 2024 15:56
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation ("docs") that needs adding/updating package: website Issues related to the @typescript-eslint website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: differences between recommended and strict configs not mentioned on the website
4 participants