{"id":25196,"library":"electron-app-bundler","title":"electron-app-bundler","description":"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.","status":"active","version":"6.0.1","language":"javascript","source_language":"en","source_url":"https://github.com/eduardoleolim/electron-app-bundler","tags":["javascript","esbuild","vite","electron","hot reload","hmr","renderer","cli","build-tool"],"install":[{"cmd":"npm install electron-app-bundler","lang":"bash","label":"npm"},{"cmd":"yarn add electron-app-bundler","lang":"bash","label":"yarn"},{"cmd":"pnpm add electron-app-bundler","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Required for building renderer process with Astro (optional via --astro flag)","package":"astro","optional":true},{"reason":"Core bundler for main and preload processes","package":"esbuild","optional":false},{"reason":"Required for building renderer process with Vite (optional via --vite flag)","package":"vite","optional":true}],"imports":[{"note":"Package was renamed from previous name to electron-app-bundler in v6.0.0","wrong":"npx electron-bundler build","symbol":"default (CLI)","correct":"npx electron-app-bundler build"},{"note":"v6.0.0 introduced new default config file names (electron-app-bundler.config.json/yaml) and structure. Old configs may need migration.","wrong":"Using old config format from versions <6","symbol":"config shape","correct":"Use JSON or YAML config file with main, preloads, renderers, resources properties"},{"note":"Used for typed configs. Exported since v4.0.0.","wrong":"import { Renderer } from 'electron-app-bundler'","symbol":"RendererBuilderType","correct":"import { RendererBuilderType } from 'electron-app-bundler'"}],"quickstart":{"code":"// Create electron-app-bundler.config.json\n{\n  \"output\": \"dist\",\n  \"main\": {\n    \"entry\": \"src/main/index.ts\",\n    \"output\": {\n      \"directory\": \"main\",\n      \"filename\": \"index.js\"\n    }\n  },\n  \"renderers\": [\n    {\n      \"entry\": \"src/renderer/index.html\",\n      \"output\": {\n        \"directory\": \"renderer\"\n      }\n    }\n  ]\n}\n\n// Run build\nnpx electron-app-bundler build\n\n// Run dev server with hot reload\nnpx electron-app-bundler dev --clean","lang":"javascript","description":"Shows minimal config and CLI commands to build and run dev server with hot reload."},"warnings":[{"fix":"Replace references to old name with 'electron-app-bundler'","message":"Package renamed in v6.0.0; old package name no longer works","severity":"breaking","affected_versions":">=6.0.0"},{"fix":"Rename config file to electron-app-bundler.config.*","message":"Config file names changed in v6.0.0; must use electron-app-bundler.config.json or .yaml","severity":"breaking","affected_versions":">=6.0.0"},{"fix":"Install astro or vite if using those flags","message":"Using --vite or --astro flags without installing the respective peer dependency will fail","severity":"deprecated","affected_versions":">=4.0.0"},{"fix":"Update Node.js to version 20 or higher","message":"Node engine requirement >=20; older Node versions will cause errors","severity":"gotcha","affected_versions":">=6.0.0"},{"fix":"Run npm install --save-dev astro esbuild vite","message":"Peer dependencies must be installed manually; not included automatically","severity":"gotcha","affected_versions":">=4.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use correct package name: npx electron-app-bundler","cause":"Using old package name or typo","error":"Package 'electron-app-bundler' is not recognized"},{"fix":"Create electron-app-bundler.config.json or specify path with --config","cause":"Config file missing or named incorrectly (e.g., old name from v5)","error":"Error: Config file not found: electron-app-bundler.config.json"},{"fix":"Install Node.js version 20 or higher","cause":"Node version <20","error":"The engine \"node\" is incompatible with this module"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}