UNPKG

5.48 kBTypeScriptView Raw
1export interface MakerDebConfigOptions {
2 /**
3 * Name of the package (e.g. atom), used in the Package field of the control
4 * specification.
5 *
6 * Package names [...] must consist only of lower case letters (a-z), digits
7 * (0-9), plus (+) and minus (-) signs, and periods (.). They must be at
8 * least two characters long and must start with an alphanumeric character.
9 */
10 name?: string;
11 /**
12 * Name of the application (e.g. Atom), used in the Name field of the desktop specification.
13 */
14 productName?: string;
15 /**
16 * Generic name of the application (e.g. Text Editor), used in the GenericName field of the
17 * desktop specification.
18 */
19 genericName?: string;
20 /**
21 * Short description of the application, used in the Description field of the control
22 * specification.
23 */
24 description?: string;
25 /**
26 * Long description of the application, used in the Description field of the control
27 * specification.
28 */
29 productDescription?: string;
30 /**
31 * Version number of the package, used in the Version field of the control specification.
32 */
33 version?: string;
34 /**
35 * Revision number of the package, used in the Version field of the control specification.
36 */
37 revision?: string;
38 /**
39 * Application area into which the package has been classified.
40 *
41 * Possible sections. Generated on https://packages.debian.org/unstable/ with:
42 *
43 * ```javascript
44 * $$('#content dt a').map(n => {
45 * const ss = n.href.split('/');
46 * return `'${ss[ss.length - 2]}'`;
47 * }).sort().join(' | ')
48 * ```
49 */
50 section?: 'admin' | 'cli-mono' | 'comm' | 'database' | 'debian-installer' | 'debug' | 'devel' | 'doc' | 'editors' | 'education' | 'electronics' | 'embedded' | 'fonts' | 'games' | 'gnome' | 'gnu-r' | 'gnustep' | 'graphics' | 'hamradio' | 'haskell' | 'httpd' | 'interpreters' | 'introspection' | 'java' | 'javascript' | 'kde' | 'kernel' | 'libdevel' | 'libs' | 'lisp' | 'localization' | 'mail' | 'math' | 'metapackages' | 'misc' | 'net' | 'news' | 'ocaml' | 'oldlibs' | 'otherosfs' | 'perl' | 'php' | 'python' | 'ruby' | 'rust' | 'science' | 'shells' | 'sound' | 'tasks' | 'tex' | 'text' | 'utils' | 'vcs' | 'video' | 'virtual' | 'web' | 'x11' | 'xfce' | 'zope';
51 /**
52 * How important is it to have the package installed.
53 *
54 * You can read more: https://www.debian.org/doc/debian-policy/#priorities
55 */
56 priority?: 'required' | 'important' | 'standard' | 'optional';
57 /**
58 * Estimate of the total amount of disk space required to install the named package,
59 * used in the Installed-Size field of the control specification.
60 */
61 size?: number;
62 /**
63 * Relationships to other packages, used in the Depends field of the control specification.
64 */
65 depends?: string[];
66 /**
67 * Relationships to other packages, used in the Recommends field of the control specification.
68 */
69 recommends?: string[];
70 /**
71 * Relationships to other packages, used in the Suggests field of the control specification.
72 */
73 suggests?: string[];
74 /**
75 * Relationships to other packages, used in the Enhances field of the control specification.
76 */
77 enhances?: string[];
78 /**
79 * Relationships to other packages, used in the Pre-Depends field of the control specification.
80 */
81 preDepends?: string[];
82 /**
83 * Maintainer of the package, used in the Maintainer field of the control specification.
84 */
85 maintainer?: string;
86 /**
87 * URL of the homepage for the package, used in the Homepage field of the control specification.
88 */
89 homepage?: string;
90 /**
91 * Relative path to the executable that will act as binary for the application, used in the Exec
92 * field of the desktop specification.
93 *
94 * Defaults to options.name
95 */
96 bin?: string;
97 /**
98 * Path to a single image that will act as icon for the application:
99 */
100 icon?: string;
101 /**
102 * Categories in which the application should be shown in a menu, used in the Categories field
103 * of the desktop specification.
104 *
105 * Generated on https://specifications.freedesktop.org/menu-spec/latest/apa.html with:
106 *
107 * `(${$$('.informaltable tr td:first-child').map(td => `'$\{td.innerText\}'`).join(' | ')})[]`
108 */
109 categories?: ('AudioVideo' | 'Audio' | 'Video' | 'Development' | 'Education' | 'Game' | 'Graphics' | 'Network' | 'Office' | 'Science' | 'Settings' | 'System' | 'Utility')[];
110 /**
111 * MIME types the application is able to open, used in the MimeType field of the desktop
112 * specification.
113 */
114 mimeType?: string[];
115 /**
116 * You can use these to quieten lintian.
117 */
118 lintianOverrides?: string[];
119 /**
120 * Path to package maintainer scripts with their corresponding name, used in the installation
121 * procedure.
122 *
123 * Read More:
124 * https://www.debian.org/doc/debian-policy/#package-maintainer-scripts-and-installation-procedure
125 */
126 scripts?: {
127 preinst?: string;
128 postinst?: string;
129 prerm?: string;
130 postrm?: string;
131 };
132 /**
133 * The absolute path to a custom template for the generated FreeDesktop.org desktop entry file.
134 */
135 desktopTemplate?: string;
136}
137export interface MakerDebConfig {
138 options?: MakerDebConfigOptions;
139}
140//# sourceMappingURL=Config.d.ts.map
\No newline at end of file