Addsdescription properties to most rule options that didn't have them. This should be all remaining rules that aren't feature-frozen or using only an enum/string array (instead of object) for their options.

There are probably some rules missing that could be improved. I ran out of energy before converting most string literal union types into enums... If#9866 lands, we'll be forced to fill them in anyway.

Also standardizes the phrasing of some options to sound more like each other. Mostly, that's starting boolean options with"Whether ..." instead of some of the many more wordy ways we've used.

Another good next step after this would be#9867 IMO: using these descriptions in rule docs pages. The phrasing standardization helps with that.

💖

docs: fill in most remainng rule option descriptions

93505f5

Copy link

Contributor

typescript-eslintbot commentedAug 23, 2024

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.

JoshuaKGoldberg mentioned this pull request

Aug 23, 2024

Docs: Automatically inject rule option descriptions into their docs#9867

Closed

2 tasks

Copy link

netlifybot commentedAug 23, 2024•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`93505f5`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/66c8019f37aabc0008925e78
😎 Deploy Preview	https://deploy-preview-9868--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 100 (🟢 up 1 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 yourNetlify site configuration.

Copy link

nx-cloudbot commentedAug 23, 2024•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit93505f5. 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 2 targets

Sent with 💌 fromNxCloud.