81 lines
3.5 KiB
TypeScript
81 lines
3.5 KiB
TypeScript
|
import { TargetSpecificOptions } from "../core";
|
||
|
|
import { CommonLinuxOptions } from "./linuxOptions";
|
||
|
|
export interface SnapOptions extends CommonLinuxOptions, TargetSpecificOptions {
|
||
|
|
/**
|
||
|
|
* The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap.
|
||
|
|
* @default strict
|
||
|
|
*/
|
||
|
|
readonly confinement?: "devmode" | "strict" | "classic" | null;
|
||
|
|
/**
|
||
|
|
* The custom environment. Defaults to `{"TMPDIR: "$XDG_RUNTIME_DIR"}`. If you set custom, it will be merged with default.
|
||
|
|
*/
|
||
|
|
readonly environment?: {
|
||
|
|
[key: string]: string;
|
||
|
|
} | null;
|
||
|
|
/**
|
||
|
|
* The 78 character long summary. Defaults to [productName](/configuration/configuration#Configuration-productName).
|
||
|
|
*/
|
||
|
|
readonly summary?: string | null;
|
||
|
|
/**
|
||
|
|
* 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).
|
||
|
|
* @default stable
|
||
|
|
*/
|
||
|
|
readonly grade?: "devel" | "stable" | null;
|
||
|
|
/**
|
||
|
|
* The list of features that must be supported by the core in order for this snap to install.
|
||
|
|
*/
|
||
|
|
readonly assumes?: Array<string> | string | null;
|
||
|
|
/**
|
||
|
|
* The list of debian packages needs to be installed for building this snap.
|
||
|
|
*/
|
||
|
|
readonly buildPackages?: Array<string> | null;
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
*/
|
||
|
|
readonly stagePackages?: Array<string> | null;
|
||
|
|
/**
|
||
|
|
* The [hooks](https://docs.snapcraft.io/build-snaps/hooks) directory, relative to `build` (build resources directory).
|
||
|
|
* @default build/snap-hooks
|
||
|
|
*/
|
||
|
|
readonly hooks?: string | null;
|
||
|
|
/**
|
||
|
|
* 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"
|
||
|
|
*]
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
readonly plugs?: Array<string | PlugDescriptor> | PlugDescriptor | null;
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
*/
|
||
|
|
readonly after?: Array<string> | null;
|
||
|
|
/**
|
||
|
|
* Whether to use template snap. Defaults to `true` if `stagePackages` not specified.
|
||
|
|
*/
|
||
|
|
readonly useTemplateApp?: boolean;
|
||
|
|
}
|
||
|
|
export interface PlugDescriptor {
|
||
|
|
[key: string]: {
|
||
|
|
[key: string]: any;
|
||
|
|
} | null;
|
||
|
|
}
|