Skip to content

Report React context exports #54

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 2 commits into from
Oct 21, 2024
Merged

Report React context exports #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e74c13b
Report React context exports
Oct 21, 2024
3fbb451
Fix typo
IgorAufricht Oct 21, 2024
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
17 changes: 17 additions & 0 deletions src/only-export-components.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,18 @@ const valid = [
name: "Allow connect from react-redux",
code: "const MyComponent = () => {}; export default connect(() => ({}))(MyComponent);",
},
{
name: "Two components, one of them with 'Context' in its name",
code: "export const MyComponent = () => {}; export const ChatContext = () => {};",
},
{
name: "Component & local React context",
code: "export const MyComponent = () => {}; const MyContext = createContext('test');",
},
{
name: "Only React context",
code: "export const MyContext = createContext('test');",
},
];

const invalid = [
Expand Down Expand Up @@ -273,6 +285,11 @@ const invalid = [
code: 'const Foo = () => {}; export { Foo as "🍌"}',
errorId: "localComponents",
},
{
name: "Component and React Context",
code: "export const MyComponent = () => {}; export const MyContext = createContext('test');",
errorId: "reactContext",
},
];

const it = (name: string, cases: Parameters<typeof ruleTester.run>[2]) => {
Expand Down
20 changes: 18 additions & 2 deletions src/only-export-components.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ export const onlyExportComponents: TSESLint.RuleModule<
| "namedExport"
| "anonymousExport"
| "noExport"
| "localComponents",
| "localComponents"
| "reactContext",
| []
| [
{
Expand All @@ -35,6 +36,8 @@ export const onlyExportComponents: TSESLint.RuleModule<
"Fast refresh only works when a file only exports components. Move your component(s) to a separate file.",
noExport:
"Fast refresh only works when a file has exports. Move your component(s) to a separate file.",
reactContext:
"Fast refresh only works when a file only exports components. Move your React context(s) to a separate file.",
},
type: "problem",
schema: [
Expand All @@ -56,7 +59,7 @@ export const onlyExportComponents: TSESLint.RuleModule<
checkJS = false,
allowExportNames,
} = context.options[0] ?? {};
const filename = context.getFilename();
const filename = context.filename;
// Skip tests & stories files
if (
filename.includes(".test.") ||
Expand Down Expand Up @@ -86,6 +89,7 @@ export const onlyExportComponents: TSESLint.RuleModule<
| TSESTree.BindingName
| TSESTree.StringLiteral
)[] = [];
const reactContextExports: TSESTree.Identifier[] = [];

const handleLocalIdentifier = (
identifierNode: TSESTree.BindingName,
Expand Down Expand Up @@ -124,6 +128,15 @@ export const onlyExportComponents: TSESLint.RuleModule<
nonComponentExports.push(identifierNode);
}
} else {
if (
init &&
init.type === "CallExpression" &&
init.callee.type === "Identifier" &&
init.callee.name === "createContext"
) {
reactContextExports.push(identifierNode);
return;
}
if (
init &&
// Switch to allowList?
Expand Down Expand Up @@ -263,6 +276,9 @@ export const onlyExportComponents: TSESLint.RuleModule<
for (const node of nonComponentExports) {
context.report({ messageId: "namedExport", node });
}
for (const node of reactContextExports) {
context.report({ messageId: "reactContext", node });
}
} else if (localComponents.length) {
for (const node of localComponents) {
context.report({ messageId: "localComponents", node });
Expand Down