electron-incremental-update 2.3.7 → 2.3.8

package/README.md

@@ -278,7 +278,7 @@ const plugin = electronWithUpdater({
         db: './electron/native/db.ts',
         img: './electron/native/img.ts',
       },
-      postBuild: async ({ copyToEntryOutputDir, copyModules }) => {
+      postBuild: ({ copyToEntryOutputDir, copyModules }) => {
         // for better-sqlite3
         copyToEntryOutputDir({
           from: './node_modules/better-sqlite3/build/Release/better_sqlite3.node',
@@ -286,7 +286,7 @@ const plugin = electronWithUpdater({
         })
         // for @napi-rs/image
         const startStr = '@napi-rs+image-'
-        const fileName = (await readdir('./node_modules/.pnpm')).filter(p => p.startsWith(startStr))[0]
+        const fileName = readdirSync('./node_modules/.pnpm').find(p => p.startsWith(startStr))!
         const archName = fileName.substring(startStr.length).split('@')[0]
         copyToEntryOutputDir({
           from: `./node_modules/.pnpm/${fileName}/node_modules/@napi-rs/image-${archName}/image.${archName}.node`,
@@ -350,6 +350,74 @@ module.exports = {
 }
 ```
 
+#### Result in app.asar
+
+Before: Redundant 🤮
+
+```
+.
+├── dist-entry
+│   ├── chunk-IVHNGRZY-BPUeB0jT.js
+│   ├── db.js
+│   ├── entry.js
+│   └── image.js
+├── node_modules
+│   ├── @napi-rs
+│   ├── base64-js
+│   ├── better-sqlite3
+│   ├── bindings
+│   ├── bl
+│   ├── buffer
+│   ├── chownr
+│   ├── decompress-response
+│   ├── deep-extend
+│   ├── detect-libc
+│   ├── end-of-stream
+│   ├── expand-template
+│   ├── file-uri-to-path
+│   ├── fs-constants
+│   ├── github-from-package
+│   ├── ieee754
+│   ├── inherits
+│   ├── ini
+│   ├── mimic-response
+│   ├── minimist
+│   ├── mkdirp-classic
+│   ├── napi-build-utils
+│   ├── node-abi
+│   ├── once
+│   ├── prebuild-install
+│   ├── pump
+│   ├── rc
+│   ├── readable-stream
+│   ├── safe-buffer
+│   ├── semver
+│   ├── simple-concat
+│   ├── simple-get
+│   ├── string_decoder
+│   ├── strip-json-comments
+│   ├── tar-fs
+│   ├── tar-stream
+│   ├── tunnel-agent
+│   ├── util-deprecate
+│   └── wrappy
+└── package.json
+```
+
+After: Clean 😍
+
+```
+.
+├── dist-entry
+│   ├── better_sqlite3.node
+│   ├── chunk-IVHNGRZY-BPUeB0jT.js
+│   ├── db.js
+│   ├── entry.js
+│   ├── image.js
+│   └── image.win32-x64-msvc.node
+└── package.json
+```
+
 ### Bytecode Protection
 
 Use V8 cache to protect the source code
@@ -923,7 +991,9 @@ export interface BuildEntryOption {
   /**
    * `external` option in `build.rollupOptions`,
    * default is node built-in modules or native modules.
-   * If is in dev, also external `dependencies` in package.json
+   *
+   * If is in dev and {@link postBuild} is not setup, will also
+   * external `dependencies` in `package.json`
    */
   external?: NonNullable<NonNullable<InlineConfig['build']>['rollupOptions']>['external']
   /**
@@ -944,8 +1014,9 @@ export interface BuildEntryOption {
    */
   overrideViteOptions?: InlineConfig
   /**
-   * Resolve extra files on startup, such as `.node`
-   * @remark won't trigger will reload
+   * By default, all the unbundled modules will be packaged by packager like `electron-builder`.
+   * If setup, all the `dependencies` in `package.json` will be bundled by default, and you need
+   * to manually handle the native module files.
    */
   postBuild?: (args: {
     /**

package/dist/vite.d.ts

@@ -106,7 +106,9 @@ interface BuildEntryOption {
     /**
      * `external` option in `build.rollupOptions`,
      * default is node built-in modules or native modules.
-     * If is in dev, also external `dependencies` in package.json
+     *
+     * If is in dev and {@link postBuild} is not setup, will also
+     * external `dependencies` in `package.json`
      */
     external?: NonNullable<NonNullable<InlineConfig['build']>['rollupOptions']>['external'];
     /**
@@ -127,8 +129,12 @@ interface BuildEntryOption {
      */
     overrideViteOptions?: InlineConfig;
     /**
-     * Resolve extra files on startup, such as `.node`
-     * @remark won't trigger will reload
+     * By default, all the unbundled modules will be packaged by packager like `electron-builder`.
+     * If setup, all the `dependencies` in `package.json` will be bundled by default, and you need
+     * to manually handle the native module files.
+     *
+     * If you are using `electron-buidler`, don't forget to append `'!node_modules/**'` in
+     * electron-build config's `files` array
      */
     postBuild?: (args: {
         /**

package/dist/vite.js

@@ -607,7 +607,7 @@ function parseOptions(isBuild, pkg, sourcemap = false, minify = false, options =
         /.*\.(node|dll|dylib|so)$/,
         "original-fs",
         ...builtinModules,
-        ...isBuild ? [] : Object.keys("dependencies" in pkg ? pkg.dependencies : {})
+        ...isBuild || postBuild ? [] : Object.keys("dependencies" in pkg ? pkg.dependencies : {})
       ],
       overrideViteOptions = {}
     } = {},
@@ -792,12 +792,12 @@ async function electronWithUpdater(options) {
       getPathFromEntryOutputDir(...paths) {
         return path5.join(entryOutputDirPath, ...paths);
       },
-      copyToEntryOutputDir({ from, to, skipIfExist = true }) {
+      copyToEntryOutputDir({ from, to = path5.basename(from), skipIfExist = true }) {
         if (!fs5.existsSync(from)) {
           log.warn(`${from} not found`, { timestamp: true });
           return;
         }
-        const target = path5.join(entryOutputDirPath, to ?? path5.basename(from));
+        const target = path5.join(entryOutputDirPath, to);
         copyAndSkipIfExist(from, target, skipIfExist);
       },
       copyModules({ modules, skipIfExist = true }) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "electron-incremental-update",
   "type": "module",
-  "version": "2.3.7",
+  "version": "2.3.8",
   "description": "Electron incremental update tools with Vite plugin, support bytecode protection",
   "author": "subframe7536",
   "license": "MIT",