Snap

The top-level snap key contains set of options instructing electron-builder on how it should build Snap.

  • confinement = strict “devmode” | “strict” | “classic” - The type of confinement supported by the snap.
  • environment any - The custom environment. Defaults to {"TMPDIR: "$XDG_RUNTIME_DIR"}. If you set custom, it will be merged with default.
  • summary String
  • grade = stable “devel” | “stable” - 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).
  • assumes Array<String> | String - The list of features that must be supported by the core in order for this snap to install.
  • buildPackages Array<String> - The list of debian packages needs to be installed for building this snap.
  • stagePackages Array<String> - 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.

  • hooks = build/snap-hooks String - The hooks directory, relative to build (build resources directory).

  • plugs Array<String | SnapOptions.PlugDescriptor> - The list of plugs. 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" ]

  • after Array<String> - Specifies any 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.

  • useTemplateApp Boolean - Whether to use template snap. Defaults to true if stagePackages not specified.

Inherited from CommonLinuxOptions:

  • synopsis String - The short description.
  • description String - As description from application package.json, but allows you to specify different for Linux.
  • category String - The application category.
  • mimeTypes Array<String> - 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.
  • desktop any - The Desktop file entries (name to value).

Inherited from TargetSpecificOptions: