Fix sub-plugin's READMEs - #1465
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the README documentation across multiple ESLint React sub-plugins to improve consistency and clarity. The changes standardize the setup examples by converting them from JavaScript to TypeScript, using shorter import names, and adding clarifying comments about configuration order.
Changes:
- Changed code block language from
jstotsfor all plugin setup examples - Simplified import variable names (e.g.,
reactWebApi→webApi,reactDom→dom) - Added inline comments explaining that plugin configs should be placed after js/tseslint configs
- Removed obsolete
pluginssection from react-naming-convention README
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/plugins/eslint-plugin-react-x/README.md | Updated setup example to TypeScript with clarifying comment about config order |
| packages/plugins/eslint-plugin-react-web-api/README.md | Changed to TypeScript, simplified import name, and added config order comment |
| packages/plugins/eslint-plugin-react-rsc/README.md | Fixed incorrect import (was importing react-x), changed to TypeScript, added comment |
| packages/plugins/eslint-plugin-react-naming-convention/README.md | Changed to TypeScript, simplified import name, removed obsolete plugins section |
| packages/plugins/eslint-plugin-react-hooks-extra/README.md | Updated to TypeScript with shorter import name and config order comment |
| packages/plugins/eslint-plugin-react-dom/README.md | Converted to TypeScript, simplified import, added config order comment |
| packages/plugins/eslint-plugin-react-debug/README.md | Changed to TypeScript with shorter import name and clarifying comment |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: REL1CX <solarflamex@hotmail.com>
This was referenced Feb 3, 2026
Rel1cx
added a commit
that referenced
this pull request
May 15, 2026
Signed-off-by: REL1CX <solarflamex@hotmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Does this PR introduce a breaking change?
Checklist
fix: remove a typo, closes #___, #___)Other information