electron-incremental-update 3.0.0 → 3.1.1

package/README.md

@@ -242,7 +242,8 @@ Common options overview:
 - `sourcemap`: defaults to development or `VSCODE_DEBUG`.
 - `minify`: defaults to production builds.
 - `bytecode`: `true` or bytecode options.
-- `notBundle`: externalizes Node modules in development. Defaults to `true`.
+- `bundleDeps`: controls dependency bundling. Defaults to Vite's server-environment behavior.
+  `electron-incremental-update` is always bundled.
 - `external`: additional Vite/Rolldown externals. Use `true` to externalize `dependencies`.
 - `buildVersionJson`: generates update JSON. Defaults to CI only.
 - `localDevUpdate`: generates and serves a local update package during dev startup. Use `true`
@@ -565,13 +566,21 @@ Notes:
 - To include preload scripts, use `bytecode: { enablePreload: true }`.
 - If preload bytecode is enabled, create the `BrowserWindow` with `sandbox: false`.
 
-## Development Bundling
+## Dependency Bundling
 
-`notBundle` is enabled by default in development. It externalizes Node modules in entry and main builds to improve startup speed.
+`bundleDeps` controls dependency handling for entry, main, and preload environments. It defaults to
+`'vite'`, which preserves Vite's server-environment behavior.
 
 ```ts
 electronWithUpdater({
-  notBundle: false,
+  bundleDeps: {
+    dev: {
+      exclude: true,
+    },
+    build: {
+      include: ['some-dependency'],
+    },
+  },
   entry: {
     files: './electron/entry.ts',
   },
@@ -581,6 +590,12 @@ electronWithUpdater({
 })
 ```
 
+Use `'auto'` to bundle all dependencies except package.json dependencies, `true` to bundle all
+dependencies, or `false` to externalize all dependencies. `both` applies a policy in both modes
+and is merged with the active `dev` or `build` policy. `include` maps to Vite's
+`resolve.noExternal`; `exclude` maps to `resolve.external`. `electron-incremental-update` and its
+subpath imports are always bundled.
+
 ## Utilities
 
 Import from `electron-incremental-update/utils` for path helpers, platform checks, native module loading, crypto, compression, download, and version parsing utilities.

package/dist/vite.d.mts

@@ -1,6 +1,6 @@
 import { Plugin, UserConfig } from "vite";
 import { MultiEnvElectronOptions } from "vite-plugin-electron/multi-env";
-import { RolldownOrRollupOptions } from "vite-plugin-electron";
+import { CreateOptions } from "@electron/asar";
 
 //#region src/utils/type.d.ts
 type Promisable<T> = T | Promise<T>;
@@ -124,7 +124,12 @@ interface CommonBuildOption {
     };
   };
 }
-interface ElectronWithUpdaterOptions {
+interface ElectronWithUpdaterOptions extends Pick<MultiEnvElectronOptions, "bundleDeps"> {
+  /**
+  * `electron-incremental-update` and its subpath imports are always bundled,
+  * regardless of this dependency policy.
+  */
+  bundleDeps?: MultiEnvElectronOptions["bundleDeps"];
   /**
   * Whether to generate sourcemap
   * @default !isBuild || !!process.env.VSCODE_DEBUG
@@ -144,17 +149,6 @@ interface ElectronWithUpdaterOptions {
   */
   bytecode?: boolean | BytecodeOptions;
   /**
-  * Faster dev startup by externalize all node modules in entry and main.
-  *
-  * Only works in development (`isBuild === false`).
-  * @default true
-  */
-  notBundle?: boolean | RolldownOrRollupOptions["external"];
-  /**
-  * @deprecated use `notBundle` instead
-  */
-  useNotBundle?: boolean;
-  /**
   * Whether to generate version json
   * @default isCI
   */
@@ -181,6 +175,10 @@ interface ElectronWithUpdaterOptions {
   * To change output directories, use `options.updater.paths.electronDistPath` instead
   */
   entry: {
+    /**
+    * Options passed to `@electron/asar` when creating the app.asar archive
+    */
+    asarOptions?: CreateOptions;
     /**
     * 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

package/dist/vite.mjs

@@ -11,7 +11,7 @@ import cp from "node:child_process";
 import * as babel from "@babel/core";
 import { copyFile, cp as cp$1, mkdir, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
-import { createPackage, extractFile } from "@electron/asar";
+import { createPackageWithOptions, extractFile } from "@electron/asar";
 import { generate } from "selfsigned";
 //#region src/vite/startup.ts
 /**
@@ -41,6 +41,9 @@ function fixWinCharEncoding(fn) {
 	});
 }
 //#endregion
+//#region package.json
+var name = "electron-incremental-update";
+//#endregion
 //#region src/utils/compress.ts
 /**
 * Default function to compress file using brotli
@@ -457,7 +460,7 @@ async function prepareLocalDevUpdateResource({ root, pkg, buildAsarOption, versi
 		await mkdir(path.dirname(resolvedVersionPath), { recursive: true });
 		await cp$1(path.resolve(root, buildAsarOption.electronDistPath), stagedElectronDistPath, { recursive: true });
 		await writeFile(path.join(stagedElectronDistPath, "version"), targetVersion, "utf-8");
-		await createPackage(stagedElectronDistPath, asarPath);
+		await createPackageWithOptions(stagedElectronDistPath, asarPath, buildAsarOption.asarOptions ?? {});
 		await writeFile(compressedPath, await buildAsarOption.generateCompressedFile(await readFile(asarPath)));
 		const updateJSON = defaultVersionJsonGenerator(await readExistingUpdateJSON(resolvedVersionPath, targetVersion), LOCAL_DEV_SIGNATURE, targetVersion, minimumVersion);
 		if (!isUpdateJSON(updateJSON)) throw new Error("Invalid local dev update json");
@@ -570,7 +573,7 @@ function copyAndSkipIfExist(from, to, skipIfExist) {
 * @param options - Asar build options
 * @returns Buffer of the built asar file
 */
-async function buildAsar(root, { version, asarOutputPath, electronDistPath, rendererDistPath, compressedPath, generateCompressedFile }) {
+async function buildAsar(root, { version, asarOptions, asarOutputPath, electronDistPath, rendererDistPath, compressedPath, generateCompressedFile }) {
 	electronDistPath = path.resolve(root, electronDistPath);
 	asarOutputPath = path.resolve(root, asarOutputPath);
 	rendererDistPath = path.resolve(root, rendererDistPath);
@@ -579,7 +582,7 @@ async function buildAsar(root, { version, asarOutputPath, electronDistPath, rend
 	await fs.promises.cp(rendererDistPath, rPath, { recursive: true });
 	fs.writeFileSync(path.join(electronDistPath, "version"), version);
 	await fs.promises.mkdir(path.dirname(asarOutputPath), { recursive: true });
-	await createPackage(electronDistPath, asarOutputPath);
+	await createPackageWithOptions(electronDistPath, asarOutputPath, asarOptions ?? {});
 	const buf = await generateCompressedFile(fs.readFileSync(asarOutputPath));
 	await fs.promises.mkdir(path.dirname(compressedPath), { recursive: true });
 	fs.writeFileSync(compressedPath, buf);
@@ -683,7 +686,7 @@ function parseSubjects(subject) {
 }
 //#endregion
 //#region src/vite/core.ts
-async function resolveUpdaterOption(root, pkg, options = {}, resolveSignatureKeys = true) {
+async function resolveUpdaterOption(root, pkg, options = {}, resolveSignatureKeys = true, asarOptions) {
 	const { minimumVersion = "0.0.0", paths: { asarOutputPath = `release/${pkg.name}.asar`, compressedPath = `release/${pkg.name}-${pkg.version}.asar.br`, entryOutDir = "dist-entry", electronDistPath = "dist-electron", rendererDistPath = "dist", versionPath = "release/version.json" } = {}, keys: { privateKeyPath = "keys/private.pem", certPath = "keys/cert.pem", keyLength = 2048, certInfo: { subject = {
 		commonName: pkg.name,
 		organizationName: `org.${pkg.name}`
@@ -701,6 +704,7 @@ async function resolveUpdaterOption(root, pkg, options = {}, resolveSignatureKey
 	return {
 		buildAsarOption: {
 			version: pkg.version,
+			asarOptions,
 			asarOutputPath,
 			compressedPath,
 			electronDistPath,
@@ -736,7 +740,7 @@ function normalizeVersionPath(versionPath) {
 	return new URL(versionPath, "file://").pathname.slice(1);
 }
 async function createElectronOptions(options, context) {
-	const { entry, main, preload, sourcemap = context.isDev || !!process.env.VSCODE_DEBUG, minify = !context.isDev, buildVersionJson, notBundle = true, external, updater, bytecode, localDevUpdate } = options;
+	const { entry, main, preload, sourcemap = context.isDev || !!process.env.VSCODE_DEBUG, minify = !context.isDev, buildVersionJson, bundleDeps, external, updater, bytecode, localDevUpdate } = options;
 	const pkg = context.packageJson;
 	if (!pkg || !pkg.version || !pkg.name || !pkg.main) throw new Error("package.json not found or invalid, must contains version, name and main field");
 	const isESM = pkg.type === "module";
@@ -750,7 +754,7 @@ async function createElectronOptions(options, context) {
 	if (isESM && bytecodeOptions?.enable) throw new Error("`bytecodePlugin` does not support ES module, please remove \"type\": \"module\" in package.json");
 	const resolvedLocalDevUpdate = context.isDev ? resolveLocalDevUpdateOptions(context.root, localDevUpdate) : void 0;
 	const updatePkg = await resolveLocalDevUpdatePackage(pkg, resolvedLocalDevUpdate);
-	const { buildAsarOption, buildVersionOption, entryOutDir } = await resolveUpdaterOption(context.root, updatePkg, updater, !resolvedLocalDevUpdate);
+	const { buildAsarOption, buildVersionOption, entryOutDir } = await resolveUpdaterOption(context.root, updatePkg, updater, !resolvedLocalDevUpdate, entry.asarOptions);
 	const mainFileName = `${resolveEntryName(main.files)}.${isESM ? "mjs" : "js"}`;
 	log.info(`Using "${mainFileName}" as main file`, { timestamp: true });
 	log.info(`Clear cache files`, { timestamp: true });
@@ -796,13 +800,14 @@ async function createElectronOptions(options, context) {
 		name: "main",
 		input: main.files,
 		onstart: mainOnstart,
-		notBundle,
+		bundleDeps,
 		plugins: [isESM && esmShim(), bytecodeOptions && bytecodePlugin("main", minify, isESM, bytecodeOptions)],
 		options: mergeConfig({
 			build: {
 				sourcemap,
 				minify,
 				outDir: `${buildAsarOption.electronDistPath}/main`,
+				reportCompressedSize: false,
 				rolldownOptions: {
 					external: finalExternal,
 					output: {
@@ -812,6 +817,7 @@ async function createElectronOptions(options, context) {
 					}
 				}
 			},
+			resolve: { noExternal: [name] },
 			define
 		}, main.options ?? {})
 	}];
@@ -820,13 +826,14 @@ async function createElectronOptions(options, context) {
 		onstart(args) {
 			args.reload();
 		},
-		notBundle,
+		bundleDeps,
 		input: preload.files,
 		plugins: [isESM && esmShim(), bytecodeOptions && bytecodePlugin("preload", minify, isESM, bytecodeOptions)],
 		options: mergeConfig({
 			build: {
-				sourcemap: sourcemap ? "inline" : void 0,
 				minify,
+				sourcemap: sourcemap ? "inline" : void 0,
+				reportCompressedSize: false,
 				outDir: `${buildAsarOption.electronDistPath}/preload`,
 				rolldownOptions: {
 					external: finalExternal,
@@ -838,6 +845,7 @@ async function createElectronOptions(options, context) {
 					}
 				}
 			},
+			resolve: { noExternal: [name] },
 			define
 		}, preload?.options ?? {})
 	});
@@ -848,7 +856,7 @@ async function createElectronOptions(options, context) {
 			if (mainOnstart) await mainOnstart(args);
 			else await args.startup();
 		},
-		notBundle,
+		bundleDeps,
 		plugins: [
 			isESM && esmShim(),
 			bytecodeOptions && bytecodePlugin("entry", minify, isESM, bytecodeOptions),
@@ -884,6 +892,7 @@ async function createElectronOptions(options, context) {
 				sourcemap,
 				minify,
 				outDir: entryOutDir,
+				reportCompressedSize: false,
 				rolldownOptions: {
 					external: finalExternal,
 					output: {
@@ -893,6 +902,7 @@ async function createElectronOptions(options, context) {
 					}
 				}
 			},
+			resolve: { noExternal: [name] },
 			define
 		}, entry.options || {})
 	});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-incremental-update",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "description": "Electron incremental update tools with Vite plugin, support bytecode protection",
   "keywords": [
     "bytecode",
@@ -56,19 +56,17 @@
     "build": "tsdown",
     "play": "bun run build && vite",
     "play:build": "vite build",
-    "release": "bun run format && bun run lint && bun run test && bun run build && bumpp --all",
+    "release": "bun run qa && bun run test && bun run build && bumpp --all",
     "test": "bun test --preload ./tests/setup.ts",
     "test:dev": "bun test --watch",
-    "format": "oxfmt",
-    "lint": "oxlint --fix",
-    "qa": "bun run lint && bun run format && tsc --noEmit"
+    "qa": "oxlint --fix && oxfmt && tsc --noEmit"
   },
   "dependencies": {
     "@babel/plugin-transform-arrow-functions": "^7.29.7",
     "@babel/plugin-transform-template-literals": "^7.29.7",
     "ci-info": "^4.4.0",
     "selfsigned": "^5.5.0",
-    "vite-plugin-electron": "~1.0.4"
+    "vite-plugin-electron": "^1.1.0"
   },
   "devDependencies": {
     "@subf/config": "^0.2.1",