Skip to content
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

Add createContextMethods option #55

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add createContextMethods option #55

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8847475
Add createContextMethods option
SeokminHong Oct 25, 2024
91ce6e0
Add README for createContextMethods
SeokminHong Oct 25, 2024
d598307
Use just array
SeokminHong Nov 2, 2024
6f1cdd9
Format
SeokminHong Nov 2, 2024
d116ea6
Apply comments
SeokminHong Nov 2, 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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,3 +140,22 @@ If your using JSX inside `.js` files (which I don't recommend because it forces
"react-refresh/only-export-components": ["warn", { "checkJS": true }]
}
```

### createContextMethods

The `createContextMethods` option allows you to specify custom context-creating functions for detection by the rule. By default, it only detects `createContext`, but you can add methods like `createMyContext` in your configuration.

```json
{
"react-refresh/only-export-components": [
"error",
{ "createContextMethods": ["createMyContext"] }
]
}
```

```jsx
export const MyComponent = () => <div />;
// ESLint error
export const MyContext = createMyContext();
```
25 changes: 25 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 @@ -189,6 +189,21 @@ const valid = [
name: "Only React context",
code: "export const MyContext = createContext('test');",
},
{
name: "Component and local React Context from other module",
code: "export const MyComponent = () => {}; const MyContext = createMyContext('test');",
errorId: "reactContext",
options: [
{
createContextMethods: ["createMyContext"],
},
],
},
ArnaudBarre marked this conversation as resolved.
Show resolved Hide resolved
{
name: "Component and React Context from other module without options",
code: "export const MyComponent = () => {}; export const MyContext = createMyContext('test');",
errorId: "reactContext",
ArnaudBarre marked this conversation as resolved.
Show resolved Hide resolved
},
];

const invalid = [
Expand Down Expand Up @@ -295,6 +310,16 @@ const invalid = [
code: "export const MyComponent = () => {}; export const MyContext = React.createContext('test');",
errorId: "reactContext",
},
{
name: "Component and React Context from other module",
code: "export const MyComponent = () => {}; export const MyContext = createMyContext('test');",
errorId: "reactContext",
options: [
{
createContextMethods: ["createMyContext"],
},
SeokminHong marked this conversation as resolved.
Show resolved Hide resolved
],
},
];

const it = (name: string, cases: Parameters<typeof ruleTester.run>[2]) => {
Expand Down
12 changes: 10 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 @@ -21,6 +21,7 @@ export const onlyExportComponents: TSESLint.RuleModule<
allowConstantExport?: boolean;
checkJS?: boolean;
allowExportNames?: string[];
createContextMethods?: string[];
},
]
> = {
Expand All @@ -47,6 +48,7 @@ export const onlyExportComponents: TSESLint.RuleModule<
allowConstantExport: { type: "boolean" },
checkJS: { type: "boolean" },
allowExportNames: { type: "array", items: { type: "string" } },
createContextMethods: { type: "array", items: { type: "string" } },
},
additionalProperties: false,
},
Expand All @@ -58,6 +60,7 @@ export const onlyExportComponents: TSESLint.RuleModule<
allowConstantExport = false,
checkJS = false,
allowExportNames,
createContextMethods = [],
} = context.options[0] ?? {};
const filename = context.filename;
// Skip tests & stories files
Expand All @@ -79,6 +82,11 @@ export const onlyExportComponents: TSESLint.RuleModule<
? new Set(allowExportNames)
: undefined;

const createContextMethodsSet = new Set([
...createContextMethods,
"createContext",
]);
SeokminHong marked this conversation as resolved.
Show resolved Hide resolved

return {
Program(program) {
let hasExports = false;
Expand Down Expand Up @@ -133,10 +141,10 @@ export const onlyExportComponents: TSESLint.RuleModule<
init.type === "CallExpression" &&
// createContext || React.createContext
((init.callee.type === "Identifier" &&
init.callee.name === "createContext") ||
createContextMethodsSet.has(init.callee.name)) ||
(init.callee.type === "MemberExpression" &&
init.callee.property.type === "Identifier" &&
init.callee.property.name === "createContext"))
createContextMethodsSet.has(init.callee.property.name)))
) {
reactContextExports.push(identifierNode);
return;
Expand Down