gem-hunter
Language: TypeScript
Validate that your components can safely be updated with Fast Refresh
Validate that your components can safely be updated with Fast Refresh.
"Fast Refresh", also known as "hot reloading", is a feature in many modern bundlers. If you update some React component(s) on disk, then the bundler will know to update only the impacted parts of your page -- without a full page reload.
eslint-plugin-react-refresh enforces that your components are structured in a way that integrations such as react-refresh expect.
⚠️ To avoid false positives, by default this plugin is only applied on tsx & jsx files. See Options to run on JS files. ⚠️
The plugin relies on naming conventions (i.e. use PascalCase for components, camelCase for util functions). This is why there are some limitations:
export * are not supported and will be reported as an errorexport default function() {})const CMS = () => <></>; export { CMS })npm i -D eslint-plugin-react-refresh
This plugin provides a single rule, react-refresh/only-export-components. There are multiple ways to enable it.
import { defineConfig } from "eslint/config"; import { reactRefresh } from "eslint-plugin-react-refresh"; export default defineConfig( /* Main config */ reactRefresh.configs.recommended(), );
This enables the allowConstantExport and allowCompoundComponents options which are supported by Vite React plugins.
import { defineConfig } from "eslint/config"; import { reactRefresh } from "eslint-plugin-react-refresh"; export default defineConfig( /* Main config */ reactRefresh.configs.vite(), );
This allows exports like fetchCache and revalidate which are used in Page or Layout components and don't trigger a full page reload.
import { defineConfig } from "eslint/config"; import { reactRefresh } from "eslint-plugin-react-refresh"; export default defineConfig( /* Main config */ reactRefresh.configs.next(), );
import { defineConfig } from "eslint/config"; import { reactRefresh } from "eslint-plugin-react-refresh"; export default defineConfig({ // in main config for TSX/JSX source files plugins: { "react-refresh": reactRefresh.plugin, }, rules: { "react-refresh/only-export-components": "error", }, });
These examples are from enabling react-refresh/only-exports-components.
export const foo = () => {}; export const Bar = () => <></>;
export default function () {} export default compose()(MainComponent)
export * from "./foo";
const Tab = () => {}; export const tabs = [<Tab />, <Tab />];
const App = () => {}; createRoot(document.getElementById("root")).render(<App />);
export default function Foo() { return <></>; }
const foo = () => {}; export const Bar = () => <></>;
import { App } from "./App"; createRoot(document.getElementById("root")).render(<App />);
These options are all present on react-refresh/only-exports-components.
interface Options { extraHOCs?: string[]; allowExportNames?: string[]; allowConstantExport?: boolean; allowCompoundComponents?: boolean; checkJS?: boolean; } const defaultOptions: Options = { extraHOCs: [], allowExportNames: [], allowConstantExport: false, allowCompoundComponents: false, checkJS: false, };
If you're exporting components wrapped in non built-in React HOC (memo, forwardRef, lazy), you can use this option to avoid false positives.
{
"react-refresh/only-export-components": [
"error",
{ "extraHOCs": ["observer", "withAuth"] }
]
}Default:
[]
If you use a framework that handles HMR of some specific exports, you can use this option to avoid warning for them.
Example for Remix:
{
"react-refresh/only-export-components": [
"error",
{ "allowExportNames": ["meta", "links", "headers", "loader", "action"] }
]
}Default:
false(trueinviteconfig)
Don't warn when a constant (string, number, boolean, templateLiteral) is exported aside one or more components.
This should be enabled if the fast refresh implementation correctly handles this case (HMR when the constant doesn't change, propagate update to importers when the constant changes.). Vite supports it, PR welcome if you notice other integrations works well.
{
"react-refresh/only-export-components": [
"error",
{ "allowConstantExport": true }
]
}Enabling this option allows code such as the following:
export const CONSTANT = 3; export const Foo = () => <></>;
Default:
false(trueinviteconfig)
Don't warn when components are exported as an object gathering them. Every member of the object must be a component, and a member holding an anonymous function requires a component name as key.
This should be enabled if the fast refresh implementation correctly handles this case. Vite supports it since @vitejs/plugin-react 4.7.0, @vitejs/plugin-react-swc 3.11.0.
{
"react-refresh/only-export-components": [
"error",
{ "allowCompoundComponents": true }
]
}Enabling this option allows code such as the following:
const Root = () => <></>; const Label = () => <></>; export const Tag = { Root, Label };
Default:
false
If you're using JSX inside .js files (which I don't recommend because it forces you to configure every tool you use to switch the parser), you can still use the plugin by enabling this option. To reduce the number of false positive, only files importing react are checked.
{
"react-refresh/only-export-components": ["error", { "checkJS": true }]
}