Merge pull request #4 from electron-vite/v0.5.3

V0.5.3

Author: caoxiemeihao

CHANGELOG.md

@@ -1,4 +1,11 @@
 
+## [2022-07-07] v0.5.3
+
+- 69eb531 docs: v0.5.3
+- cc98ed9 feat: `ResolveModules['options']`  optional
+- db03a72 chore: remove `useNodeJs.default = useNodeJs`
+- c30dc1b fix(🐞): add `electron` to ` builtins
+
 ## [2022-07-07] v0.5.2
 
 - 9dd8d4c feat: export `resolveModules()`

README.md

@@ -66,6 +66,7 @@ By default, `vite-plugin-electron-renderer` treats packages in `dependencies`(CJ
 
 **e.g.**
 
+<!--
 ###### Electron-Main
 
 ```js
@@ -75,6 +76,7 @@ import { ipcRenderer } from 'electron'
 const { readFile } = require('fs')
 const { ipcRenderer } = require('electron')
 ```
+-->
 
 ###### Electron-Renderer(vite build)
 
@@ -121,41 +123,31 @@ import { ipcRenderer } from 'electron'
 import { ipcRenderer } from 'vite-plugin-electron-renderer/plugins/use-node.js/electron-renderer.js'
 ```
 
-## 🚨 ESM packages
+[👉 See electron-renderer.js](https://github.com/electron-vite/vite-plugin-electron-renderer/blob/main/plugins/use-node.js/electron-renderer.js)
 
-**e.g.** `node-fetch` `execa` `got` ...others
+## 🚨 Node.js ESM packages
 
-1. `npm i vite-plugin-esmodule -D`
-2. Configure in vite.config.ts
+**e.g.** `node-fetch` `execa` `got` ...
 
-```ts
-import esmodule from 'vite-plugin-esmodule'
-export default {
-  plugins: [
-    esmodule(['got', 'execa', 'node-fetch']),
-  ],
-}
-```
+In general, converting Node.js ESM packages is only required when using the Node.js API in Electron-Renderer, not in Electron-Main.
 
-[👉 See electron-renderer.js](https://github.com/electron-vite/vite-plugin-electron-renderer/blob/main/plugins/use-node.js/electron-renderer.js)
+*通常的，只有在 Electron-Renderer 中使用 Node.js API 的情况下才需要转换 Node.js ESM 模块，而在 Electron-Main 中使用不必转换*
+
+1. Use [vite-plugin-esmodule](https://github.com/vite-plugin/vite-plugin-esmodule) to load ESM modules
+2. It is recommended to put the ESM packages in the `devDependencies`
 
 ## How to work
 
 The plugin is just the encapsulation of the built-in plugins of [electron-vite-boilerplate/packages/renderer/plugins](https://github.com/electron-vite/electron-vite-boilerplate/tree/main/packages/renderer/plugins)
 
-###### Config presets
-
-1. Fist, the plugin will configuration something.
-  *If you do not configure the following options, the plugin will modify their default values*
-
-  * `base = './'`
-  * `build.assetsDir = ''` -> *TODO: Automatic splicing `build.assetsDir`*
-  * ~~`build.emptyOutDir = false`~~
-  * `build.cssCodeSplit = false`
-  * `build.rollupOptions.output.format = 'cjs'`
-  * `resolve.conditions = ['node']`
-  * Always insert the `electron` module into `optimizeDeps.exclude`
+## Config presets
 
-2. The plugin transform Electron and Node.js built-in modules to ESModule format in `vite serve` phase.
+If you do not configure the following options, the plugin will modify their default values
 
-3. Add Electron and Node.js built-in modules to Rollup `output.external` option in the `vite build` phase.
+- `base = './'`
+- `build.assetsDir = ''` -> *TODO: Support nested dir*
+- `build.emptyOutDir = false`
+- `build.cssCodeSplit = false`
+- `build.rollupOptions.output.format = 'cjs'`
+- `resolve.conditions = ['node']`
+- Always insert the `electron` module into `optimizeDeps.exclude`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-electron-renderer",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "description": "Support use Node.js API in Electron-Renderer",
   "main": "index.js",
   "repository": {

plugins/use-node.js/index.d.ts

@@ -20,7 +20,7 @@ export interface UseNodeJs {
 }
 
 export interface ResolveModules {
-  (config: ResolvedConfig, options: Options): {
+  (config: ResolvedConfig, options?: Options): {
     /** Node.js builtin modules */
     builtins: string[];
     /** dependencies of package.json */

plugins/use-node.js/index.js

@@ -165,10 +165,10 @@ ${exportMembers}
 /**
  * @type {import('.').ResolveModules}
  */
-function resolveModules(config, options) {
+function resolveModules(config, options = {}) {
   const root = config.root;
   const cwd = process.cwd();
-  const builtins = builtinModules.filter(e => !e.startsWith('_')); builtins.push(...builtins.map(m => `node:${m}`));
+  const builtins = builtinModules.filter(e => !e.startsWith('_')); builtins.push('electron', ...builtins.map(m => `node:${m}`));
   // dependencies of package.json
   let dependencies = [];
   // dependencies(ESM) of package.json
@@ -218,5 +218,12 @@ function lookupFile(filename, paths) {
 }
 
 useNodeJs.resolveModules = resolveModules;
-useNodeJs.default = useNodeJs;
+// Function {
+//   default: <ref *1> [Function: useNodeJs] {
+//     resolveModules: [Function: resolveModules2],
+//     default: [Circular *1]
+//   },
+//   resolveModules: [Getter]
+// }
+// useNodeJs.default = useNodeJs;
 module.exports = useNodeJs;