Skip to content

Commit 9a41390

Browse files
authored
refactor: improve rule description and error message (#1003)
1 parent a142617 commit 9a41390

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

apps/website/content/docs/rules/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Linter rules can have false positives, false negatives, and some rules are depen
115115
| [`no-direct-set-state-in-use-layout-effect`](./hooks-extra-no-direct-set-state-in-use-layout-effect) | 0️⃣ | Disallow direct calls to the `set` function of `useState` in `useLayoutEffect`. |
116116
| [`no-unnecessary-use-callback`](./hooks-extra-no-unnecessary-use-callback) | 0️⃣ | Disallow unnecessary usage of `useCallback`. |
117117
| [`no-unnecessary-use-memo`](./hooks-extra-no-unnecessary-use-memo) | 0️⃣ | Disallow unnecessary usage of `useMemo`. |
118-
| [`no-unnecessary-use-prefix`](./hooks-extra-no-unnecessary-use-prefix) | 1️⃣ | Enforces that a function with the `use` prefix should call at least one Hook inside of it. | |
118+
| [`no-unnecessary-use-prefix`](./hooks-extra-no-unnecessary-use-prefix) | 1️⃣ | Enforces that a function with the `use` prefix should use at least one Hook inside of it. |
119119
| [`prefer-use-state-lazy-initialization`](./hooks-extra-prefer-use-state-lazy-initialization) | 0️⃣ | Enforces function calls made inside `useState` to be wrapped in an `initializer function`. |
120120

121121
## Naming Convention Rules

packages/plugins/eslint-plugin-react-hooks-extra/src/rules/no-unnecessary-use-prefix.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,12 @@ export default createRule<[], MessageID>({
2626
meta: {
2727
type: "problem",
2828
docs: {
29-
description: "enforce custom Hooks to use at least one other hook inside",
29+
description: "enforce that a function with the 'use' prefix should use at least one Hook inside of it",
3030
[Symbol.for("rule_features")]: RULE_FEATURES,
3131
},
3232
messages: {
33-
noUnnecessaryUsePrefix: "A custom Hook '{{name}}' should use at least one other hook.",
33+
noUnnecessaryUsePrefix:
34+
"If your function doesn't call any Hooks, avoid the 'use' prefix. Instead, write it as a regular function without the 'use' prefix.",
3435
},
3536
schema: [],
3637
},

0 commit comments

Comments
 (0)