Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
eslint-plugin-react-refresh
Advanced tools
Validate that your components can safely be updated with fast refresh
Validate that your components can safely be updated with fast refresh.
⚠️ To avoid false positive, by default this plugin is only applied on tsx
& jsx
files. See options to run on JS files. ⚠️
The plugin rely 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
{
"plugins": ["react-refresh"],
"rules": {
"react-refresh/only-export-components": "warn"
}
}
import reactRefresh from "eslint-plugin-react-refresh";
export default [
{
// in main config for TSX/JSX source files
plugins: {
"react-refresh": reactRefresh,
},
rules: {
"react-refresh/only-export-components": "warn",
},
},
];
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 const CONSTANT = 3;
export const Foo = () => <></>;
export default function Foo() {
return <></>;
}
const foo = () => {};
export const Bar = () => <></>;
import { App } from "./App";
createRoot(document.getElementById("root")).render(<App />);
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": [
"warn",
{ "allowExportNames": ["meta", "links", "headers", "loader", "action"] }
]
}
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": [
"warn",
{ "allowConstantExport": true }
]
}
If your 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": ["warn", { "checkJS": true }]
}
0.4.6
FAQs
Validate that your components can safely be updated with fast refresh
The npm package eslint-plugin-react-refresh receives a total of 1,258,965 weekly downloads. As such, eslint-plugin-react-refresh popularity was classified as popular.
We found that eslint-plugin-react-refresh demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.