Merge pull request #45 from electron-vite/v0.13.7

V0.13.7

Author: caoxiemeihao

CHANGELOG.md

@@ -1,7 +1,40 @@
+## 0.13.7 (2023-03-25)
+
+- bda7d87 feat: set electron `__esModule`
+- 69960bd refactor: remove `cjs`, `external`. add `freeze`, `ignore`.
+- 521d8e2 docs: `resolve.alias` comments
+
+#### Main Changed
+
+1. No longer build in `cjs` format by default with improvements to `esm`.
+2. Remove the Node.js built-in module from `external` to be compatible with the `esm` build format.
+
 ## 0.13.6 (2023-03-24)
 
 - 562aa20 refactor: explicitly specify the module platform
 
+#### Main Changed
+
+Since `0.13.6`, Pre-Bundling have been greatly improved and Pure-JavaScript/Node.js modules no longer require any configuration - **out of the box**.
+
+C/C++ modules, however, still require explicit configuration.
+
+```js
+export default {
+  plugins: [
+    renderer({
+      optimizeDeps: {
+        resolve(args) {
+          if (args.path === 'serialport') {
+            return { platform: 'node' } // C/C++ module
+          }
+        },
+      },
+    }),
+  ],
+}
+```
+
 ## 0.13.5 (2023-03-23)
 
 - efaf706 refactor: `options.optimizer` -> `options.optimizeDeps`

install.mjs

@@ -17,7 +17,7 @@ const electron = typeof require !== 'undefined'
     return {
       // TODO: polyfill
     };
-  }());
+  }()); Object.defineProperty(electron, '__esModule', { value: true });
 
 // Proxy in Worker
 let _ipcRenderer;

package.json

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

src/build-config.ts

@@ -1,9 +1,10 @@
 import type {
   Alias,
+  BuildOptions,
   Plugin,
   UserConfig,
 } from 'vite'
-import type { ExternalOption, RollupOptions } from 'rollup'
+import type { RollupOptions } from 'rollup'
 import { electronBuiltins } from './utils'
 
 export default function buildConfig(nodeIntegration?: boolean): Plugin[] {
@@ -54,45 +55,49 @@ export default function buildConfig(nodeIntegration?: boolean): Plugin[] {
 
         if (nodeIntegration) {
           config.build.rollupOptions ??= {}
-          config.build.rollupOptions.external = withExternal(config.build.rollupOptions.external)
-          setOutputFormat(config.build.rollupOptions)
+          config.build.rollupOptions.output ??= {}
+
+          // `fs-extra` will extend the `fs` module
+          setOutputFreeze(config.build.rollupOptions)
+
+          // Some third-party modules, such as `fs-extra`, extend the native module
+          // `__esModule` to bypass Rollup's `getAugmentedNamespace`
+          // see - https://github.com/rollup/plugins/blob/commonjs-v24.0.0/packages/commonjs/src/helpers.js#L38
+          withIgnore(config.build)
         }
       },
     },
   ]
 }
 
-function withExternal(external?: ExternalOption) {
-  if (
-    Array.isArray(external) ||
-    typeof external === 'string' ||
-    external instanceof RegExp
-  ) {
-    // @ts-ignore
-    external = electronBuiltins.concat(external)
-  } else if (typeof external === 'function') {
-    const original = external
-    external = function externalFn(source, importer, isResolved) {
-      if (electronBuiltins.includes(source)) {
-        return true
-      }
-      return original(source, importer, isResolved)
+function setOutputFreeze(rollupOptions: RollupOptions) {
+  rollupOptions.output ??= {}
+  if (Array.isArray(rollupOptions.output)) {
+    for (const o of rollupOptions.output) {
+      o.freeze ??= false
     }
   } else {
-    external = electronBuiltins
+    rollupOptions.output.freeze ??= false
   }
-  return external
 }
 
-// At present, Electron can only support CommonJs
-function setOutputFormat(rollupOptions: RollupOptions) {
-  rollupOptions.output ??= {}
-  if (Array.isArray(rollupOptions.output)) {
-    for (const o of rollupOptions.output) {
-      o.format ??= 'cjs'
+function withIgnore(configBuild: BuildOptions) {
+  configBuild.commonjsOptions ??= {}
+  if (configBuild.commonjsOptions.ignore) {
+    if (typeof configBuild.commonjsOptions.ignore === 'function') {
+      const userIgnore = configBuild.commonjsOptions.ignore
+      configBuild.commonjsOptions.ignore = id => {
+        if (userIgnore?.(id) === true) {
+          return true
+        }
+        return electronBuiltins.includes(id)
+      }
+    } else {
+      // @ts-ignore
+      configBuild.commonjsOptions.ignore.push(...electronBuiltins)
     }
   } else {
-    rollupOptions.output.format ??= 'cjs'
+    configBuild.commonjsOptions.ignore = electronBuiltins
   }
 }