Real project example — [onshape-desktop-shell](https://github.com/develar/onshape-desktop-shell).

See [options](https://github.com/electron-userland/electron-builder/wiki/Options) for a full reference but consider following the simple guide outlined below first.

| linux | <a name="BuildMetadata-linux"></a>See [.build.linux](#LinuxBuildOptions).

| compression | <a name="BuildMetadata-compression"></a>The compression level, one of `store`, `normal`, `maximum` (default: `normal`). If you want to rapidly test build, `store` can reduce build time significantly.

| afterPack | <a name="BuildMetadata-afterPack"></a>*programmatic API only* The function to be run after pack (but before pack into distributable format and sign). Promise must be returned.

| nodeGypRebuild | <a name="BuildMetadata-nodeGypRebuild"></a>Whether to execute `node-gyp rebuild` before starting to package the app. Defaults to `false`.

| electronDist | <a name="BuildMetadata-electronDist"></a>The path to custom Electron build (e.g. `~/electron/out/R`). Only macOS supported, file issue if need for Linux or Windows.

| publish | <a name="BuildMetadata-publish"></a>See [.build.publish](#PublishConfiguration).

| --- | ---

| iconUrl | <a name="SquirrelWindowsOptions-iconUrl"></a><p>A URL to an ICO file to use as the application icon (displayed in Control Panel &gt; Programs and Features). Defaults to the Electron icon.</p> <p>Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.</p> <ul> <li>If you don’t plan to build windows installer, you can omit it.</li> <li>If your project repository is public on GitHub, it will be <code>https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true</code> by default.</li> </ul>

| loadingGif | <a name="SquirrelWindowsOptions-loadingGif"></a><p>The path to a .gif file to display during install. <code>build/install-spinner.gif</code> will be used if exists (it is a recommended way to set) (otherwise [default](https://github.com/electron/windows-installer/blob/master/resources/install-spinner.gif)).</p>

| useAppIdAsId | <a name="SquirrelWindowsOptions-useAppIdAsId"></a>Use `appId` to identify package instead of `name`.

<a name="WinBuildOptions"></a>

| Name | Description

| --- | ---

| signingHashAlgorithms | <a name="WinBuildOptions-signingHashAlgorithms"></a>Array of signing algorithms used. Defaults to `['sha1', 'sha256']`

| icon | <a name="WinBuildOptions-icon"></a>The path to application icon. Defaults to `build/icon.ico` (consider using this convention instead of complicating your configuration).

| legalTrademarks | <a name="WinBuildOptions-legalTrademarks"></a>The trademarks and registered trademarks.

"transform-es2015-spread",

"transform-es2015-destructuring",

"array-includes",

]

},

"ava": {

readonly afterPack?: (context: AfterPackContext) => Promise<any> | null

/*

readonly npmRebuild?: boolean

/*

readonly npmSkipBuildFromSource?: boolean

/*

readonly npmArgs?: Array<string> | string | null

export interface WinBuildOptions extends PlatformSpecificBuildOptions {

/*

readonly target?: Array<string> | null

readonly loadingGif?: string | null

/*

readonly msi?: boolean

/*

readonly remoteReleases?: string | boolean | null

/*

readonly remoteToken?: string | null

import { archiveApp } from "./targets/archive"

import { Minimatch } from "minimatch"

import { checkFileInArchive, createAsarArchive } from "./asarUtil"

import { AppInfo } from "./appInfo"

import { copyFiltered } from "./util/filter"

import { pack } from "./packager/dirPackager"

const resourcesPath = this.platform === Platform.MAC ? path.join(appOutDir, "Electron.app", "Contents", "Resources") : path.join(appOutDir, "resources")

const ignoreFiles = new Set([path.resolve(this.info.appDir, outDir), path.resolve(this.info.appDir, this.buildResourcesDir)])

// prune dev or not listed dependencies

await dependencies(this.info.appDir, true, ignoreFiles)

promises.push(this.postInitApp(appOutDir))

await BluebirdPromise.all(promises)

})

await this.doCopyExtraFiles(extraResourceMatchers)

await this.doCopyExtraFiles(extraFileMatchers)

import BluebirdPromise from "bluebird-lst-c"

import { getBinFromBintray } from "../util/binDownload"

import { v5 as uuid5 } from "uuid-1345"

import { archiveApp } from "./archive"

import { unlink, readFile, writeFile, createReadStream } from "fs-extra-p"

import { SemVer } from "semver"

import { NsisOptions } from "../options/winOptions"

}

private async doBuild(appOutDir: string, arch: Arch) {

const publishConfigs = await this.publishConfigs

if (publishConfigs != null) {

await writeFile(path.join(appOutDir, "resources", "app-update.yml"), safeDump(publishConfigs[0]))

return await archiveApp(packager.devMetadata.build.compression, "7z", archiveFile, appOutDir, false, true)

}

}

private async buildInstaller(): Promise<any> {

}

async build(appOutDir: string, arch: Arch) {

if (arch === Arch.ia32) {

warn("For windows consider only distributing 64-bit or use nsis target, see https://github.com/electron-userland/electron-builder/issues/359#issuecomment-214851130")

}

import { PlatformPackager, BuildInfo, Target, TargetEx } from "./platformPackager"

import { Platform, Arch } from "./metadata"

import * as path from "path"

import { exec, use } from "./util/util"

import { open, close, read } from "fs-extra-p"

import { sign, SignOptions, getSignVendorPath } from "./windowsCodeSign"

continue

}

mapper("squirrel", () => {

const targetClass: typeof SquirrelWindowsTarget = require("./targets/squirrelWindows").default

return new targetClass(this)

})

}

mapper(name, outDir => {

const targetClass: typeof NsisTarget = require("./targets/nsis").default

return new targetClass(this, outDir)

protected packageInDistributableFormat(outDir: string, appOutDir: string, arch: Arch, targets: Array<Target>, promises: Array<Promise<any>>): void {

for (let target of targets) {

if (target instanceof TargetEx) {

}

else {

const format = target.name

//noinspection SpellCheckingInspection

await assertPack("test-app", {

// to check NuGet package

}, {

projectDirCreated: projectDir => {

return BluebirdPromise.all([