diff --git a/README.md b/README.md index a90f92d..2df0a8e 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ npm create electron-vite ```tree ├── electron Electron-related code │ ├── main Main-process source code -│ ├── preload Preload-script source code +│ ├── preload Preload-scripts source code │ └── resources Resources for the production build │ ├── icon.icns Icon for the application on macOS │ ├── icon.ico Icon for the application @@ -52,28 +52,20 @@ npm create electron-vite └── src Renderer source code, your React application ``` -## 🚨 `dependencies` vs `devDependencies` +## 🚨 Be aware -**Put Node.js packages in `dependencies`** +By default, this template integrates Node.js in the Renderer process. If you don't need it, you just remove the option below. [Because it will modify the default config of Vite](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#config-presets-opinionated). -**e.g.** `electron-store` `sqlite3` `serilaport` `mongodb` ...others +```diff +# vite.config.ts -**Put Web packages in `devDependencies`** +electron({ +- renderer: {} +}) +``` -**e.g.** `react` `react-dom` `react-router` `mobx` `zustand` `antd` `axios` ...others +## FAQ -See more 👉 [dependencies vs devDependencies](https://github.com/electron-vite/vite-plugin-electron-renderer#dependencies-vs-devdependencies) - -## 🚨 Node.js ESM packages - -**e.g.** `node-fetch` `execa` `got` ... - -[👉 Using Node.js ESM packages in Electron-Renderer](https://github.com/electron-vite/vite-plugin-electron-renderer#-nodejs-esm-packages) - - +- [dependencies vs devDependencies](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#dependencies-vs-devdependencies) +- [Using C/C++ native addons in Electron-Renderer](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#load-nodejs-cc-native-modules) +- [Node.js ESM packages](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#nodejs-esm-packages) (e.g. `execa` `node-fetch`) diff --git a/README.zh-CN.md b/README.zh-CN.md index d7c196e..dd30b6d 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -11,7 +11,7 @@ ## 概述 📦 开箱即用 -🎯 基于 [react-ts](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) 模板, 低侵入性 +🎯 基于官方的 [react-ts](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) 模板, 低侵入性 🌱 结构清晰,可塑性强 💪 支持在渲染进程中使用 Electron、Node.js API 🔩 支持 C/C++ 模块 @@ -36,7 +36,7 @@ npm create electron-vite ```tree ├── electron Electron 源码文件夹 │ ├── main Main-process 源码 -│ ├── preload Preload-script 源码 +│ ├── preload Preload-scripts 源码 │ └── resources 应用打包的资源文件夹 │ ├── icon.icns 应用图标(macOS) │ ├── icon.ico 应用图标 @@ -52,33 +52,21 @@ npm create electron-vite └── src 渲染进程源码、React代码 ``` -## 🚨 依赖放到 dependencies 还是 devDependencies -**Node.js 包放到 `dependencies` 中** +## 🚨 这需要留神 -**e.g.** `electron-store` `sqlite3` `serilaport` `mongodb` ...others +默认情况下,该模板在渲染进程中集成了 Node.js,如果你不需要它,你只需要删除下面的选项. [因为它会修改 Vite 默认的配置](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#config-presets-opinionated). -**Web 包放到 in `devDependencies` 中** +```diff +# vite.config.ts -**e.g.** `react` `react-dom` `react-router` `mobx` `zustand` `antd` `axios` ...others +electron({ +- renderer: {} +}) +``` -看看这 👉 [dependencies vs devDependencies](https://github.com/electron-vite/vite-plugin-electron-renderer#dependencies-vs-devdependencies) +## FAQ - -## 🚨 Node.js ESM packages - -**e.g.** `node-fetch` `execa` `got` ... - -[👉 在 Electron-Renderer 中使用 Node.js ESM 包](https://github.com/electron-vite/vite-plugin-electron-renderer#-nodejs-esm-packages) - - +- [dependencies vs devDependencies](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#dependencies-vs-devdependencies) +- [Using C/C++ native addons in Electron-Renderer](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#load-nodejs-cc-native-modules) +- [Node.js ESM packages](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#nodejs-esm-packages) (e.g. `execa` `node-fetch`) diff --git a/package.json b/package.json index 15fa70d..723013e 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "sass": "^1.53.0", "typescript": "^4.7.4", "vite": "^2.9.14", - "vite-plugin-electron": "^0.7.5" + "vite-plugin-electron": "^0.8.0" }, "env": { "VITE_DEV_SERVER_HOST": "127.0.0.1",