docs: fill in most remaining rule option descriptions #9868
Conversation
|
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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 93505f5. 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 targetsSent with 💌 from NxCloud. |
| /** The expected assertion style to enforce. */ | ||
| assertionStyle: | ||
| | 'as' | ||
| /** The expected assertion style to enforce. */ | ||
| | 'angle-bracket'; |
5fd4251
into
typescript-eslint:main
PR Checklist
Overview
Adds
descriptionproperties 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.
💖