chore(website): link every rule doc to the playground with default config #6317
Conversation
This change includes a link in every rule doc to the playground, clicking on the link opens the playground with default config for the rule already loaded typescript-eslint#6085
|
Thanks for the PR, @mhnaeem! 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 settings. |
There was a problem hiding this comment.
Looks great, thanks for sending this in @mhnaeem! ✨ Just left a few comments for your review. Let us know what you think & we can get this merged.
… pr changes Changes: 1) Renamed functions and variables to use full work string instead of str 2) Added jsdoc with better explanation for functions 3) Created a new MDXComponent for try in playground link 4) Some formatting and text fixes typescript-eslint#6085
|
@JoshuaKGoldberg Thank you for your input, I have made all the requested changes. Let me know if something else could be improved. |
There was a problem hiding this comment.
Looks great, thanks for sending this in @mhnaeem! I'll apply a couple of touchups now and ship. 🔥
|
|
PR Checklist
Overview
This change includes a link in every rule doc to the playground, clicking on the link opens the playground with default config for the rule already loaded.
The plugin responsible for generating/modifying the rules doc was edited to add a single link referencing to the playground with the default config hashed.