npmpackage.info

builder-util

A complete solution to package and build a ready for distribution Electron app with “auto update” support out of the box

25.1.7

13,717

MIT

TypeScript

69,099,339 5.5

Installations

npm install builder-util

Pull Requests

Open

15

Total

1,810

Closed

413

Merged

1,382

Issues

Open

349

Total

6,769

Closed

6,420

Releases

867

v26.0.0-alpha.6

Published on 07 Nov 2024

v26.0.0-alpha.5

Published on 01 Nov 2024

v26.0.0-alpha.4

Published on 28 Oct 2024

electron-updater@6.4.0-alpha.1

Published on 28 Oct 2024

v26.0.0-alpha.3

Published on 16 Oct 2024

v26.0.0-alpha.2

Published on 13 Oct 2024

View all 867 releases

Developer

electron-userland

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

18.20.4

NPM Version

10.7.0 Statistics

13,717 Stars

3,217 Commits

1,741 Forks

149 Watching

40 Branches

544 Contributors

Updated on 28 Nov 2024

Languages

TypeScript (90.6%)

NSIS (6.81%)

JavaScript (1.64%)

Shell (0.63%)

Dockerfile (0.27%)

Smarty (0.03%)

CSS (0.02%)

Total Downloads

Cumulative downloads

Total Downloads

69,099,339

Last day

-5.8%

64,678

Compared to previous day

Last week

3.1%

362,727

Compared to previous week

Last month

17%

1,543,171

Compared to previous month

Last year

5.7%

14,911,171

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

electron-builder

A complete solution to package and build a ready for distribution Electron, Proton Native app for macOS, Windows and Linux with “auto update” support out of the box. :shipit:

Always looking for community contributions! 👀 Setting up a dev environment is easy to do 🪩

Documentation

See the full documentation on electron.build.

NPM packages management:
- Native application dependencies compilation (including Yarn support).
- Development dependencies are never included. You don't need to ignore them explicitly.
- Two package.json structure is supported, but you are not forced to use it even if you have native production dependencies.
Code Signing on a CI server or development machine.
Auto Update ready application packaging.
Numerous target formats:
- All platforms: 7z, zip, tar.xz, tar.7z, tar.lz, tar.gz, tar.bz2, dir (unpacked directory).
- macOS: dmg, pkg, mas.
- Linux: AppImage, snap, debian package (deb), rpm, freebsd, pacman, p5p, apk.
- Windows: nsis (Installer), nsis-web (Web installer), portable (portable app without installation), AppX (Windows Store), MSI, Squirrel.Windows.
Publishing artifacts to GitHub Releases, Amazon S3, DigitalOcean Spaces and Bintray.
Advanced building:
- Pack in a distributable format already packaged app.
- Separate build steps.
- Build and publish in parallel, using hard links on CI server to reduce IO and disk space usage.
- electron-compile support (compile for release-time on the fly on build).
Docker images to build Electron app for Linux or Windows on any platform.
Proton Native support.
Downloads all required tools files on demand automatically (e.g. to code sign windows application, to make AppX), no need to setup.

Question	Answer
“I want to configure electron-builder”	See options
“I found a bug or I have a question”	Open an issue
“I want to support development”	Donate

Installation

Yarn is strongly recommended instead of npm.

yarn add electron-builder --dev

Note for PNPM

In order to use with pnpm, you'll need to adjust your .npmrc to use any one the following approaches in order for your dependencies to be bundled correctly (ref: #6389):

node-linker=hoisted

public-hoist-pattern=*

shamefully-hoist=true

Note: Setting shamefully-hoist to true is the same as setting public-hoist-pattern to *.

Note for Yarn 3

Yarn 3 use PnP by default, but electron-builder still need node-modules(ref: yarnpkg/berry#4804). Add configuration in the .yarnrc.yaml as follows:

nodeLinker: "node-modules"

will declare to use node-modules instead of PnP.

Quick Setup Guide

electron-webpack-quick-start is a recommended way to create a new Electron application. See Boilerplates.

Specify the standard fields in the application package.json — name, description, version and author.
Specify the build configuration in the package.json as follows:
```
1"build": {
2  "appId": "your.id",
3  "mac": {
4    "category": "your.app.category.type"
5  }
6}
```
See all options. Option files to indicate which files should be packed in the final application, including the entry file, maybe required. You can also use separate configuration files, such as js, ts, yml, and json/json5. See read-config-file for supported extensions. JS Example for programmatic API
Add icons.
Add the scripts key to the development package.json:
```
1"scripts": {
2  "app:dir": "electron-builder --dir",
3  "app:dist": "electron-builder"
4}
```
Then you can run yarn app:dist (to package in a distributable format (e.g. dmg, windows installer, deb package)) or yarn app:dir (only generates the package directory without really packaging it. This is useful for testing purposes).

To ensure your native dependencies are always matched electron version, simply add script "postinstall": "electron-builder install-app-deps" to your package.json.
If you have native addons of your own that are part of the application (not as a dependency), set nodeGypRebuild to true.

Please note that everything is packaged into an asar archive by default.

For an app that will be shipped to production, you should sign your application. See Where to buy code signing certificates.

Programmatic Usage

See node_modules/electron-builder/out/index.d.ts. Typings for TypeScript are provided and also can be found here.

Code snippet provided below is also shown "in action" here as well.

1"use strict"
2
3const builder = require("electron-builder")
4const Platform = builder.Platform
5
6// Promise is returned
7builder.build({
8  targets: Platform.MAC.createTarget(),
9  config: {
10   "//": "build options, see https://goo.gl/QQXmcV"
11  }
12})
13  .then(() => {
14    // handle result
15  })
16  .catch((error) => {
17    // handle error
18  })

Boilerplates

electron-webpack-quick-start — A bare minimum project structure to get started developing with electron-webpack. Recommended.
electron-react-boilerplate A boilerplate for scalable cross-platform desktop apps.
electron-react-redux-boilerplate A minimal boilerplate to get started with Electron, React and Redux.
electron-boilerplate A minimalistic yet comprehensive boilerplate application.
Vue CLI 3 plugin for Electron A Vue CLI 3 plugin for Electron with no required configuration.
electron-vue-vite A real simple Electron + Vue3 + Vite5 boilerplate.
vite-electron-builder Secure boilerplate for Electron app based on Vite. Supports multiple frameworks.

Debug

Set the DEBUG environment variable to debug what electron-builder is doing:

1DEBUG=electron-builder

FPM_DEBUG env to add more details about building linux targets (except snap and appimage).

DEBUG_DMG=true env var to add more debugging/verbosity from hdiutil (macOS).

!!! tip "cmd" On Windows the environment variable is set using the set command. bash set DEBUG=electron-builder

!!! tip "PowerShell" PowerShell uses different syntax to set environment variables. bash $env:DEBUG=electron-builder

Donate

We do this open source work in our free time. If you'd like us to invest more time on it, please donate.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

License

Determines if the project has defined a license.

9

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

8

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

6

SAST

Determines if the project uses static code analysis.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 2

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-netlify.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/electron-userland/electron-builder/deploy-netlify.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-netlify.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/electron-userland/electron-builder/deploy-netlify.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-netlify.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/electron-userland/electron-builder/pr-netlify.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-netlify.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/electron-userland/electron-builder/pr-netlify.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-netlify.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/electron-userland/electron-builder/pr-netlify.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-release.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/electron-userland/electron-builder/pr-release.yml/master?enable=pin
Warn: containerImage not pinned by hash: docker/base/Dockerfile:1: pin your Docker image by updating buildpack-deps:focal-curl to buildpack-deps:focal-curl@sha256:4da6b2ff6ddf2c4364d0236b0a6fee455f768788ece240518c756ff7d4b06a8c
Warn: containerImage not pinned by hash: docker/node/Dockerfile:2
Warn: containerImage not pinned by hash: docker/wine-chrome/Dockerfile:2
Warn: containerImage not pinned by hash: docker/wine-mono/Dockerfile:2
Warn: containerImage not pinned by hash: docker/wine/Dockerfile:2
Warn: containerImage not pinned by hash: mkdocs-dockerfile:1: pin your Docker image by updating squidfunk/mkdocs-material:9.5 to squidfunk/mkdocs-material:9.5@sha256:d063d8460d449d5094da4b58c6e9b2aa8da869bb3a113a21401e0fe00bb8a628
Warn: downloadThenRun not pinned by hash: docker/base/Dockerfile:6-20
Warn: npmCommand not pinned by hash: docker/node/Dockerfile:11
Warn: pipCommand not pinned by hash: mkdocs-dockerfile:2
Warn: pipCommand not pinned by hash: netlify-docs.sh:2
Info: 10 out of 10 GitHub-owned GitHubAction dependencies pinned
Info: 3 out of 9 third-party GitHubAction dependencies pinned
Info: 0 out of 6 containerImage dependencies pinned
Info: 0 out of 1 downloadThenRun dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned
Info: 0 out of 2 pipCommand dependencies pinned

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

5.5

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Notes, Tasks, Projects. All in a Single Place.
Your gateway to understanding your diabetes data	An open, source-available software licensing and distribution API
ToDesktop: An all-in-one platform for building and releasing Electron apps	Dashcam: Capture the steps to reproduce any bug with video crash reports for Electron.

builder-util

Installations

Pull Requests

15

1,810

413

1,382

Issues

349

6,769

6,420

Releases

Developer

Developer Guide

CommonJS

No

18.20.4

10.7.0

Statistics

Languages

Total Downloads

69,099,339

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

electron-builder

Sponsors

Documentation

Installation

Note for PNPM

Note for Yarn 3

Quick Setup Guide

Programmatic Usage

Boilerplates

Debug

Donate

10

10

10

9

8

6

3

2

1

0

0

0

5.5

/10