Skip to content

docs: inject option descriptions into rule docs when possible #9925

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 11 commits into from
Oct 15, 2024
Merged

docs: inject option descriptions into rule docs when possible #9925

merged 11 commits into from
Oct 15, 2024

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

For each rule whose meta.schema[0] is an object with type: "properties" or type: "oneOf", this adds the description for each of those option properties to the rule's docs page.

💖

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

@netlify Netlify
Copy link

netlify bot commented Sep 3, 2024 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 693d24c
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6709464c534bcd0007276150
😎 Deploy Preview https://deploy-preview-9925--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 5 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.

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Sep 3, 2024 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 693d24c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 32 targets

Sent with 💌 from NxCloud.

@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Sep 3, 2024
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review September 20, 2024 15:20
@JoshuaKGoldberg JoshuaKGoldberg requested a review from a team September 20, 2024 15:23
@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Oct 10, 2024
@codecov Codecov
Copy link

codecov bot commented Oct 11, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.09%. Comparing base (ef5df2f) to head (693d24c).
Report is 13 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #9925   +/-   ##
=======================================
  Coverage   86.09%   86.09%           
=======================================
  Files         428      428           
  Lines       14969    14969           
  Branches     4343     4343           
=======================================
  Hits        12888    12888           
  Misses       1734     1734           
  Partials      347      347
Flag Coverage Δ
unittest 86.09% <ø> (ø)

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

Files with missing lines Coverage Δ
...t-plugin/src/rules/class-literal-property-style.ts 100.00% <ø> (ø)
.../eslint-plugin/src/rules/class-methods-use-this.ts 91.30% <ø> (ø)
...lugin/src/rules/consistent-generic-constructors.ts 90.24% <ø> (ø)
...lugin/src/rules/consistent-indexed-object-style.ts 96.61% <ø> (ø)
...nt-plugin/src/rules/consistent-type-definitions.ts 100.00% <ø> (ø)
...-plugin/src/rules/explicit-member-accessibility.ts 97.61% <ø> (ø)
...es/eslint-plugin/src/rules/no-invalid-void-type.ts 97.82% <ø> (ø)
...ges/eslint-plugin/src/rules/no-misused-promises.ts 97.66% <ø> (ø)
...s/eslint-plugin/src/rules/no-restricted-imports.ts 94.87% <ø> (ø)
...ges/eslint-plugin/src/rules/no-restricted-types.ts 93.02% <ø> (ø)
... and 5 more

@JoshuaKGoldberg JoshuaKGoldberg removed the awaiting response Issues waiting for a reply from the OP or another party label Oct 11, 2024
kirkwaiblinger
kirkwaiblinger approved these changes Oct 15, 2024
View reviewed changes
Copy link
Member

@kirkwaiblinger kirkwaiblinger left a comment

Choose a reason for hiding this comment

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

I'm happy with this approach!

@JoshuaKGoldberg JoshuaKGoldberg merged commit d09d36d into typescript-eslint:main Oct 15, 2024
61 of 62 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@kirkwaiblinger kirkwaiblinger kirkwaiblinger approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Automatically inject rule option descriptions into their docs
2 participants
@JoshuaKGoldberg @kirkwaiblinger