Skip to content

feat(typescript-eslint): add JSDoc comments on generated configs #9672

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

PR Checklist

Overview

Syncs the descriptions from their docs pages on https://typescript-eslint.io/users/configs.

@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 Jul 30, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 033029a
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/66b98ddb4c578300087295e4
😎 Deploy Preview https://deploy-preview-9672--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: 97 (🟢 up 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (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
Copy link
Member Author

Adding the breaking change label to appease the CI check, but this is not a breaking change. We should remove the label before merge 😄

Copy link

nx-cloud bot commented Jul 30, 2024

@JoshuaKGoldberg JoshuaKGoldberg added the breaking change This change will require a new major version to be released label Jul 30, 2024
@bradzacher
Copy link
Member

Could you test this in the IDE?
Does this do what we want it to and give us a description to the tseslint.configs.recommended property?

I suspect it won't and instead this would need to be placed in a type on this variable https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/typescript-eslint/src/index.ts#L55

Copy link

codecov bot commented Jul 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.92%. Comparing base (fe56157) to head (033029a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #9672   +/-   ##
=======================================
  Coverage   87.92%   87.92%           
=======================================
  Files         402      402           
  Lines       13726    13726           
  Branches     3999     3999           
=======================================
  Hits        12069    12069           
  Misses       1351     1351           
  Partials      306      306           
Flag Coverage Δ
unittest 87.92% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@bradzacher bradzacher removed the breaking change This change will require a new major version to be released label Aug 1, 2024
@JoshuaKGoldberg JoshuaKGoldberg requested review from bradzacher and a team August 12, 2024 04:19
@JoshuaKGoldberg JoshuaKGoldberg merged commit 90576fa into typescript-eslint:main Aug 12, 2024
56 of 59 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the generated-configs-doc-comments branch August 12, 2024 14:29
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 20, 2024
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.

Docs: Add JSDoc descriptions to generated configs
2 participants