Merge pull request #58 from electron-vite/v0.14.0

V0.14.0

CHANGELOG.md

@@ -1,3 +1,34 @@
+## 0.14.0 (2023-04-13)
+
+#### Break!
+
+```diff
+export interface RendererOptions {
+  resolve?: {
+-   [id: string]: (() => string | { platform: 'browser' | 'node' } | Promise<string | { platform: 'browser' | 'node' }>)
++   [module: string]: {
++     type: 'cjs' | 'esm',
++     build?: (args: {
++       cjs: (module: string) => Promise<string>,
++       esm: (module: string, buildOptions?: import('esbuild').BuildOptions) => Promise<string>,
++     }) => Promise<string>
++   }
+  }
+}
+```
+
+#### Main Changed
+
+1. on-demand pre-bundle builtin, third-part C/C++, `esm` modules
+2. support full custom pre-bundle
+
+- 98c4d27 docs: v0.14.0
+- af6bb2b chore(examples): update quick-start
+- 110c854 chore: better build script
+- cd1b5bb chore: remove `.npmrc`
+- b8038f5 refactor(v0.14.0): better `options.resolve`
+- 7c5afae refactor(v0.14.0): on-demand pre-bundle
+
 ## 0.13.14 (2023-03-31)
 
 - c68d26a fix: move cjs config to cjs-shim.ts #107 | [electron-vite-vue/issues/107](https://github.com/electron-vite/electron-vite-vue/issues/107)

README.md

@@ -46,7 +46,7 @@ export default {
 }
 ```
 
-2. Using the third-part C/C++ package in the Renderer process.
+2. Using the third-part C/C++, `esm` package in the Renderer process.
 
 ```js
 import renderer from 'vite-plugin-electron-renderer'
@@ -55,7 +55,10 @@ export default {
   plugins: [
     renderer({
       resolve: {
-        serialport: () => ({ platform: 'node' }), // specify as `node` platform
+        // C/C++ modules must be pre-bundle
+        serialport: { type: 'cjs' },
+        // `esm` modules only if Vite does not pre-bundle them correctly
+        got: { type: 'esm' },
       },
     }),
   ],
@@ -69,26 +72,22 @@ export default {
 ```ts
 export interface RendererOptions {
   /**
-   * Explicitly tell Vite how to load modules, which is very useful for C/C++ modules.  
-   * Most of the time, you don't need to use it when a module is a C/C++ module, you can load them by return `{ platform: 'node' }`.  
+   * Explicitly tell Vite how to load modules, which is very useful for C/C++ and `esm` modules
    * 
-   * If you know exactly how Vite works, you can customize the return snippets.  
-   * 
-   * ```js
-   * renderer({
-   *   resolve: {
-   *     // Use the serialport(C/C++) module as an example
-   *     serialport: () => ({ platform: 'node' }),
-   *     // Equivalent to
-   *     serialport: () => `const lib = require("serialport"); export default lib.default || lib;`,
-   *   },
-   * })
-   * ```
+   * - `type.cjs` just wraps esm-interop
+   * - `type.esm` pre-bundle to `cjs` and wraps esm-interop
    * 
    * @experimental
    */
   resolve?: {
-    [id: string]: (() => string | { platform: 'browser' | 'node' } | Promise<string | { platform: 'browser' | 'node' }>)
+    [module: string]: {
+      type: 'cjs' | 'esm',
+      /** Full custom how to pre-bundle */
+      build?: (args: {
+        cjs: (module: string) => Promise<string>,
+        esm: (module: string, buildOptions?: import('esbuild').BuildOptions) => Promise<string>,
+      }) => Promise<string>
+    }
   }
 }
 ```

examples/quick-start/renderer/samples/node.js-api.ts

@@ -1,9 +1,5 @@
 import { ipcRenderer } from 'electron'
 import fs from 'fs/promises'
-import buffer from 'buffer'
 
 console.log('Electron API:\n', ipcRenderer)
 console.log('Node.js API(fs/promises):\n', fs)
-
-console.log('----', buffer.hasOwnProperty('aaa'), '----')
-

examples/quick-start/vite.config.ts

@@ -9,7 +9,8 @@ export default defineConfig({
     }),
     renderer({
       resolve: {
-        serialport: () => ({ platform: 'node' }),
+        serialport: { type: 'cjs' },
+        got: { type: 'esm' },
       },
     }),
   ],

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-electron-renderer",
-  "version": "0.13.14",
+  "version": "0.14.0",
   "description": "Support use Node.js API in Electron-Renderer",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -23,7 +23,6 @@
     "build": "vite build",
     "types": "tsc --emitDeclarationOnly",
     "prepublishOnly": "npm run test && npm run build",
-    "postinstall": "node install.js",
     "test": "vitest run"
   },
   "dependencies": {
@@ -34,6 +33,7 @@
     "rollup": "^3.19.1",
     "typescript": "^5.0.2",
     "vite": "^4.2.0",
+    "vite-plugin-utils": "^0.4.0",
     "vitest": "^0.29.3"
   },
   "files": [