Skip to content

refactor: improve error messages #937

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 6 commits into from
Feb 10, 2025
Merged

refactor: improve error messages #937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dee97c8
refactor: improve error messages
Rel1cx Feb 10, 2025
188d83c
release: 1.26.3-next.7
Rel1cx Feb 10, 2025
a9ef399
release: 1.26.3-beta.7
Rel1cx Feb 10, 2025
11cbff8
refactor(website): improve home page
Rel1cx Feb 10, 2025
fe3f58e
refactor: improve error messages
Rel1cx Feb 10, 2025
5dd8358
Merge branch 'main' into error-messages
Rel1cx Feb 10, 2025
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
14 changes: 7 additions & 7 deletions packages/plugins/eslint-plugin-react-naming-convention/src/rules/filename.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ruleTester.run(RULE_NAME, rule, {
code,
errors: [
{
messageId: "filenameCaseMismatchSuggestion",
messageId: "filenameCaseMismatch",
data: {
name: "PascalCase.tsx",
rule: "kebab-case",
Expand All @@ -24,7 +24,7 @@ ruleTester.run(RULE_NAME, rule, {
code,
errors: [
{
messageId: "filenameCaseMismatchSuggestion",
messageId: "filenameCaseMismatch",
data: {
name: "camelCase.tsx",
rule: "PascalCase",
Expand All @@ -39,7 +39,7 @@ ruleTester.run(RULE_NAME, rule, {
code,
errors: [
{
messageId: "filenameCaseMismatchSuggestion",
messageId: "filenameCaseMismatch",
data: {
name: "kebab-case.tsx",
rule: "PascalCase",
Expand All @@ -54,7 +54,7 @@ ruleTester.run(RULE_NAME, rule, {
code,
errors: [
{
messageId: "filenameCaseMismatchSuggestion",
messageId: "filenameCaseMismatch",
data: {
name: "snake_case.tsx",
rule: "PascalCase",
Expand All @@ -69,7 +69,7 @@ ruleTester.run(RULE_NAME, rule, {
code,
errors: [
{
messageId: "filenameCaseMismatchSuggestion",
messageId: "filenameCaseMismatch",
data: {
name: "PascalCase.tsx",
rule: "camelCase",
Expand All @@ -84,7 +84,7 @@ ruleTester.run(RULE_NAME, rule, {
code,
errors: [
{
messageId: "filenameCaseMismatchSuggestion",
messageId: "filenameCaseMismatch",
data: {
name: "kebab-case.tsx",
rule: "camelCase",
Expand All @@ -99,7 +99,7 @@ ruleTester.run(RULE_NAME, rule, {
code,
errors: [
{
messageId: "filenameCaseMismatchSuggestion",
messageId: "filenameCaseMismatch",
data: {
name: "snake_case.tsx",
rule: "camelCase",
Expand Down
9 changes: 3 additions & 6 deletions packages/plugins/eslint-plugin-react-naming-convention/src/rules/filename.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ export const RULE_FEATURES = [
] as const satisfies RuleFeature[];

export type MessageID =
// | "filenameCaseMismatch"
| "filenameCaseMismatchSuggestion"
| "filenameCaseMismatch"
| "filenameEmpty";

type Case = "camelCase" | "kebab-case" | "PascalCase" | "snake_case";
Expand Down Expand Up @@ -86,9 +85,7 @@ export default createRule<Options, MessageID>({
description: "enforce naming convention for JSX filenames",
},
messages: {
// filenameCaseMismatch: "A file with name '{{name}}' does not match {{rule}}.",
filenameCaseMismatchSuggestion:
"A file with name '{{name}}' does not match {{rule}}. Should rename to '{{suggestion}}'.",
filenameCaseMismatch: "A file with name '{{name}}' does not match {{rule}}. Should rename to '{{suggestion}}'.",
filenameEmpty: "A file must have non-empty name.",
},
schema,
Expand Down Expand Up @@ -138,7 +135,7 @@ export default createRule<Options, MessageID>({
return;
}
context.report({
messageId: "filenameCaseMismatchSuggestion",
messageId: "filenameCaseMismatch",
node,
data: {
name: context.filename,
Expand Down
56 changes: 28 additions & 28 deletions packages/plugins/eslint-plugin-react-x/src/rules/no-missing-key.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,73 +5,73 @@ ruleTester.run(RULE_NAME, rule, {
invalid: [
{
code: /* tsx */ `[<App />];`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `[<App {...key} />];`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `[<App key={0}/>, <App />];`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `[1, 2 ,3].map(function(x) { return <App /> });`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `[1, 2 ,3].map(x => <App />);`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `[1, 2 ,3].map(x => x && <App x={x} />);`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: '[1, 2 ,3].map(x => x ? <App x={x} key="1" /> : <OtherApp x={x} />);',
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: '[1, 2 ,3].map(x => x ? <App x={x} /> : <OtherApp x={x} key="2" />);',
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `[1, 2 ,3].map(x => { return <App /> });`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `Array.from([1, 2 ,3], function(x) { return <App /> });`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `Array.from([1, 2 ,3], (x => { return <App /> }));`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `Array.from([1, 2 ,3], (x => <App />));`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `[1, 2, 3]?.map(x => <BabelEslintApp />)`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `[1, 2, 3]?.map(x => <TypescriptEslintApp />)`,
errors: [{ messageId: "noMissingKey" }],
errors: [{ messageId: "missingKey" }],
},
{
code: /* tsx */ `[1, 2, 3].map(x => <>{x}</>);`,
errors: [
{
messageId: "noMissingKeyWithFragment",
messageId: "unexpectedFragmentSyntax",
},
],
},
{
code: /* tsx */ `[<></>];`,
errors: [
{
messageId: "noMissingKeyWithFragment",
messageId: "unexpectedFragmentSyntax",
},
],
},
Expand All @@ -94,8 +94,8 @@ ruleTester.run(RULE_NAME, rule, {
};
`,
errors: [
{ messageId: "noMissingKey" },
{ messageId: "noMissingKey" },
{ messageId: "missingKey" },
{ messageId: "missingKey" },
],
},
{
Expand All @@ -121,10 +121,10 @@ ruleTester.run(RULE_NAME, rule, {
};
`,
errors: [
{ messageId: "noMissingKey" },
{ messageId: "noMissingKey" },
{ messageId: "noMissingKey" },
{ messageId: "noMissingKey" },
{ messageId: "missingKey" },
{ messageId: "missingKey" },
{ messageId: "missingKey" },
{ messageId: "missingKey" },
],
},
{
Expand All @@ -144,9 +144,9 @@ ruleTester.run(RULE_NAME, rule, {
};
`,
errors: [
{ messageId: "noMissingKey" },
{ messageId: "noMissingKey" },
{ messageId: "noMissingKey" },
{ messageId: "missingKey" },
{ messageId: "missingKey" },
{ messageId: "missingKey" },
],
},
{
Expand Down Expand Up @@ -176,13 +176,13 @@ ruleTester.run(RULE_NAME, rule, {
`,
errors: [
{
messageId: "noMissingKeyWithFragment",
messageId: "unexpectedFragmentSyntax",
},
{
messageId: "noMissingKey",
messageId: "missingKey",
},
{
messageId: "noMissingKeyWithFragment",
messageId: "unexpectedFragmentSyntax",
},
],
},
Expand Down
16 changes: 8 additions & 8 deletions packages/plugins/eslint-plugin-react-x/src/rules/no-missing-key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ export const RULE_FEATURES = [
] as const satisfies RuleFeature[];

export type MessageID =
| "noMissingKey"
| "noMissingKeyWithFragment";
| "missingKey"
| "unexpectedFragmentSyntax";

export default createRule<[], MessageID>({
meta: {
Expand All @@ -26,8 +26,8 @@ export default createRule<[], MessageID>({
[Symbol.for("rule_features")]: RULE_FEATURES,
},
messages: {
noMissingKey: "Missing 'key' for element when rendering list.",
noMissingKeyWithFragment: "Use fragment component instead of '<>' because it does not support `key`.",
missingKey: "Missing 'key' for element when rendering list.",
unexpectedFragmentSyntax: "Use fragment component instead of '<>' because it does not support `key`.",
},
schema: [],
},
Expand All @@ -40,15 +40,15 @@ export default createRule<[], MessageID>({
const initialScope = context.sourceCode.getScope(node);
if (!JSX.hasAttribute("key", node.openingElement.attributes, initialScope)) {
return {
messageId: "noMissingKey",
messageId: "missingKey",
node,
} as const;
}
return null;
}
case T.JSXFragment: {
return {
messageId: "noMissingKeyWithFragment",
messageId: "unexpectedFragmentSyntax",
node,
} as const;
}
Expand Down Expand Up @@ -104,7 +104,7 @@ export default createRule<[], MessageID>({
for (const element of elements) {
if (!JSX.hasAttribute("key", element.openingElement.attributes, initialScope)) {
context.report({
messageId: "noMissingKey",
messageId: "missingKey",
node: element,
});
}
Expand Down Expand Up @@ -146,7 +146,7 @@ export default createRule<[], MessageID>({
}
if (node.parent.type === T.ArrayExpression) {
context.report({
messageId: "noMissingKeyWithFragment",
messageId: "unexpectedFragmentSyntax",
node,
});
}
Expand Down
32 changes: 27 additions & 5 deletions packages/plugins/eslint-plugin-react-x/src/rules/no-unstable-context-value.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ ruleTester.run(RULE_NAME, rule, {
return <Context.Provider value={foo}></Context.Provider>;
}
`,
errors: [{ messageId: "noUnstableContextValueWithIdentifier" }],
errors: [{
messageId: "unstableContextValue",
data: {
type: "object expression",
suggestion: "Consider wrapping it in a useMemo hook.",
},
}],
},
{
code: /* tsx */ `
Expand All @@ -21,7 +27,11 @@ ruleTester.run(RULE_NAME, rule, {
`,
errors: [
{
messageId: "noUnstableContextValueWithIdentifier",
messageId: "unstableContextValue",
data: {
type: "array expression",
suggestion: "Consider wrapping it in a useMemo hook.",
},
},
],
},
Expand All @@ -34,7 +44,11 @@ ruleTester.run(RULE_NAME, rule, {
`,
errors: [
{
messageId: "noUnstableContextValueWithIdentifier",
messageId: "unstableContextValue",
data: {
type: "new expression",
suggestion: "Consider wrapping it in a useMemo hook.",
},
},
],
},
Expand All @@ -47,7 +61,11 @@ ruleTester.run(RULE_NAME, rule, {
`,
errors: [
{
messageId: "noUnstableContextValueWithFunction",
messageId: "unstableContextValue",
data: {
type: "arrow function expression",
suggestion: "Consider wrapping it in a useCallback hook.",
},
},
],
},
Expand All @@ -62,7 +80,11 @@ ruleTester.run(RULE_NAME, rule, {
`,
errors: [
{
messageId: "noUnstableContextValueWithIdentifier",
messageId: "unstableContextValue",
data: {
type: "object expression",
suggestion: "Consider wrapping it in a useMemo hook.",
},
},
],
},
Expand Down
Loading