devathimahesh/vite-plugin-swc-react-refresh

Use the versatility of swc for development and the maturity of esbuild for production

vite-plugin-swc-react-refresh

Use the versatility of SWC for development and the maturity of esbuild for production.

• ✅ A fast Fast Refresh (~20x faster than Babel)
• ✅ Compatible with automatic JSX runtime
• ❌ Don't check for consistent components exports. See this section

Installation

npm i -D vite-plugin-swc-react-refresh

Usage

With the automatic JSX runtime (requires esbuild => 0.14.51):

import { defineConfig } from "vite";
import { swcReactRefresh } from "vite-plugin-swc-react-refresh";

export default defineConfig({
  plugins: [swcReactRefresh()],
  esbuild: { jsx: "automatic" },
});

Without the automatic JSX runtime, but still omitting the React default import:

import { defineConfig } from "vite";
import { swcReactRefresh } from "vite-plugin-swc-react-refresh";

export default defineConfig({
  plugins: [swcReactRefresh()],
  esbuild: { jsxInject: `import React from "react"` },
});

Consistent components exports

For React refresh to work, your file should only export React components. The best explanation I've read is the one from the Gatsby docs.

However, having some components being hot updated and not others is a very frustrating experience as a developer, and I think this rule should be enforced by a linter, so I made an eslint rule to go along with this plugin.

This plugin expects this rule to be respected and will always fast refresh components. If a file export something that is not a React component (TS types are ok), update to this export would not propagate and require a manual reload.