Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files
xet
Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
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
packageCategory
backward compatibility + to allow specify fpm-only category for all possible fpm targets in one place
{"type": ["null", "string"]}
electron-builder.json
protocols
The URL protocol schemes.
{"anyOf": [{}, {"items": {}, "type": "array"}]}
electron-builder.json
releaseInfo
The release info. Intended for command line usage: ``` -c.releaseInfo.releaseNotes="new features" ```
{}
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
target
Target package type: list of `AppImage`, `snap`, `deb`, `rpm`, `freebsd`, `pacman`, `p5p`, `apk`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. electron-builder [docker image](/multi-platform-build#docker) can be used to build Linux targets on any platform. Please [do not put an AppImage into another archive](https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages#common-mistake) like a .zip or .tar.gz.
{"anyOf": [{}, {"items": {"anyOf": [{}, {"type": "string"}]}, "type": "array"}, {"type": ["null", "string"]}], "default": "AppImage"}
electron-builder.json
vendor
The vendor. Defaults to [author](/configuration/configuration#Metadata-author).
{"type": ["null", "string"]}
electron-builder.json
artifactName
The [artifact file name template](/configuration/configuration#artifact-file-name-template).
{"type": ["null", "string"]}
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
compression
The compression type.
{"anyOf": [{"enum": ["bzip2", "gz", "xz"], "type": "string"}, {"type": "null"}], "default": "xz"}
electron-builder.json
depends
Package dependencies.
{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}
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
fpm
*Advanced only* The [fpm](https://github.com/jordansissel/fpm/wiki#usage) options. Example: `["--before-install=build/deb-preinstall.sh", "--after-upgrade=build/deb-postinstall.sh"]`
{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}
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
packageCategory
The package category.
{"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
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
binaries
Paths of any extra binaries that need to be signed.
{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}
electron-builder.json
bundleShortVersion
The `CFBundleShortVersionString`. Do not use it unless you need to.
{"type": ["null", "string"]}
electron-builder.json
bundleVersion
The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).
{"type": ["null", "string"]}
electron-builder.json
category
The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory. For example, `"category": "public.app-category.developer-tools"` will set the application category to *Developer Tools*. Valid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).
{"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
darkModeSupport
Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.
{"default": false, "type": "boolean"}
electron-builder.json
hardenedRuntime
Whether your app has to be signed with hardened runtime.
{"default": false, "type": "boolean"}
electron-builder.json
gatekeeperAssess
Whether to let electron-osx-sign validate the signing or not.
{"default": false, "type": "boolean"}
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
electronLanguages
The electron locales. By default Electron locales used as is.
{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}
electron-builder.json
electronUpdaterCompatibility
The [electron-updater compatibility](/auto-update#compatibility) semver range.
{"type": ["null", "string"]}
electron-builder.json
entitlements
The path to entitlements file for signing the app. `build/entitlements.mac.plist` will be used if exists (it is a recommended way to set). MAS entitlements is specified in the [mas](/configuration/mas).
{"type": ["null", "string"]}
electron-builder.json
entitlementsInherit
The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mac.inherit.plist` will be used if exists (it is a recommended way to set). Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist). This option only applies when signing with `entitlements` provided.
{"type": ["null", "string"]}
electron-builder.json
extendInfo
The extra entries for `Info.plist`.
{}
electron-builder.json
extraDistFiles
Extra files to put in archive. Not applicable for `tar.*`.
{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"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
helperBundleId
The bundle identifier to use in the application helper's plist.
{"default": "${appBundleIdentifier}.helper", "type": ["null", "string"]}
electron-builder.json
icon
The path to application icon.
{"default": "build/icon.icns", "type": ["null", "string"]}
electron-builder.json
identity
The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option. MAS installer identity is specified in the [mas](/configuration/mas).
{"type": ["null", "string"]}
electron-builder.json
minimumSystemVersion
The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.
{"type": ["null", "string"]}
electron-builder.json
protocols
The URL protocol schemes.
{"anyOf": [{}, {"items": {}, "type": "array"}]}
electron-builder.json
provisioningProfile
The path to the provisioning profile to use when signing, absolute or relative to the app root.
{"type": ["null", "string"]}
electron-builder.json
releaseInfo
The release info. Intended for command line usage: ``` -c.releaseInfo.releaseNotes="new features" ```
{}
electron-builder.json
requirements
Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.
{"type": ["null", "string"]}
electron-builder.json
target
The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac).
{"anyOf": [{}, {"items": {"anyOf": [{}, {"enum": ["7z", "default", "dir", "dmg", "mas", "mas-dev", "pkg", "tar.bz2", "tar.gz", "tar.lz", "tar.xz", "zip"], "type": "string"}]}, "type": "array"}, {"enum": ["7z", "default", "dir", "dmg", "mas", "mas-dev", "pkg", "tar.bz2", "tar.gz", "tar.lz", "tar.xz", "zip"], "type": "string"}, {"type": "null"}]}
electron-builder.json
type
Whether to sign app for development or for distribution.
{"anyOf": [{"enum": ["development", "distribution"], "type": "string"}, {"type": "null"}], "default": "distribution"}
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
binaries
Paths of any extra binaries that need to be signed.
{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}
electron-builder.json
bundleShortVersion
The `CFBundleShortVersionString`. Do not use it unless you need to.
{"type": ["null", "string"]}
electron-builder.json
bundleVersion
The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).
{"type": ["null", "string"]}
electron-builder.json
category
The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory. For example, `"category": "public.app-category.developer-tools"` will set the application category to *Developer Tools*. Valid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).
{"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
darkModeSupport
Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.
{"default": false, "type": "boolean"}
electron-builder.json
hardenedRuntime
Whether your app has to be signed with hardened runtime.
{"default": false, "type": "boolean"}
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
electronLanguages
The electron locales. By default Electron locales used as is.
{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}
electron-builder.json
electronUpdaterCompatibility
The [electron-updater compatibility](/auto-update#compatibility) semver range.
{"type": ["null", "string"]}
electron-builder.json
entitlements
The path to entitlements file for signing the app. `build/entitlements.mas.plist` will be used if exists (it is a recommended way to set). Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist).
{"type": ["null", "string"]}
electron-builder.json
entitlementsInherit
The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mas.inherit.plist` will be used if exists (it is a recommended way to set). Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist).
{"type": ["null", "string"]}
electron-builder.json
extendInfo
The extra entries for `Info.plist`.
{}
electron-builder.json
extraDistFiles
Extra files to put in archive. Not applicable for `tar.*`.
{"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"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
helperBundleId
The bundle identifier to use in the application helper's plist.
{"default": "${appBundleIdentifier}.helper", "type": ["null", "string"]}
electron-builder.json
icon
The path to application icon.
{"default": "build/icon.icns", "type": ["null", "string"]}
electron-builder.json
identity
The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option. MAS installer identity is specified in the [mas](/configuration/mas).
{"type": ["null", "string"]}
electron-builder.json
minimumSystemVersion
The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.
{"type": ["null", "string"]}
electron-builder.json
protocols
The URL protocol schemes.
{"anyOf": [{}, {"items": {}, "type": "array"}]}
electron-builder.json
provisioningProfile
The path to the provisioning profile to use when signing, absolute or relative to the app root.
{"type": ["null", "string"]}
electron-builder.json
releaseInfo
The release info. Intended for command line usage: ``` -c.releaseInfo.releaseNotes="new features" ```
{}
electron-builder.json
requirements
Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.
{"type": ["null", "string"]}
electron-builder.json
target
The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac).
{"anyOf": [{}, {"items": {"anyOf": [{}, {"enum": ["7z", "default", "dir", "dmg", "mas", "mas-dev", "pkg", "tar.bz2", "tar.gz", "tar.lz", "tar.xz", "zip"], "type": "string"}]}, "type": "array"}, {"enum": ["7z", "default", "dir", "dmg", "mas", "mas-dev", "pkg", "tar.bz2", "tar.gz", "tar.lz", "tar.xz", "zip"], "type": "string"}, {"type": "null"}]}
electron-builder.json
type
Whether to sign app for development or for distribution.
{"anyOf": [{"enum": ["development", "distribution"], "type": "string"}, {"type": "null"}], "default": "distribution"}
electron-builder.json
app
The application directory (containing the application package.json), defaults to `app`, `www` or working directory.
{"type": ["null", "string"]}
electron-builder.json
buildResources
The path to build resources. Please note — build resources is not packed into the app. If you need to use some files, e.g. as tray icon, please include required files explicitly: `"files": ["**\/*", "build/icon.*"]`
{"default": "build", "type": ["null", "string"]}
electron-builder.json
output
The output directory. [File macros](/file-patterns#file-macros) are supported.
{"default": "dist", "type": ["null", "string"]}
electron-builder.json
artifactName
The [artifact file name template](/configuration/configuration#artifact-file-name-template).
{"type": ["null", "string"]}
electron-builder.json
createDesktopShortcut
Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).
{"default": true, "enum": ["always", false, true]}
electron-builder.json
createStartMenuShortcut
Whether to create start menu shortcut.
{"default": true, "type": "boolean"}
electron-builder.json
menuCategory
Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.
{"default": false, "type": ["string", "boolean"]}
electron-builder.json
oneClick
One-click installation.
{"default": true, "type": "boolean"}
electron-builder.json
perMachine
Whether to install per all users (per-machine).
{"default": false, "type": "boolean"}
electron-builder.json
runAfterFinish
Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.
{"default": true, "type": "boolean"}
electron-builder.json
shortcutName
The name that will be used for all shortcuts. Defaults to the application name.
{"type": ["null", "string"]}
electron-builder.json
upgradeCode
The [upgrade code](https://msdn.microsoft.com/en-us/library/windows/desktop/aa372375(v=vs.85).aspx). Optional, by default generated using app id.
{"type": ["null", "string"]}
electron-builder.json
warningsAsErrors
If `warningsAsErrors` is `true` (default): treat warnings as errors. If `warningsAsErrors` is `false`: allow warnings.
{"default": true, "type": "boolean"}
electron-builder.json
allowElevation
*assisted installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.
{"default": true, "type": "boolean"}
electron-builder.json
allowToChangeInstallationDirectory
*assisted installer only.* Whether to allow user to change installation directory.
{"default": false, "type": "boolean"}
electron-builder.json
artifactName
The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Setup ${version}.${ext}`.
{"type": ["null", "string"]}
electron-builder.json
createDesktopShortcut
Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).
{"default": true, "enum": ["always", false, true]}
electron-builder.json
createStartMenuShortcut
Whether to create start menu shortcut.
{"default": true, "type": "boolean"}
electron-builder.json
deleteAppDataOnUninstall
*one-click installer only.* Whether to delete app data on uninstall.
{"default": false, "type": "boolean"}
electron-builder.json
differentialPackage
Defaults to `true` for web installer (`nsis-web`)
{"type": "boolean"}