= Electron Builder =

'''Electron Builder''' is a tool chain project to automate and simplify the build process for [[Node/Electron|Electron]] applications.

<<TableOfContents>>

----



== Installation ==

Upstream strongly recommends using '''`yarn(1)`''' (not `npm(1)`) to install '''Electron Builder'''.

{{{
yarn add electron-builder --dev
}}}

----



== Usage ==



=== Targets ===

A 'minimal' `package.json` file is as:

{{{
"name": "my-app",
"productName": "My App",
"description": "This is My App.",
"author": {
  "name": "Me",
  "email": "me@example.com"
},
"version": "0.0.1",
"license": "GPL-3.0",
"build": {
  appId: "com.example.app",
},
"scripts": {
  "pack": "electron-builder --dir",
  "dist": "electron-builder"
}
}}}

Note that `appId` feeds directly into the build process for macOS and Windows (NSIS target only).

The scripts enable use as `yarn pack` and `yarn dist`.

Under build, there are target-specific objects.

||'''Keyword'''    ||'''Description'''                                  ||
||`mac`            ||options for all macOS targets                      ||
||`mas`            ||Mac Application Store options                      ||
||`dmg`            ||macOS DMG options                                  ||
||`pkg`            ||macOS PKG options                                  ||
||`win`            ||options for all Windows targets                    ||
||`nsis`           ||NSIS options                                       ||
||`nsisWeb`        ||web installer options inheriting from NSIS options ||
||`appx`           ||Windows App Store (AppX) options                   ||
||`squirrelWindows`||Squirrel Windows options                           ||
||`linux`          ||options for all Linux targets                      ||
||`deb`            ||Debian options                                     ||
||`snap`           ||!SnapCraft options                                 ||
||`appImage`       ||!AppImage options                                  ||
||`pacman`         ||pacman options                                     ||
||`rpm`            ||RPM options                                        ||
||`freebsd`        ||FreeBSD options                                    ||
||`p5p`            ||Solaris options                                    ||
||`apk`            ||Alpine Linux options                               ||



----
CategoryRicottone