Skip to content

refactor(naming-convention/use-state): enhance error messaging and docs, closes #980 #997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 19, 2025
Merged

refactor(naming-convention/use-state): enhance error messaging and docs, closes #980 #997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,12 @@ react-naming-convention/use-state

## Description

Enforces destructuring and symmetric naming of `useState` hook value and setter
Enforces destructuring and symmetric naming of `useState` hook value and setter.

This rule ensures two things:

1. The `useState` hook is destructured into a value and setter pair.
2. The value and setter are named symmetrically (e.g. `count` and `setCount`).

## Examples

Expand Down
38 changes: 31 additions & 7 deletions packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,30 @@ import rule, { RULE_NAME } from "./use-state";

ruleTester.run(RULE_NAME, rule, {
invalid: [
{
code: tsx`
function Component() {
useState(0);

return <div />;
}
`,
errors: [{
messageId: "missingDestructuring",
}],
},
{
code: tsx`
function Component() {
const data = useState(0);

return <div />;
}
`,
errors: [{
messageId: "missingDestructuring",
}],
},
{
code: tsx`
function Component() {
Expand All @@ -14,7 +38,7 @@ ruleTester.run(RULE_NAME, rule, {
}
`,
errors: [{
messageId: "invalid",
messageId: "invalidSetterNaming",
}],
},
{
Expand All @@ -26,7 +50,7 @@ ruleTester.run(RULE_NAME, rule, {
}
`,
errors: [{
messageId: "invalid",
messageId: "invalidSetterNaming",
}],
},
{
Expand All @@ -40,7 +64,7 @@ ruleTester.run(RULE_NAME, rule, {
}
`,
errors: [{
messageId: "invalid",
messageId: "invalidSetterNaming",
}],
},
{
Expand All @@ -54,7 +78,7 @@ ruleTester.run(RULE_NAME, rule, {
}
`,
errors: [{
messageId: "invalid",
messageId: "invalidSetterNaming",
}],
},
{
Expand All @@ -68,7 +92,7 @@ ruleTester.run(RULE_NAME, rule, {
}
`,
errors: [{
messageId: "invalid",
messageId: "invalidSetterNaming",
}],
},
{
Expand All @@ -82,7 +106,7 @@ ruleTester.run(RULE_NAME, rule, {
}
`,
errors: [{
messageId: "invalid",
messageId: "invalidSetterNaming",
}],
},
{
Expand All @@ -95,7 +119,7 @@ ruleTester.run(RULE_NAME, rule, {
}
`,
errors: [{
messageId: "invalid",
messageId: "invalidSetterNaming",
}],
},
],
Expand Down
18 changes: 11 additions & 7 deletions packages/plugins/eslint-plugin-react-naming-convention/src/rules/use-state.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const RULE_FEATURES = [
"CHK",
] as const satisfies RuleFeature[];

export type MessageID = "invalid";
export type MessageID = "missingDestructuring" | "invalidSetterNaming";

export default createRule<[], MessageID>({
meta: {
Expand All @@ -25,7 +25,10 @@ export default createRule<[], MessageID>({
[Symbol.for("rule_features")]: RULE_FEATURES,
},
messages: {
invalid: "An useState call is not destructured into value + setter pair.",
invalidSetterNaming:
"The setter should be named 'set' followed by the capitalized state variable name, e.g., 'setState' for 'state'.",
missingDestructuring:
"useState should be destructured into a value and setter pair, e.g., const [state, setState] = useState(...).",
},
schema: [],
},
Expand All @@ -38,23 +41,24 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
return {
"CallExpression[callee.name='useState']"(node: TSESTree.CallExpression) {
if (node.parent.type !== T.VariableDeclarator) {
context.report({ messageId: "invalid", node });
context.report({ messageId: "missingDestructuring", node });
return;
}
const id = getInstanceId(node);
if (id?.type !== T.ArrayPattern) {
context.report({ messageId: "invalid", node });
context.report({ messageId: "missingDestructuring", node });
return;
}
const [value, setter] = id.elements;
if (value == null || setter == null) {
context.report({ messageId: "invalid", node });
context.report({ messageId: "missingDestructuring", node });
return;
}
const setterName = match(setter)
.with({ type: T.Identifier }, (id) => id.name)
.otherwise(() => _);
if (setterName == null || !setterName.startsWith("set")) {
context.report({ messageId: "invalid", node });
context.report({ messageId: "invalidSetterNaming", node });
return;
}
const valueName = match(value)
Expand All @@ -70,7 +74,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
})
.otherwise(() => _);
if (valueName == null || `set_${valueName}` !== snakeCase(setterName)) {
context.report({ messageId: "invalid", node });
context.report({ messageId: "invalidSetterNaming", node });
return;
}
},
Expand Down