Add enforceAssignment and enforceSetterName options to `naming-co…
#1346
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
…nvention/use-state`
|
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 adds two new configuration options to the naming-convention/use-state rule to provide more flexibility in how the rule enforces useState hook usage patterns.
- Adds
enforceAssignmentoption (default:false) to control whether useState must be destructured into a value and setter pair - Adds
enforceSetterNameoption (default:true) to control whether the setter name must follow the symmetric naming convention - Updates documentation across multiple rule files to use a more consistent and structured format for describing rule options
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/plugins/eslint-plugin/README.md | Updates branch references in documentation links (contains issues with branch names) |
| packages/plugins/eslint-plugin-react-x/src/rules/no-useless-fragment.mdx | Restructures rule options documentation with clearer formatting and type definitions |
| packages/plugins/eslint-plugin-react-x/src/rules/no-unstable-default-props.mdx | Restructures rule options documentation with clearer formatting and type definitions |
| packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.ts | Implements the new enforceAssignment and enforceSetterName options with proper schema and default values |
| packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.spec.ts | Adds explicit options to test cases to properly test the new configuration options |
| packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.mdx | Documents the new rule options with clear descriptions and default values |
| packages/plugins/eslint-plugin-react-naming-convention/src/rules/filename.mdx | Restructures rule options documentation with clearer formatting and type definitions |
| packages/plugins/eslint-plugin-react-naming-convention/src/rules/filename-extension.mdx | Restructures rule options documentation with clearer formatting and type definitions |
| packages/plugins/eslint-plugin-react-naming-convention/src/rules/component-name.mdx | Restructures rule options documentation with clearer formatting and type definitions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
…nvention/use-state`
What kind of change does this PR introduce?
Does this PR introduce a breaking change?
Checklist
fix: remove a typo, closes #___, #___)Other information