@electron-forge/shared-types 6.0.0-beta.7 → 6.0.0-beta.70

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/dist/index.d.ts +90 -25
  2. package/dist/index.d.ts.map +1 -0
  3. package/dist/index.js +4 -2
  4. package/index.ts +3 -0
  5. package/package.json +9 -11
  6. package/src/index.ts +206 -117
  7. package/tsconfig.json +34 -21
  8. package/tsconfig.tsbuildinfo +1 -0
  9. package/doc/assets/css/main.css +0 -865
  10. package/doc/assets/css/main.css.map +0 -7
  11. package/doc/assets/images/icons.png +0 -0
  12. package/doc/assets/images/icons@2x.png +0 -0
  13. package/doc/assets/images/widgets.png +0 -0
  14. package/doc/assets/images/widgets@2x.png +0 -0
  15. package/doc/assets/js/main.js +0 -5
  16. package/doc/assets/js/search.js +0 -3
  17. package/doc/globals.html +0 -265
  18. package/doc/index.html +0 -267
  19. package/doc/interfaces/forgeconfig.html +0 -341
  20. package/doc/interfaces/forgemakeresult.html +0 -287
  21. package/doc/interfaces/iforgemaker.html +0 -239
  22. package/doc/interfaces/iforgeplugin.html +0 -334
  23. package/doc/interfaces/iforgeplugininterface.html +0 -268
  24. package/doc/interfaces/iforgepublisher.html +0 -239
  25. package/doc/interfaces/iforgeresolvablemaker.html +0 -253
  26. package/doc/interfaces/iforgeresolvablepublisher.html +0 -253
  27. package/doc/interfaces/startoptions.html +0 -344
  28. package/index.d.ts +0 -119
  29. package/tslint.json +0 -12
package/doc/interfaces/startoptions.html DELETED
@@ -1,344 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>StartOptions | @electron-forge/shared-types</title>
7
- <meta name="description" content="">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- </head>
11
- <body>
12
- <header>
13
- <div class="tsd-page-toolbar">
14
- <div class="container">
15
- <div class="table-wrap">
16
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
- <div class="field">
18
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
- <input id="tsd-search-field" type="text" />
20
- </div>
21
- <ul class="results">
22
- <li class="state loading">Preparing search index...</li>
23
- <li class="state failure">The search index is not available</li>
24
- </ul>
25
- <a href="../index.html" class="title">@electron-forge/shared-types</a>
26
- </div>
27
- <div class="table-cell" id="tsd-widgets">
28
- <div id="tsd-filter">
29
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
- <div class="tsd-filter-group">
31
- <div class="tsd-select" id="tsd-filter-visibility">
32
- <span class="tsd-select-label">All</span>
33
- <ul class="tsd-select-list">
34
- <li data-value="public">Public</li>
35
- <li data-value="protected">Public/Protected</li>
36
- <li data-value="private" class="selected">All</li>
37
- </ul>
38
- </div>
39
- <input type="checkbox" id="tsd-filter-inherited" checked />
40
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
- <input type="checkbox" id="tsd-filter-only-exported" />
42
- <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
43
- </div>
44
- </div>
45
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
46
- </div>
47
- </div>
48
- </div>
49
- </div>
50
- <div class="tsd-page-title">
51
- <div class="container">
52
- <ul class="tsd-breadcrumb">
53
- <li>
54
- <a href="../globals.html">Globals</a>
55
- </li>
56
- <li>
57
- <a href="startoptions.html">StartOptions</a>
58
- </li>
59
- </ul>
60
- <h1>Interface StartOptions</h1>
61
- </div>
62
- </div>
63
- </header>
64
- <div class="container container-main">
65
- <div class="row">
66
- <div class="col-8 col-content">
67
- <section class="tsd-panel tsd-hierarchy">
68
- <h3>Hierarchy</h3>
69
- <ul class="tsd-hierarchy">
70
- <li>
71
- <span class="target">StartOptions</span>
72
- </li>
73
- </ul>
74
- </section>
75
- <section class="tsd-panel-group tsd-index-group">
76
- <h2>Index</h2>
77
- <section class="tsd-panel tsd-index-panel">
78
- <div class="tsd-index-content">
79
- <section class="tsd-index-section ">
80
- <h3>Properties</h3>
81
- <ul class="tsd-index-list">
82
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="startoptions.html#apppath" class="tsd-kind-icon">app<wbr>Path</a></li>
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="startoptions.html#args" class="tsd-kind-icon">args</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="startoptions.html#dir" class="tsd-kind-icon">dir</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="startoptions.html#enablelogging" class="tsd-kind-icon">enable<wbr>Logging</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="startoptions.html#inspect" class="tsd-kind-icon">inspect</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="startoptions.html#interactive" class="tsd-kind-icon">interactive</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="startoptions.html#runasnode" class="tsd-kind-icon">run<wbr>AsNode</a></li>
89
- </ul>
90
- </section>
91
- </div>
92
- </section>
93
- </section>
94
- <section class="tsd-panel-group tsd-member-group ">
95
- <h2>Properties</h2>
96
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
97
- <a name="apppath" class="tsd-anchor"></a>
98
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> app<wbr>Path</h3>
99
- <div class="tsd-signature tsd-kind-icon">app<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
100
- <aside class="tsd-sources">
101
- <ul>
102
- <li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/utils/types/src/index.ts#L97">index.ts:97</a></li>
103
- </ul>
104
- </aside>
105
- <div class="tsd-comment tsd-typography">
106
- <div class="lead">
107
- <p>The path (relative to dir) to the electron app to run relative to the project directory</p>
108
- </div>
109
- </div>
110
- </section>
111
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
- <a name="args" class="tsd-anchor"></a>
113
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> args</h3>
114
- <div class="tsd-signature tsd-kind-icon">args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div>
115
- <aside class="tsd-sources">
116
- <ul>
117
- <li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/utils/types/src/index.ts#L109">index.ts:109</a></li>
118
- </ul>
119
- </aside>
120
- <div class="tsd-comment tsd-typography">
121
- <div class="lead">
122
- <p>Arguments to pass through to the launched Electron application</p>
123
- </div>
124
- </div>
125
- </section>
126
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
127
- <a name="dir" class="tsd-anchor"></a>
128
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> dir</h3>
129
- <div class="tsd-signature tsd-kind-icon">dir<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
130
- <aside class="tsd-sources">
131
- <ul>
132
- <li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/utils/types/src/index.ts#L93">index.ts:93</a></li>
133
- </ul>
134
- </aside>
135
- <div class="tsd-comment tsd-typography">
136
- <div class="lead">
137
- <p>The path to the electron forge project to run</p>
138
- </div>
139
- </div>
140
- </section>
141
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
142
- <a name="enablelogging" class="tsd-anchor"></a>
143
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr>Logging</h3>
144
- <div class="tsd-signature tsd-kind-icon">enable<wbr>Logging<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
145
- <aside class="tsd-sources">
146
- <ul>
147
- <li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/utils/types/src/index.ts#L105">index.ts:105</a></li>
148
- </ul>
149
- </aside>
150
- <div class="tsd-comment tsd-typography">
151
- <div class="lead">
152
- <p>Enables advanced internal Electron debug calls</p>
153
- </div>
154
- </div>
155
- </section>
156
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
157
- <a name="inspect" class="tsd-anchor"></a>
158
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> inspect</h3>
159
- <div class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
160
- <aside class="tsd-sources">
161
- <ul>
162
- <li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/utils/types/src/index.ts#L117">index.ts:117</a></li>
163
- </ul>
164
- </aside>
165
- <div class="tsd-comment tsd-typography">
166
- <div class="lead">
167
- <p>Enables the node inspector, you can connect to this from chrome://inspect</p>
168
- </div>
169
- </div>
170
- </section>
171
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
172
- <a name="interactive" class="tsd-anchor"></a>
173
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> interactive</h3>
174
- <div class="tsd-signature tsd-kind-icon">interactive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
175
- <aside class="tsd-sources">
176
- <ul>
177
- <li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/utils/types/src/index.ts#L101">index.ts:101</a></li>
178
- </ul>
179
- </aside>
180
- <div class="tsd-comment tsd-typography">
181
- <div class="lead">
182
- <p>Whether to use sensible defaults or prompt the user visually</p>
183
- </div>
184
- </div>
185
- </section>
186
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
187
- <a name="runasnode" class="tsd-anchor"></a>
188
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> run<wbr>AsNode</h3>
189
- <div class="tsd-signature tsd-kind-icon">run<wbr>AsNode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
190
- <aside class="tsd-sources">
191
- <ul>
192
- <li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/utils/types/src/index.ts#L113">index.ts:113</a></li>
193
- </ul>
194
- </aside>
195
- <div class="tsd-comment tsd-typography">
196
- <div class="lead">
197
- <p>Runs the Electron process as if it were node, disables all Electron API&#39;s</p>
198
- </div>
199
- </div>
200
- </section>
201
- </section>
202
- </div>
203
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
204
- <nav class="tsd-navigation primary">
205
- <ul>
206
- <li class="globals ">
207
- <a href="../globals.html"><em>Globals</em></a>
208
- </li>
209
- </ul>
210
- </nav>
211
- <nav class="tsd-navigation secondary menu-sticky">
212
- <ul class="before-current">
213
- <li class=" tsd-kind-interface">
214
- <a href="forgeconfig.html" class="tsd-kind-icon">Forge<wbr>Config</a>
215
- </li>
216
- <li class=" tsd-kind-interface">
217
- <a href="forgemakeresult.html" class="tsd-kind-icon">Forge<wbr>Make<wbr>Result</a>
218
- </li>
219
- <li class=" tsd-kind-interface">
220
- <a href="iforgemaker.html" class="tsd-kind-icon">IForge<wbr>Maker</a>
221
- </li>
222
- <li class=" tsd-kind-interface">
223
- <a href="iforgeplugin.html" class="tsd-kind-icon">IForge<wbr>Plugin</a>
224
- </li>
225
- <li class=" tsd-kind-interface">
226
- <a href="iforgeplugininterface.html" class="tsd-kind-icon">IForge<wbr>Plugin<wbr>Interface</a>
227
- </li>
228
- <li class=" tsd-kind-interface">
229
- <a href="iforgepublisher.html" class="tsd-kind-icon">IForge<wbr>Publisher</a>
230
- </li>
231
- <li class=" tsd-kind-interface">
232
- <a href="iforgeresolvablemaker.html" class="tsd-kind-icon">IForge<wbr>Resolvable<wbr>Maker</a>
233
- </li>
234
- <li class=" tsd-kind-interface">
235
- <a href="iforgeresolvablepublisher.html" class="tsd-kind-icon">IForge<wbr>Resolvable<wbr>Publisher</a>
236
- </li>
237
- </ul>
238
- <ul class="current">
239
- <li class="current tsd-kind-interface">
240
- <a href="startoptions.html" class="tsd-kind-icon">Start<wbr>Options</a>
241
- <ul>
242
- <li class=" tsd-kind-property tsd-parent-kind-interface">
243
- <a href="startoptions.html#apppath" class="tsd-kind-icon">app<wbr>Path</a>
244
- </li>
245
- <li class=" tsd-kind-property tsd-parent-kind-interface">
246
- <a href="startoptions.html#args" class="tsd-kind-icon">args</a>
247
- </li>
248
- <li class=" tsd-kind-property tsd-parent-kind-interface">
249
- <a href="startoptions.html#dir" class="tsd-kind-icon">dir</a>
250
- </li>
251
- <li class=" tsd-kind-property tsd-parent-kind-interface">
252
- <a href="startoptions.html#enablelogging" class="tsd-kind-icon">enable<wbr>Logging</a>
253
- </li>
254
- <li class=" tsd-kind-property tsd-parent-kind-interface">
255
- <a href="startoptions.html#inspect" class="tsd-kind-icon">inspect</a>
256
- </li>
257
- <li class=" tsd-kind-property tsd-parent-kind-interface">
258
- <a href="startoptions.html#interactive" class="tsd-kind-icon">interactive</a>
259
- </li>
260
- <li class=" tsd-kind-property tsd-parent-kind-interface">
261
- <a href="startoptions.html#runasnode" class="tsd-kind-icon">run<wbr>AsNode</a>
262
- </li>
263
- </ul>
264
- </li>
265
- </ul>
266
- <ul class="after-current">
267
- <li class=" tsd-kind-type-alias">
268
- <a href="../globals.html#forgearch" class="tsd-kind-icon">Forge<wbr>Arch</a>
269
- </li>
270
- <li class=" tsd-kind-type-alias">
271
- <a href="../globals.html#forgehookfn" class="tsd-kind-icon">Forge<wbr>Hook<wbr>Fn</a>
272
- </li>
273
- <li class=" tsd-kind-type-alias">
274
- <a href="../globals.html#forgeplatform" class="tsd-kind-icon">Forge<wbr>Platform</a>
275
- </li>
276
- </ul>
277
- </nav>
278
- </div>
279
- </div>
280
- </div>
281
- <footer>
282
- <div class="container">
283
- <h2>Legend</h2>
284
- <div class="tsd-legend-group">
285
- <ul class="tsd-legend">
286
- <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
287
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
288
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
289
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
290
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
291
- <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
292
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
293
- </ul>
294
- <ul class="tsd-legend">
295
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
296
- <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
297
- <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
298
- <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
299
- </ul>
300
- <ul class="tsd-legend">
301
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
302
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
303
- <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
304
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
305
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
306
- <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
307
- </ul>
308
- <ul class="tsd-legend">
309
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
310
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
311
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
312
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
313
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
314
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
315
- <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
316
- </ul>
317
- <ul class="tsd-legend">
318
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
319
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
320
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
321
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
322
- </ul>
323
- <ul class="tsd-legend">
324
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
325
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
326
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
327
- </ul>
328
- <ul class="tsd-legend">
329
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
330
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
331
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
332
- </ul>
333
- <ul class="tsd-legend">
334
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
335
- <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
336
- </ul>
337
- </div>
338
- </div>
339
- </footer>
340
- <div class="overlay"></div>
341
- <script src="../assets/js/main.js"></script>
342
- <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
343
- </body>
344
- </html>
package/index.d.ts DELETED
@@ -1,119 +0,0 @@
1
- /* tslint:disable ter-indent */
2
-
3
- import { ChildProcess } from 'child_process';
4
- import { Options } from 'electron-packager';
5
- import { RebuildOptions } from 'electron-rebuild/lib/src/rebuild';
6
-
7
- declare module '@electron-forge/shared-types' {
8
- export type ForgePlatform = 'darwin' | 'mas' | 'win32' | 'linux';
9
- export type ForgeArch = 'ia32' | 'x64' | 'armv7l' | 'arm';
10
- export type ForgeHookFn = (forgeConfig: ForgeConfig, ...args: any[]) => Promise<void>;
11
- export interface IForgePluginInterface {
12
- triggerHook(hookName: string, hookArgs: any[]): Promise<void>;
13
- overrideStartLogic(opts: any): Promise<ChildProcess | false>;
14
- }
15
- export interface ForgeConfig {
16
- /**
17
- * A string to uniquely identify artifacts of this build, will be appended
18
- * to the out dir to generate a nested directory. E.g. out/current-timestamp
19
- *
20
- * If a function is provided it must syncronously return the buildIdentifier
21
- */
22
- buildIdentifier?: string | (() => string);
23
- hooks?: {
24
- [hookName: string]: ForgeHookFn;
25
- };
26
- /**
27
- * @generated
28
- */
29
- pluginInterface: IForgePluginInterface;
30
- /**
31
- * An array of forge plugins or a tuple consisting of [pluginName, pluginOptions]
32
- */
33
- plugins: (IForgePlugin | [string, any])[];
34
- electronRebuildConfig: RebuildOptions;
35
- packagerConfig: Options;
36
- makers: (IForgeResolvableMaker | IForgeMaker)[];
37
- publishers: (IForgeResolvablePublisher | IForgePublisher | string)[];
38
- }
39
- export interface ForgeMakeResult {
40
- /**
41
- * An array of paths to artifacts generated for this make run
42
- */
43
- artifacts: string[];
44
- /**
45
- * The state of the package.json file when the make happened
46
- */
47
- packageJSON: any;
48
- /**
49
- * The platform this make run was for
50
- */
51
- platform: ForgePlatform;
52
- /**
53
- * The arch this make run was for
54
- */
55
- arch: ForgeArch;
56
- }
57
-
58
- export interface IForgePlugin {
59
- __isElectronForgePlugin: boolean;
60
- name: string;
61
-
62
- init(dir: string, forgeConfig: ForgeConfig): void;
63
- getHook?(hookName: string): ForgeHookFn | null;
64
- startLogic?(opts: StartOptions): Promise<ChildProcess | false>;
65
- }
66
-
67
- export interface IForgeResolvableMaker {
68
- name: string;
69
- platforms: ForgePlatform[] | null;
70
- config: any;
71
- }
72
-
73
- export interface IForgeMaker {
74
- __isElectronForgeMaker: boolean;
75
- platforms?: undefined;
76
- }
77
-
78
- export interface IForgeResolvablePublisher {
79
- name: string;
80
- platforms?: ForgePlatform[] | null;
81
- config?: any;
82
- }
83
-
84
- export interface IForgePublisher {
85
- __isElectronForgePublisher: boolean;
86
- platforms?: undefined;
87
- }
88
-
89
- export interface StartOptions {
90
- /**
91
- * The path to the electron forge project to run
92
- */
93
- dir?: string;
94
- /**
95
- * The path (relative to dir) to the electron app to run relative to the project directory
96
- */
97
- appPath?: string;
98
- /**
99
- * Whether to use sensible defaults or prompt the user visually
100
- */
101
- interactive?: boolean;
102
- /**
103
- * Enables advanced internal Electron debug calls
104
- */
105
- enableLogging?: boolean;
106
- /**
107
- * Arguments to pass through to the launched Electron application
108
- */
109
- args?: (string | number)[];
110
- /**
111
- * Runs the Electron process as if it were node, disables all Electron API's
112
- */
113
- runAsNode?: boolean;
114
- /**
115
- * Enables the node inspector, you can connect to this from chrome://inspect
116
- */
117
- inspect?: boolean;
118
- }
119
- }
package/tslint.json DELETED
@@ -1,12 +0,0 @@
1
- {
2
- "extends": "tslint-config-airbnb",
3
- "rules": {
4
- "no-boolean-literal-compare": false,
5
- "import-name": false,
6
- "align": false,
7
- "variable-name": [true, "ban-keywords", "check-format", "allow-pascal-case"],
8
- "no-this-assignment": [true, { "allow-destructuring": true }],
9
- "max-line-length": false,
10
- "no-parameter-reassignment": false
11
- }
12
- }