Registry / devops / electron-app-bundler

electron-app-bundler

library6.0.1jsnpmunverified

CLI tool to build Electron apps with esbuild, supporting hot reload dev server for the renderer process, static file copying, and optional use of Vite or Astro for the renderer. Current stable version is 6.0.1, with regular releases. Requires Node >=20 and peer dependencies astro >= 5.14.0, esbuild >= 0.20.0, vite >= 6.4.1. Uses a declarative JSON/YAML config file. Differentiates from other Electron bundlers by focusing on esbuild speed and supporting multiple main/preload/renderer configs with loaders and excludes.

devops web-framework

npm install electron-app-bundler

github ↗package ↗

INSTALL

IMPORT

SIG · ELECTRON-APP-BUNDL

electron-app-bundler

devopsjavascriptv6.0.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default (CLI)

✓ npx electron-app-bundler build

✗ npx electron-bundler build

Package was renamed from previous name to electron-app-bundler in v6.0.0

config shape

✓ Use JSON or YAML config file with main, preloads, renderers, resources properties

✗ Using old config format from versions <6

v6.0.0 introduced new default config file names (electron-app-bundler.config.json/yaml) and structure. Old configs may need migration.

RendererBuilderType

✓ import { RendererBuilderType } from 'electron-app-bundler'

✗ import { Renderer } from 'electron-app-bundler'

Used for typed configs. Exported since v4.0.0.

Shows minimal config and CLI commands to build and run dev server with hot reload.

// Create electron-app-bundler.config.json { "output": "dist", "main": { "entry": "src/main/index.ts", "output": { "directory": "main", "filename": "index.js" } }, "renderers": [ { "entry": "src/renderer/index.html", "output": { "directory": "renderer" } } ] } // Run build npx electron-app-bundler build // Run dev server with hot reload npx electron-app-bundler dev --clean

electron-app-bundler --version

Debug

Known issues

breakingPackage renamed in v6.0.0; old package name no longer works

fix

Replace references to old name with 'electron-app-bundler'

affects: >=6.0.0

breakingConfig file names changed in v6.0.0; must use electron-app-bundler.config.json or .yaml

fix

Rename config file to electron-app-bundler.config.*

affects: >=6.0.0

deprecatedUsing --vite or --astro flags without installing the respective peer dependency will fail

fix

Install astro or vite if using those flags

affects: >=4.0.0

gotchaNode engine requirement >=20; older Node versions will cause errors

fix

Update Node.js to version 20 or higher

affects: >=6.0.0

gotchaPeer dependencies must be installed manually; not included automatically

fix

Run npm install --save-dev astro esbuild vite

affects: >=4.0.0

Errors

Common errors & fixes

Package 'electron-app-bundler' is not recognized

Using old package name or typo

fix

Use correct package name: npx electron-app-bundler

Error: Config file not found: electron-app-bundler.config.json

Config file missing or named incorrectly (e.g., old name from v5)

fix

Create electron-app-bundler.config.json or specify path with --config

The engine "node" is incompatible with this module

Node version <20

fix

Install Node.js version 20 or higher

Upgrade

Version history

6.0.1latest on npm

Audit

Dependencies

astrooptionalRequired for building renderer process with Astro (optional via --astro flag)

esbuildrequiredCore bundler for main and preload processes

viteoptionalRequired for building renderer process with Vite (optional via --vite flag)

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/eduardoleolim/electron-app-bundler ↗

packagehttps://www.npmjs.com/package/electron-app-bundler ↗