dataunitylab/json-schema-descriptions · Datasets at Hugging Face

schema stringclasses 471 values	key stringlengths 0 203	description stringlengths 0 4.37k	object stringlengths 2 322k
electron-builder.json	publishAutoUpdate	Whether to publish auto update info files. Auto update relies only on the first provider in the list (you can specify several publishers). Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.	{"default": true, "type": "boolean"}
electron-builder.json	region	The region. Is determined and set automatically when publishing.	{"type": ["null", "string"]}
electron-builder.json	storageClass	The type of storage to use for the object.	{"anyOf": [{"enum": ["REDUCED_REDUNDANCY", "STANDARD", "STANDARD_IA"], "type": "string"}, {"type": "null"}], "default": "STANDARD"}
electron-builder.json	after	Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part. Defaults to `["desktop-gtk2""]`. If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom parts `foo` in addition to defaults.	{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}
electron-builder.json	artifactName	The [artifact file name template](/configuration/configuration#artifact-file-name-template).	{"type": ["null", "string"]}
electron-builder.json	assumes	The list of features that must be supported by the core in order for this snap to install.	{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]}
electron-builder.json	buildPackages	The list of debian packages needs to be installed for building this snap.	{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}
electron-builder.json	category	The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).	{"type": ["null", "string"]}
electron-builder.json	confinement	The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap.	{"anyOf": [{"enum": ["classic", "devmode", "strict"], "type": "string"}, {"type": "null"}], "default": "strict"}
electron-builder.json	description	As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.	{"type": ["null", "string"]}
electron-builder.json	desktop	The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value).	{}
electron-builder.json	environment	The custom environment. Defaults to `{"TMPDIR: "$XDG_RUNTIME_DIR"}`. If you set custom, it will be merged with default.	{"anyOf": [{}, {"type": "null"}]}
electron-builder.json	grade	The quality grade of the snap. It can be either `devel` (i.e. a development version of the snap, so not to be published to the "stable" or "candidate" channels) or "stable" (i.e. a stable release or release candidate, which can be released to all channels).	{"anyOf": [{"enum": ["devel", "stable"], "type": "string"}, {"type": "null"}], "default": "stable"}
electron-builder.json	hooks	The [hooks](https://docs.snapcraft.io/build-snaps/hooks) directory, relative to `build` (build resources directory).	{"default": "build/snap-hooks", "type": ["null", "string"]}
electron-builder.json	mimeTypes	The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing.	{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}
electron-builder.json	plugs	The list of [plugs](https://snapcraft.io/docs/reference/interfaces). Defaults to `["desktop", "desktop-legacy", "home", "x11", "unity7", "browser-support", "network", "gsettings", "pulseaudio", "opengl"]`. If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom plug `foo` in addition to defaults. Additional attributes can be specified using object instead of just name of plug: ``` [ { "browser-sandbox": { "interface": "browser-support", "allow-sandbox": true }, }, "another-simple-plug-name" ] ```	{"anyOf": [{}, {"items": {"anyOf": [{}, {"type": "string"}]}, "type": "array"}, {"type": "null"}]}
electron-builder.json	stagePackages	The list of Ubuntu packages to use that are needed to support the `app` part creation. Like `depends` for `deb`. Defaults to `["libasound2", "libgconf2-4", "libnotify4", "libnspr4", "libnss3", "libpcre3", "libpulse0", "libxss1", "libxtst6"]`. If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom package `foo` in addition to defaults.	{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}
electron-builder.json	summary	The 78 character long summary. Defaults to [productName](/configuration/configuration#Configuration-productName).	{"type": ["null", "string"]}
electron-builder.json	synopsis	The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).	{"type": ["null", "string"]}
electron-builder.json	useTemplateApp	Whether to use template snap. Defaults to `true` if `stagePackages` not specified.	{"type": "boolean"}
electron-builder.json	SpacesOptions	[DigitalOcean Spaces](https://www.digitalocean.com/community/tutorials/an-introduction-to-digitalocean-spaces) options. Access key is required, define `DO_KEY_ID` and `DO_SECRET_KEY` environment variables.	{"additionalProperties": false, "properties": {"acl": {"anyOf": [{"enum": ["private", "public-read"], "type": "string"}, {"type": "null"}], "default": "public-read"}, "channel": {"default": "latest", "type": ["null", "string"]}, "name": {"type": "string"}, "path": {"default": "/", "type": ["null", "string"]}, "provider": {"enum": ["spaces"], "type": "string"}, "publishAutoUpdate": {"default": true, "type": "boolean"}, "publisherName": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}, "region": {"type": "string"}, "updaterCacheDirName": {"type": ["null", "string"]}}, "required": ["name", "provider", "region"], "type": "object"}
electron-builder.json	acl	The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).	{"anyOf": [{"enum": ["private", "public-read"], "type": "string"}, {"type": "null"}], "default": "public-read"}
electron-builder.json	channel	The update channel.	{"default": "latest", "type": ["null", "string"]}
electron-builder.json	name	The space name.	{"type": "string"}
electron-builder.json	path	The directory path.	{"default": "/", "type": ["null", "string"]}
electron-builder.json	provider	The provider. Must be `spaces`.	{"enum": ["spaces"], "type": "string"}
electron-builder.json	publishAutoUpdate	Whether to publish auto update info files. Auto update relies only on the first provider in the list (you can specify several publishers). Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.	{"default": true, "type": "boolean"}
electron-builder.json	region	The region (e.g. `nyc3`).	{"type": "string"}
electron-builder.json	artifactName	The [artifact file name template](/configuration/configuration#artifact-file-name-template).	{"type": ["null", "string"]}
electron-builder.json	iconUrl	A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon. Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http. If you don't plan to build windows installer, you can omit it. If your project repository is public on GitHub, it will be `https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true` by default.	{"type": ["null", "string"]}
electron-builder.json	loadingGif	The path to a .gif file to display during install. `build/install-spinner.gif` 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)).	{"type": ["null", "string"]}
electron-builder.json	msi	Whether to create an MSI installer. Defaults to `false` (MSI is not created).	{"type": "boolean"}
electron-builder.json	name	https://github.com/electron-userland/electron-builder/issues/1743	{"type": "string"}
electron-builder.json	remoteReleases	A URL to your existing updates. Or `true` to automatically set to your GitHub repository. If given, these will be downloaded to create delta updates.	{"type": ["null", "string", "boolean"]}
electron-builder.json	remoteToken	Authentication token for remote updates	{"type": ["null", "string"]}
electron-builder.json	useAppIdAsId	Use `appId` to identify package instead of `name`.	{"type": "boolean"}
electron-builder.json	arch	The arch or list of archs.	{"anyOf": [{"items": {"enum": ["arm64", "armv7l", "ia32", "x64"], "type": "string"}, "type": "array"}, {"enum": ["arm64", "armv7l", "ia32", "x64"], "type": "string"}]}
electron-builder.json	target	The target name. e.g. `snap`.	{"type": "string"}
electron-builder.json	additionalCertificateFile	The path to an additional certificate file you want to add to the signature block.	{"type": ["null", "string"]}
electron-builder.json	appId	The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.	{"default": "com.electron.${name}", "type": ["null", "string"]}
electron-builder.json	artifactName	The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).	{"type": ["null", "string"]}
electron-builder.json	asar	Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/). Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.	{"anyOf": [{}, {"type": ["null", "boolean"]}], "default": true}
electron-builder.json	asarUnpack	A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.	{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]}
electron-builder.json	certificateFile	The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable `CSC_LINK` (`WIN_CSC_LINK`) for some reason. Please see [Code Signing](/code-signing).	{"type": ["null", "string"]}
electron-builder.json	certificatePassword	The password to the certificate provided in `certificateFile`. Please use it only if you cannot use env variable `CSC_KEY_PASSWORD` (`WIN_CSC_KEY_PASSWORD`) for some reason. Please see [Code Signing](/code-signing).	{"type": ["null", "string"]}
electron-builder.json	certificateSha1	The SHA1 hash of the signing certificate. The SHA1 hash is commonly specified when multiple certificates satisfy the criteria specified by the remaining switches. Works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).	{"type": ["null", "string"]}
electron-builder.json	certificateSubjectName	The name of the subject of the signing certificate. Required only for EV Code Signing and works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).	{"type": ["null", "string"]}
electron-builder.json	compression	The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.	{"anyOf": [{"enum": ["maximum", "normal", "store"], "type": "string"}, {"type": "null"}], "default": "normal"}
electron-builder.json	detectUpdateChannel	Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.	{"default": true, "type": "boolean"}
electron-builder.json	electronUpdaterCompatibility	The [electron-updater compatibility](/auto-update#compatibility) semver range.	{"type": ["null", "string"]}
electron-builder.json	fileAssociations	The file associations.	{"anyOf": [{}, {"items": {}, "type": "array"}]}
electron-builder.json	forceCodeSigning	Whether to fail if app will be not code signed.	{"type": "boolean"}
electron-builder.json	generateUpdatesFilesForAllChannels	Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).	{"default": false, "type": "boolean"}
electron-builder.json	icon	The path to application icon.	{"default": "build/icon.ico", "type": ["null", "string"]}
electron-builder.json	legalTrademarks	The trademarks and registered trademarks.	{"type": ["null", "string"]}
electron-builder.json	protocols	The URL protocol schemes.	{"anyOf": [{}, {"items": {}, "type": "array"}]}
electron-builder.json	publisherName	[The publisher name](https://github.com/electron-userland/electron-builder/issues/1187#issuecomment-278972073), exactly as in your code signed certificate. Several names can be provided. Defaults to common name from your code signing certificate.	{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]}
electron-builder.json	releaseInfo	The release info. Intended for command line usage: ``` -c.releaseInfo.releaseNotes="new features" ```	{}
electron-builder.json	requestedExecutionLevel	The [security level](https://msdn.microsoft.com/en-us/library/6ad1fshk.aspx#Anchor_9) at which the application requests to be executed. Cannot be specified per target, allowed only in the `win`.	{"anyOf": [{"enum": ["asInvoker", "highestAvailable", "requireAdministrator"], "type": "string"}, {"type": "null"}], "default": "asInvoker"}
electron-builder.json	rfc3161TimeStampServer	The URL of the RFC 3161 time stamp server.	{"default": "http://timestamp.comodoca.com/rfc3161", "type": ["null", "string"]}
electron-builder.json	sign	The custom function (or path to file or module id) to sign Windows executable.	{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}
electron-builder.json	signAndEditExecutable	Whether to sign and add metadata to executable. Advanced option.	{"default": true, "type": "boolean"}
electron-builder.json	signDlls	Whether to sign DLL files. Advanced option.	{"default": false, "type": "boolean"}
electron-builder.json	signingHashAlgorithms	Array of signing algorithms used. For AppX `sha256` is always used.	{"anyOf": [{"items": {"enum": ["sha1", "sha256"], "type": "string"}, "type": "array"}, {"type": "null"}], "default": "['sha1', 'sha256']"}
electron-builder.json	target	The target package type: list of `nsis`, `nsis-web` (Web installer), `portable` ([portable](/configuration/nsis#portable) app without installation), `appx`, `msi`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. AppX package can be built only on Windows 10. To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency.	{"anyOf": [{}, {"items": {"anyOf": [{}, {"type": "string"}]}, "type": "array"}, {"type": ["null", "string"]}], "default": "nsis"}
electron-builder.json	timeStampServer	The URL of the time stamp server.	{"default": "http://timestamp.verisign.com/scripts/timstamp.dll", "type": ["null", "string"]}
electron-builder.json	verifyUpdateCodeSignature	Whether to verify the signature of an available update before installation. The [publisher name](#publisherName) will be used for the signature verification.	{"default": true, "type": "boolean"}
electron-builder.json	$schema	JSON Schema for this document.	{"type": ["null", "string"]}
electron-builder.json	afterAllArtifactBuild	The function (or path to file or module id) to be [run after all artifacts are build](#afterAllArtifactBuild).	{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}
electron-builder.json	afterPack	The function (or path to file or module id) to be [run after pack](#afterpack) (but before pack into distributable format and sign).	{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}
electron-builder.json	afterSign	The function (or path to file or module id) to be [run after pack and sign](#aftersign) (but before pack into distributable format).	{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}
electron-builder.json	appId	The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.	{"default": "com.electron.${name}", "type": ["null", "string"]}
electron-builder.json	appImage	AppImage options.	{"anyOf": [{}, {"type": "null"}]}
electron-builder.json	artifactBuildCompleted	The function (or path to file or module id) to be run on artifact build completed.	{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}
electron-builder.json	artifactBuildStarted	The function (or path to file or module id) to be run on artifact build start.	{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}
electron-builder.json	artifactName	The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).	{"type": ["null", "string"]}
electron-builder.json	asar	Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/). Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.	{"anyOf": [{}, {"type": ["null", "boolean"]}], "default": true}
electron-builder.json	asarUnpack	A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.	{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]}
electron-builder.json	beforeBuild	The function (or path to file or module id) to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Resolving to `false` will skip dependencies install or rebuild. If provided and `node_modules` are missing, it will not invoke production dependencies check.	{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}
electron-builder.json	buildDependenciesFromSource	Whether to build the application native dependencies from source.	{"default": false, "type": "boolean"}
electron-builder.json	buildVersion	The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`. If `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_NUMBER` or `bamboo.buildNumber` env defined, it will be used as a build version (`version.build_number`).	{"type": ["null", "string"]}
electron-builder.json	compression	The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.	{"anyOf": [{"enum": ["maximum", "normal", "store"], "type": "string"}, {"type": "null"}], "default": "normal"}
electron-builder.json	copyright	The human-readable copyright line for the app.	{"default": "Copyright \u00a9 year ${author}", "type": ["null", "string"]}
electron-builder.json	deb	Debian package options.	{"anyOf": [{}, {"type": "null"}]}
electron-builder.json	detectUpdateChannel	Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.	{"default": true, "type": "boolean"}
electron-builder.json	dmg	macOS DMG options.	{"anyOf": [{}, {"type": "null"}]}
electron-builder.json	electronCompile	Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.	{"type": "boolean"}
electron-builder.json	electronDist	The path to custom Electron build (e.g. `~/electron/out/R`).	{"type": "string"}
electron-builder.json	electronDownload	The [electron-download](https://github.com/electron-userland/electron-download#usage) options.	{}
electron-builder.json	electronUpdaterCompatibility	The [electron-updater compatibility](/auto-update#compatibility) semver range.	{"type": ["null", "string"]}
electron-builder.json	electronVersion	The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.	{"type": ["null", "string"]}
electron-builder.json	extends	The name of a built-in configuration preset or path to config file (relative to project dir). Currently, only `react-cra` is supported. If `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.	{"type": ["null", "string"]}
electron-builder.json	extraMetadata	Inject properties to `package.json`.	{}
electron-builder.json	fileAssociations	The file associations.	{"anyOf": [{}, {"items": {}, "type": "array"}]}
electron-builder.json	forceCodeSigning	Whether to fail if app will be not code signed.	{"type": "boolean"}
electron-builder.json	framework	The framework name. One of `electron`, `proton-native`, `libui`. Defaults to `electron`.	{"type": ["null", "string"]}
electron-builder.json	generateUpdatesFilesForAllChannels	Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).	{"default": false, "type": "boolean"}
electron-builder.json	includePdb	Whether to include PDB files.	{"default": false, "type": "boolean"}
electron-builder.json	launchUiVersion	libui-based frameworks only The version of LaunchUI you are packaging for. Applicable for Windows only. Defaults to version suitable for used framework version.	{"type": ["null", "string", "boolean"]}
electron-builder.json	linux	Options related to how build Linux targets.	{"anyOf": [{}, {"type": "null"}]}

electron-builder.json

publishAutoUpdate

Whether to publish auto update info files. Auto update relies only on the first provider in the list (you can specify several publishers). Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.

{"default": true, "type": "boolean"}

electron-builder.json

region

The region. Is determined and set automatically when publishing.

{"type": ["null", "string"]}

electron-builder.json

storageClass

The type of storage to use for the object.

{"anyOf": [{"enum": ["REDUCED_REDUNDANCY", "STANDARD", "STANDARD_IA"], "type": "string"}, {"type": "null"}], "default": "STANDARD"}

electron-builder.json

after

Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part. Defaults to `["desktop-gtk2""]`. If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom parts `foo` in addition to defaults.

{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}

electron-builder.json

artifactName

The [artifact file name template](/configuration/configuration#artifact-file-name-template).

{"type": ["null", "string"]}

electron-builder.json

assumes

The list of features that must be supported by the core in order for this snap to install.

{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]}

electron-builder.json

buildPackages

The list of debian packages needs to be installed for building this snap.

{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}

electron-builder.json

category

The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).

{"type": ["null", "string"]}

electron-builder.json

confinement

The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap.

{"anyOf": [{"enum": ["classic", "devmode", "strict"], "type": "string"}, {"type": "null"}], "default": "strict"}

electron-builder.json

description

As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.

{"type": ["null", "string"]}

electron-builder.json

desktop

The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value).

{}

electron-builder.json

environment

The custom environment. Defaults to `{"TMPDIR: "$XDG_RUNTIME_DIR"}`. If you set custom, it will be merged with default.

{"anyOf": [{}, {"type": "null"}]}

electron-builder.json

grade

The quality grade of the snap. It can be either `devel` (i.e. a development version of the snap, so not to be published to the "stable" or "candidate" channels) or "stable" (i.e. a stable release or release candidate, which can be released to all channels).

{"anyOf": [{"enum": ["devel", "stable"], "type": "string"}, {"type": "null"}], "default": "stable"}

electron-builder.json

hooks

The [hooks](https://docs.snapcraft.io/build-snaps/hooks) directory, relative to `build` (build resources directory).

{"default": "build/snap-hooks", "type": ["null", "string"]}

electron-builder.json

mimeTypes

The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing.

{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}

electron-builder.json

plugs

The list of [plugs](https://snapcraft.io/docs/reference/interfaces). Defaults to `["desktop", "desktop-legacy", "home", "x11", "unity7", "browser-support", "network", "gsettings", "pulseaudio", "opengl"]`. If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom plug `foo` in addition to defaults. Additional attributes can be specified using object instead of just name of plug: ``` [ { "browser-sandbox": { "interface": "browser-support", "allow-sandbox": true }, }, "another-simple-plug-name" ] ```

{"anyOf": [{}, {"items": {"anyOf": [{}, {"type": "string"}]}, "type": "array"}, {"type": "null"}]}

electron-builder.json

stagePackages

The list of Ubuntu packages to use that are needed to support the `app` part creation. Like `depends` for `deb`. Defaults to `["libasound2", "libgconf2-4", "libnotify4", "libnspr4", "libnss3", "libpcre3", "libpulse0", "libxss1", "libxtst6"]`. If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom package `foo` in addition to defaults.

{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}

electron-builder.json

summary

The 78 character long summary. Defaults to [productName](/configuration/configuration#Configuration-productName).

{"type": ["null", "string"]}

electron-builder.json

synopsis

The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).

{"type": ["null", "string"]}

electron-builder.json

useTemplateApp

Whether to use template snap. Defaults to `true` if `stagePackages` not specified.

{"type": "boolean"}

electron-builder.json

SpacesOptions

[DigitalOcean Spaces](https://www.digitalocean.com/community/tutorials/an-introduction-to-digitalocean-spaces) options. Access key is required, define `DO_KEY_ID` and `DO_SECRET_KEY` environment variables.

{"additionalProperties": false, "properties": {"acl": {"anyOf": [{"enum": ["private", "public-read"], "type": "string"}, {"type": "null"}], "default": "public-read"}, "channel": {"default": "latest", "type": ["null", "string"]}, "name": {"type": "string"}, "path": {"default": "/", "type": ["null", "string"]}, "provider": {"enum": ["spaces"], "type": "string"}, "publishAutoUpdate": {"default": true, "type": "boolean"}, "publisherName": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}, "region": {"type": "string"}, "updaterCacheDirName": {"type": ["null", "string"]}}, "required": ["name", "provider", "region"], "type": "object"}

electron-builder.json

acl

The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).

{"anyOf": [{"enum": ["private", "public-read"], "type": "string"}, {"type": "null"}], "default": "public-read"}

electron-builder.json

channel

The update channel.

{"default": "latest", "type": ["null", "string"]}

electron-builder.json

name

The space name.

{"type": "string"}

electron-builder.json

path

The directory path.

{"default": "/", "type": ["null", "string"]}

electron-builder.json

provider

The provider. Must be `spaces`.

{"enum": ["spaces"], "type": "string"}

electron-builder.json

publishAutoUpdate

Whether to publish auto update info files. Auto update relies only on the first provider in the list (you can specify several publishers). Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.

{"default": true, "type": "boolean"}

electron-builder.json

region

The region (e.g. `nyc3`).

{"type": "string"}

electron-builder.json

artifactName

The [artifact file name template](/configuration/configuration#artifact-file-name-template).

{"type": ["null", "string"]}

electron-builder.json

iconUrl

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

{"type": ["null", "string"]}

electron-builder.json

loadingGif

The path to a .gif file to display during install. `build/install-spinner.gif` 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)).

{"type": ["null", "string"]}

electron-builder.json

msi

Whether to create an MSI installer. Defaults to `false` (MSI is not created).

{"type": "boolean"}

electron-builder.json

name

https://github.com/electron-userland/electron-builder/issues/1743

{"type": "string"}

electron-builder.json

remoteReleases

A URL to your existing updates. Or `true` to automatically set to your GitHub repository. If given, these will be downloaded to create delta updates.

{"type": ["null", "string", "boolean"]}

electron-builder.json

remoteToken

Authentication token for remote updates

{"type": ["null", "string"]}

electron-builder.json

useAppIdAsId

Use `appId` to identify package instead of `name`.

{"type": "boolean"}

electron-builder.json

arch

The arch or list of archs.

{"anyOf": [{"items": {"enum": ["arm64", "armv7l", "ia32", "x64"], "type": "string"}, "type": "array"}, {"enum": ["arm64", "armv7l", "ia32", "x64"], "type": "string"}]}

electron-builder.json

target

The target name. e.g. `snap`.

{"type": "string"}

electron-builder.json

additionalCertificateFile

The path to an additional certificate file you want to add to the signature block.

{"type": ["null", "string"]}

electron-builder.json

appId

The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.

{"default": "com.electron.${name}", "type": ["null", "string"]}

electron-builder.json

artifactName

The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).

{"type": ["null", "string"]}

electron-builder.json

asar

Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/). Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.

{"anyOf": [{}, {"type": ["null", "boolean"]}], "default": true}

electron-builder.json

asarUnpack

A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.

{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]}

electron-builder.json

certificateFile

The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable `CSC_LINK` (`WIN_CSC_LINK`) for some reason. Please see [Code Signing](/code-signing).

{"type": ["null", "string"]}

electron-builder.json

certificatePassword

The password to the certificate provided in `certificateFile`. Please use it only if you cannot use env variable `CSC_KEY_PASSWORD` (`WIN_CSC_KEY_PASSWORD`) for some reason. Please see [Code Signing](/code-signing).

{"type": ["null", "string"]}

electron-builder.json

certificateSha1

The SHA1 hash of the signing certificate. The SHA1 hash is commonly specified when multiple certificates satisfy the criteria specified by the remaining switches. Works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).

{"type": ["null", "string"]}

electron-builder.json

certificateSubjectName

The name of the subject of the signing certificate. Required only for EV Code Signing and works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).

{"type": ["null", "string"]}

electron-builder.json

compression

The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.

{"anyOf": [{"enum": ["maximum", "normal", "store"], "type": "string"}, {"type": "null"}], "default": "normal"}

electron-builder.json

detectUpdateChannel

Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.

{"default": true, "type": "boolean"}

electron-builder.json

electronUpdaterCompatibility

The [electron-updater compatibility](/auto-update#compatibility) semver range.

{"type": ["null", "string"]}

electron-builder.json

fileAssociations

The file associations.

{"anyOf": [{}, {"items": {}, "type": "array"}]}

electron-builder.json

forceCodeSigning

Whether to fail if app will be not code signed.

{"type": "boolean"}

electron-builder.json

generateUpdatesFilesForAllChannels

Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).

{"default": false, "type": "boolean"}

electron-builder.json

icon

The path to application icon.

{"default": "build/icon.ico", "type": ["null", "string"]}

electron-builder.json

legalTrademarks

The trademarks and registered trademarks.

{"type": ["null", "string"]}

electron-builder.json

protocols

The URL protocol schemes.

{"anyOf": [{}, {"items": {}, "type": "array"}]}

electron-builder.json

publisherName

[The publisher name](https://github.com/electron-userland/electron-builder/issues/1187#issuecomment-278972073), exactly as in your code signed certificate. Several names can be provided. Defaults to common name from your code signing certificate.

{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]}

electron-builder.json

releaseInfo

The release info. Intended for command line usage: ``` -c.releaseInfo.releaseNotes="new features" ```

{}

electron-builder.json

requestedExecutionLevel

The [security level](https://msdn.microsoft.com/en-us/library/6ad1fshk.aspx#Anchor_9) at which the application requests to be executed. Cannot be specified per target, allowed only in the `win`.

{"anyOf": [{"enum": ["asInvoker", "highestAvailable", "requireAdministrator"], "type": "string"}, {"type": "null"}], "default": "asInvoker"}

electron-builder.json

rfc3161TimeStampServer

The URL of the RFC 3161 time stamp server.

{"default": "http://timestamp.comodoca.com/rfc3161", "type": ["null", "string"]}

electron-builder.json

sign

The custom function (or path to file or module id) to sign Windows executable.

{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}

electron-builder.json

signAndEditExecutable

Whether to sign and add metadata to executable. Advanced option.

{"default": true, "type": "boolean"}

electron-builder.json

signDlls

Whether to sign DLL files. Advanced option.

{"default": false, "type": "boolean"}

electron-builder.json

signingHashAlgorithms

Array of signing algorithms used. For AppX `sha256` is always used.

{"anyOf": [{"items": {"enum": ["sha1", "sha256"], "type": "string"}, "type": "array"}, {"type": "null"}], "default": "['sha1', 'sha256']"}

electron-builder.json

target

The target package type: list of `nsis`, `nsis-web` (Web installer), `portable` ([portable](/configuration/nsis#portable) app without installation), `appx`, `msi`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. AppX package can be built only on Windows 10. To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency.

{"anyOf": [{}, {"items": {"anyOf": [{}, {"type": "string"}]}, "type": "array"}, {"type": ["null", "string"]}], "default": "nsis"}

electron-builder.json

timeStampServer

The URL of the time stamp server.

{"default": "http://timestamp.verisign.com/scripts/timstamp.dll", "type": ["null", "string"]}

electron-builder.json

verifyUpdateCodeSignature

Whether to verify the signature of an available update before installation. The [publisher name](#publisherName) will be used for the signature verification.

{"default": true, "type": "boolean"}

electron-builder.json

$schema

JSON Schema for this document.

{"type": ["null", "string"]}

electron-builder.json

afterAllArtifactBuild

The function (or path to file or module id) to be [run after all artifacts are build](#afterAllArtifactBuild).

{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}

electron-builder.json

afterPack

The function (or path to file or module id) to be [run after pack](#afterpack) (but before pack into distributable format and sign).

{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}

electron-builder.json

afterSign

The function (or path to file or module id) to be [run after pack and sign](#aftersign) (but before pack into distributable format).

{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}

electron-builder.json

appId

The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.

{"default": "com.electron.${name}", "type": ["null", "string"]}

electron-builder.json

appImage

AppImage options.

{"anyOf": [{}, {"type": "null"}]}

electron-builder.json

artifactBuildCompleted

The function (or path to file or module id) to be run on artifact build completed.

{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}

electron-builder.json

artifactBuildStarted

The function (or path to file or module id) to be run on artifact build start.

{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}

electron-builder.json

artifactName

The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).

{"type": ["null", "string"]}

electron-builder.json

asar

Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/). Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.

{"anyOf": [{}, {"type": ["null", "boolean"]}], "default": true}

electron-builder.json

asarUnpack

A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.

{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]}

electron-builder.json

beforeBuild

The function (or path to file or module id) to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Resolving to `false` will skip dependencies install or rebuild. If provided and `node_modules` are missing, it will not invoke production dependencies check.

{"anyOf": [{"typeof": "function"}, {"type": ["null", "string"]}]}

electron-builder.json

buildDependenciesFromSource

Whether to build the application native dependencies from source.

{"default": false, "type": "boolean"}

electron-builder.json

buildVersion

The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`. If `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_NUMBER` or `bamboo.buildNumber` env defined, it will be used as a build version (`version.build_number`).

{"type": ["null", "string"]}

electron-builder.json

compression

The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.

{"anyOf": [{"enum": ["maximum", "normal", "store"], "type": "string"}, {"type": "null"}], "default": "normal"}

electron-builder.json

copyright

The human-readable copyright line for the app.

{"default": "Copyright \u00a9 year ${author}", "type": ["null", "string"]}

electron-builder.json

deb

Debian package options.

{"anyOf": [{}, {"type": "null"}]}

electron-builder.json

detectUpdateChannel

Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.

{"default": true, "type": "boolean"}

electron-builder.json

dmg

macOS DMG options.

{"anyOf": [{}, {"type": "null"}]}

electron-builder.json

electronCompile

Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.

{"type": "boolean"}

electron-builder.json

electronDist

The path to custom Electron build (e.g. `~/electron/out/R`).

{"type": "string"}

electron-builder.json

electronDownload

The [electron-download](https://github.com/electron-userland/electron-download#usage) options.

{}

electron-builder.json

electronUpdaterCompatibility

The [electron-updater compatibility](/auto-update#compatibility) semver range.

{"type": ["null", "string"]}

electron-builder.json

electronVersion

The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.

{"type": ["null", "string"]}

electron-builder.json

extends

The name of a built-in configuration preset or path to config file (relative to project dir). Currently, only `react-cra` is supported. If `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.

{"type": ["null", "string"]}

electron-builder.json

extraMetadata

Inject properties to `package.json`.

{}

electron-builder.json

fileAssociations

The file associations.

{"anyOf": [{}, {"items": {}, "type": "array"}]}

electron-builder.json

forceCodeSigning

Whether to fail if app will be not code signed.

{"type": "boolean"}

electron-builder.json

framework

The framework name. One of `electron`, `proton-native`, `libui`. Defaults to `electron`.

{"type": ["null", "string"]}

electron-builder.json

generateUpdatesFilesForAllChannels

Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).

{"default": false, "type": "boolean"}

electron-builder.json

includePdb

Whether to include PDB files.

{"default": false, "type": "boolean"}

electron-builder.json

launchUiVersion

*libui-based frameworks only* The version of LaunchUI you are packaging for. Applicable for Windows only. Defaults to version suitable for used framework version.

{"type": ["null", "string", "boolean"]}

electron-builder.json

linux

Options related to how build Linux targets.

{"anyOf": [{}, {"type": "null"}]}