Deprecate react-x/no-forbidden-props rule
#1304
Merged
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Rel1cx
changed the title
no-forbidden-props rulereact-x/no-forbidden-props rule
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates the no-forbidden-props rule in eslint-plugin-react-x. The rule is being deprecated because AST-based component props restrictions can be easily bypassed and the rule is not significantly more effective than using no-restricted-syntax. The recommendation is to use static type checking instead.
- Marks the rule as deprecated in the rule metadata
- Adds deprecation notice to the rule documentation
- Removes the rule from the active rules overview table
- Adds an entry to the removed rules documentation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/plugins/eslint-plugin-react-x/src/rules/no-forbidden-props.ts | Adds deprecated: true to the rule's meta configuration |
| packages/plugins/eslint-plugin-react-x/src/rules/no-forbidden-props.mdx | Adds a warning callout explaining the deprecation rationale |
| apps/website/content/docs/rules/overview.mdx | Removes the rule from the active rules table |
| apps/website/content/docs/removed.mdx | Adds the rule to the removed/deprecated rules list |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Rel1cx
force-pushed
the
deprecate-no-forbidden-props
branch
from
054a365 to
270e6c9
Compare
1 task
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