-
-
Notifications
You must be signed in to change notification settings - Fork 101
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Hare Prananda
committed
Jul 30, 2023
1 parent
7aebc03
commit 87362b4
Showing
1 changed file
with
5 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,128 +1,13 @@ | ||
| # @vitejs/plugin-react [](https://npmjs.com/package/@vitejs/plugin-react) | ||
| # Vite Plugin React Class HMR Fix | ||
|
|
||
| The default Vite plugin for React projects. | ||
| Forked from https://github.com/vitejs/vite-plugin-react | ||
|
|
||
| - enable [Fast Refresh](https://www.npmjs.com/package/react-refresh) in development | ||
| - use the [automatic JSX runtime](https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html) | ||
| - use custom Babel plugins/presets | ||
| - small installation size | ||
|
|
||
| ```js | ||
| // vite.config.js | ||
| import { defineConfig } from 'vite' | ||
| import react from '@vitejs/plugin-react' | ||
|
|
||
| export default defineConfig({ | ||
| plugins: [react()], | ||
| }) | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ### include/exclude | ||
|
|
||
| Includes `.js`, `.jsx`, `.ts` & `.tsx` by default. This option can be used to add fast refresh to `.mdx` files: | ||
|
|
||
| ```js | ||
| import { defineConfig } from 'vite' | ||
| import react from '@vitejs/plugin-react' | ||
| import mdx from '@mdx-js/rollup' | ||
|
|
||
| export default defineConfig({ | ||
| plugins: [ | ||
| { enforce: 'pre', ...mdx() }, | ||
| react({ include: /\.(mdx|js|jsx|ts|tsx)$/ }), | ||
| ], | ||
| }) | ||
| ``` | ||
|
|
||
| > `node_modules` are never processed by this plugin (but esbuild will) | ||
| ### jsxImportSource | ||
|
|
||
| Control where the JSX factory is imported from. Default to `'react'` | ||
|
|
||
| ```js | ||
| react({ jsxImportSource: '@emotion/react' }) | ||
| ``` | ||
|
|
||
| ## jsxRuntime | ||
|
|
||
| By default, the plugin uses the [automatic JSX runtime](https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html). However, if you encounter any issues, you may opt out using the `jsxRuntime` option. | ||
|
|
||
| ```js | ||
| react({ jsxRuntime: 'classic' }) | ||
| ``` | ||
|
|
||
| ### babel | ||
|
|
||
| The `babel` option lets you add plugins, presets, and [other configuration](https://babeljs.io/docs/en/options) to the Babel transformation performed on each included file. | ||
|
|
||
| ```js | ||
| react({ | ||
| babel: { | ||
| presets: [...], | ||
| // Your plugins run before any built-in transform (eg: Fast Refresh) | ||
| plugins: [...], | ||
| // Use .babelrc files | ||
| babelrc: true, | ||
| // Use babel.config.js files | ||
| configFile: true, | ||
| } | ||
| }) | ||
| ``` | ||
|
|
||
| Note: When not using plugins, only esbuild is used for production builds, resulting in faster builds. | ||
|
|
||
| #### Proposed syntax | ||
|
|
||
| If you are using ES syntax that are still in proposal status (e.g. class properties), you can selectively enable them with the `babel.parserOpts.plugins` option: | ||
|
|
||
| ```js | ||
| react({ | ||
| babel: { | ||
| parserOpts: { | ||
| plugins: ['decorators-legacy'], | ||
| }, | ||
| }, | ||
| }) | ||
| npm install @hareprnd/vite-plugin-react | ||
| ``` | ||
|
|
||
| This option does not enable _code transformation_. That is handled by esbuild. | ||
|
|
||
| **Note:** TypeScript syntax is handled automatically. | ||
|
|
||
| Here's the [complete list of Babel parser plugins](https://babeljs.io/docs/en/babel-parser#ecmascript-proposalshttpsgithubcombabelproposals). | ||
|
|
||
| ## Middleware mode | ||
|
|
||
| In [middleware mode](https://vitejs.dev/config/server-options.html#server-middlewaremode), you should make sure your entry `index.html` file is transformed by Vite. Here's an example for an Express server: | ||
|
|
||
| ```js | ||
| app.get('/', async (req, res, next) => { | ||
| try { | ||
| let html = fs.readFileSync(path.resolve(root, 'index.html'), 'utf-8') | ||
|
|
||
| // Transform HTML using Vite plugins. | ||
| html = await viteServer.transformIndexHtml(req.url, html) | ||
|
|
||
| res.send(html) | ||
| } catch (e) { | ||
| return next(e) | ||
| } | ||
| }) | ||
| ``` | ||
|
|
||
| Otherwise, you'll probably get this error: | ||
| or | ||
|
|
||
| ``` | ||
| Uncaught Error: @vitejs/plugin-react can't detect preamble. Something is wrong. | ||
| yarn add @hareprnd/vite-plugin-react | ||
| ``` | ||
|
|
||
| ## Consistent components exports | ||
|
|
||
| For React refresh to work correctly, your file should only export React components. You can find a good explanation in the [Gatsby docs](https://www.gatsbyjs.com/docs/reference/local-development/fast-refresh/#how-it-works). | ||
|
|
||
| If an incompatible change in exports is found, the module will be invalidated and HMR will propagate. To make it easier to export simple constants alongside your component, the module is only invalidated when their value changes. | ||
|
|
||
| You can catch mistakes and get more detailed warning with this [eslint rule](https://github.com/ArnaudBarre/eslint-plugin-react-refresh). |