@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/globals.html DELETED
@@ -1,265 +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>@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
- </ul>
57
- <h1> @electron-forge/shared-types</h1>
58
- </div>
59
- </div>
60
- </header>
61
- <div class="container container-main">
62
- <div class="row">
63
- <div class="col-8 col-content">
64
- <section class="tsd-panel-group tsd-index-group">
65
- <h2>Index</h2>
66
- <section class="tsd-panel tsd-index-panel">
67
- <div class="tsd-index-content">
68
- <section class="tsd-index-section ">
69
- <h3>Interfaces</h3>
70
- <ul class="tsd-index-list">
71
- <li class="tsd-kind-interface"><a href="interfaces/forgeconfig.html" class="tsd-kind-icon">Forge<wbr>Config</a></li>
72
- <li class="tsd-kind-interface"><a href="interfaces/forgemakeresult.html" class="tsd-kind-icon">Forge<wbr>Make<wbr>Result</a></li>
73
- <li class="tsd-kind-interface"><a href="interfaces/iforgemaker.html" class="tsd-kind-icon">IForge<wbr>Maker</a></li>
74
- <li class="tsd-kind-interface"><a href="interfaces/iforgeplugin.html" class="tsd-kind-icon">IForge<wbr>Plugin</a></li>
75
- <li class="tsd-kind-interface"><a href="interfaces/iforgeplugininterface.html" class="tsd-kind-icon">IForge<wbr>Plugin<wbr>Interface</a></li>
76
- <li class="tsd-kind-interface"><a href="interfaces/iforgepublisher.html" class="tsd-kind-icon">IForge<wbr>Publisher</a></li>
77
- <li class="tsd-kind-interface"><a href="interfaces/iforgeresolvablemaker.html" class="tsd-kind-icon">IForge<wbr>Resolvable<wbr>Maker</a></li>
78
- <li class="tsd-kind-interface"><a href="interfaces/iforgeresolvablepublisher.html" class="tsd-kind-icon">IForge<wbr>Resolvable<wbr>Publisher</a></li>
79
- <li class="tsd-kind-interface"><a href="interfaces/startoptions.html" class="tsd-kind-icon">Start<wbr>Options</a></li>
80
- </ul>
81
- </section>
82
- <section class="tsd-index-section ">
83
- <h3>Type aliases</h3>
84
- <ul class="tsd-index-list">
85
- <li class="tsd-kind-type-alias"><a href="globals.html#forgearch" class="tsd-kind-icon">Forge<wbr>Arch</a></li>
86
- <li class="tsd-kind-type-alias"><a href="globals.html#forgehookfn" class="tsd-kind-icon">Forge<wbr>Hook<wbr>Fn</a></li>
87
- <li class="tsd-kind-type-alias"><a href="globals.html#forgeplatform" class="tsd-kind-icon">Forge<wbr>Platform</a></li>
88
- </ul>
89
- </section>
90
- </div>
91
- </section>
92
- </section>
93
- <section class="tsd-panel-group tsd-member-group ">
94
- <h2>Type aliases</h2>
95
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
96
- <a name="forgearch" class="tsd-anchor"></a>
97
- <h3>Forge<wbr>Arch</h3>
98
- <div class="tsd-signature tsd-kind-icon">Forge<wbr>Arch<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ia32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"x64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"armv7l"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"arm"</span></div>
99
- <aside class="tsd-sources">
100
- <ul>
101
- <li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/utils/types/src/index.ts#L9">index.ts:9</a></li>
102
- </ul>
103
- </aside>
104
- </section>
105
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
106
- <a name="forgehookfn" class="tsd-anchor"></a>
107
- <h3>Forge<wbr>Hook<wbr>Fn</h3>
108
- <div class="tsd-signature tsd-kind-icon">Forge<wbr>Hook<wbr>Fn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
109
- <aside class="tsd-sources">
110
- <ul>
111
- <li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/utils/types/src/index.ts#L10">index.ts:10</a></li>
112
- </ul>
113
- </aside>
114
- <div class="tsd-type-declaration">
115
- <h4>Type declaration</h4>
116
- <ul class="tsd-parameters">
117
- <li class="tsd-parameter-siganture">
118
- <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported">
119
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>forgeConfig<span class="tsd-signature-symbol">: </span><a href="interfaces/forgeconfig.html" class="tsd-signature-type">ForgeConfig</a>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
120
- </ul>
121
- <ul class="tsd-descriptions">
122
- <li class="tsd-description">
123
- <h4 class="tsd-parameters-title">Parameters</h4>
124
- <ul class="tsd-parameters">
125
- <li>
126
- <h5>forgeConfig: <a href="interfaces/forgeconfig.html" class="tsd-signature-type">ForgeConfig</a></h5>
127
- </li>
128
- <li>
129
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
130
- </li>
131
- </ul>
132
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
133
- </li>
134
- </ul>
135
- </li>
136
- </ul>
137
- </div>
138
- </section>
139
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
140
- <a name="forgeplatform" class="tsd-anchor"></a>
141
- <h3>Forge<wbr>Platform</h3>
142
- <div class="tsd-signature tsd-kind-icon">Forge<wbr>Platform<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"darwin"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mas"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"win32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"linux"</span></div>
143
- <aside class="tsd-sources">
144
- <ul>
145
- <li>Defined in <a href="https://github.com/electron-userland/electron-forge/blob/ab64142/packages/utils/types/src/index.ts#L8">index.ts:8</a></li>
146
- </ul>
147
- </aside>
148
- </section>
149
- </section>
150
- </div>
151
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
152
- <nav class="tsd-navigation primary">
153
- <ul>
154
- <li class="globals current ">
155
- <a href="globals.html"><em>Globals</em></a>
156
- </li>
157
- </ul>
158
- </nav>
159
- <nav class="tsd-navigation secondary menu-sticky">
160
- <ul class="before-current">
161
- <li class=" tsd-kind-interface">
162
- <a href="interfaces/forgeconfig.html" class="tsd-kind-icon">Forge<wbr>Config</a>
163
- </li>
164
- <li class=" tsd-kind-interface">
165
- <a href="interfaces/forgemakeresult.html" class="tsd-kind-icon">Forge<wbr>Make<wbr>Result</a>
166
- </li>
167
- <li class=" tsd-kind-interface">
168
- <a href="interfaces/iforgemaker.html" class="tsd-kind-icon">IForge<wbr>Maker</a>
169
- </li>
170
- <li class=" tsd-kind-interface">
171
- <a href="interfaces/iforgeplugin.html" class="tsd-kind-icon">IForge<wbr>Plugin</a>
172
- </li>
173
- <li class=" tsd-kind-interface">
174
- <a href="interfaces/iforgeplugininterface.html" class="tsd-kind-icon">IForge<wbr>Plugin<wbr>Interface</a>
175
- </li>
176
- <li class=" tsd-kind-interface">
177
- <a href="interfaces/iforgepublisher.html" class="tsd-kind-icon">IForge<wbr>Publisher</a>
178
- </li>
179
- <li class=" tsd-kind-interface">
180
- <a href="interfaces/iforgeresolvablemaker.html" class="tsd-kind-icon">IForge<wbr>Resolvable<wbr>Maker</a>
181
- </li>
182
- <li class=" tsd-kind-interface">
183
- <a href="interfaces/iforgeresolvablepublisher.html" class="tsd-kind-icon">IForge<wbr>Resolvable<wbr>Publisher</a>
184
- </li>
185
- <li class=" tsd-kind-interface">
186
- <a href="interfaces/startoptions.html" class="tsd-kind-icon">Start<wbr>Options</a>
187
- </li>
188
- <li class=" tsd-kind-type-alias">
189
- <a href="globals.html#forgearch" class="tsd-kind-icon">Forge<wbr>Arch</a>
190
- </li>
191
- <li class=" tsd-kind-type-alias">
192
- <a href="globals.html#forgehookfn" class="tsd-kind-icon">Forge<wbr>Hook<wbr>Fn</a>
193
- </li>
194
- <li class=" tsd-kind-type-alias">
195
- <a href="globals.html#forgeplatform" class="tsd-kind-icon">Forge<wbr>Platform</a>
196
- </li>
197
- </ul>
198
- </nav>
199
- </div>
200
- </div>
201
- </div>
202
- <footer>
203
- <div class="container">
204
- <h2>Legend</h2>
205
- <div class="tsd-legend-group">
206
- <ul class="tsd-legend">
207
- <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
208
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
209
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
210
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
211
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
212
- <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
213
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
214
- </ul>
215
- <ul class="tsd-legend">
216
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
217
- <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
218
- <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
219
- <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
220
- </ul>
221
- <ul class="tsd-legend">
222
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
223
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
224
- <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
225
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
226
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
227
- <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
228
- </ul>
229
- <ul class="tsd-legend">
230
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
231
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
232
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
233
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
234
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
235
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
236
- <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
237
- </ul>
238
- <ul class="tsd-legend">
239
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
240
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
241
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
242
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
243
- </ul>
244
- <ul class="tsd-legend">
245
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
246
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
247
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
248
- </ul>
249
- <ul class="tsd-legend">
250
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
251
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
252
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
253
- </ul>
254
- <ul class="tsd-legend">
255
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
256
- <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
257
- </ul>
258
- </div>
259
- </div>
260
- </footer>
261
- <div class="overlay"></div>
262
- <script src="assets/js/main.js"></script>
263
- <script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
264
- </body>
265
- </html>
package/doc/index.html DELETED
@@ -1,267 +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>@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
- </ul>
57
- <h1> @electron-forge/shared-types</h1>
58
- </div>
59
- </div>
60
- </header>
61
- <div class="container container-main">
62
- <div class="row">
63
- <div class="col-8 col-content">
64
- <div class="tsd-panel tsd-typography">
65
- <h2 id="electron-forge">Electron Forge</h2>
66
- <p><a href="https://travis-ci.org/electron-userland/electron-forge"><img src="https://travis-ci.org/electron-userland/electron-forge.svg?branch=master" alt="Linux/macOS Build Status"></a>
67
- <a href="https://ci.appveyor.com/project/electron-userland/electron-forge"><img src="https://ci.appveyor.com/api/projects/status/79ae80nek1eucyy3?svg=true" alt="Windows Build status"></a>
68
- <a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly"></a>
69
- <a href="https://www.npmjs.com/package/electron-forge"><img src="https://badge.fury.io/js/electron-forge.svg" alt="npm version"></a>
70
- <a href="https://www.npmjs.com/package/electron-forge"><img src="https://img.shields.io/npm/dt/electron-forge.svg?maxAge=2592000" alt="npm"></a>
71
- <a href="https://github.com/electron-userland/electron-forge/blob/master/LICENSE"><img src="https://img.shields.io/github/license/electron-userland/electron-forge.svg" alt="license"></a>
72
- <img src="https://img.shields.io/badge/Status-%20Ready%20for%20Awesome-red.svg" alt="status"></p>
73
- <p>A complete tool for building modern Electron applications.</p>
74
- <p>Electron Forge unifies the existing (and well maintained) build tools for
75
- Electron development into a simple, easy to use package so that anyone can
76
- jump right in to Electron development.</p>
77
- <hr>
78
- <h2 id="-rotating_light-construction-warning-construction-rotating_light-">:rotating_light: :construction: <strong>WARNING</strong> :construction: :rotating_light:</h2>
79
- <p>:building_construction:</p>
80
- <p>The <code>master</code> branch is a rewrite of Electron Forge that will eventually be the 6.x series. If you
81
- are looking for the 5.x series (the version currently published to NPM), please view the <a href="https://github.com/electron-userland/electron-forge/tree/5.x">5.x branch</a>.</p>
82
- <hr>
83
- <p><a href="https://v6.electronforge.io">Website</a> |
84
- <a href="#project-goals">Goals</a> |
85
- <a href="#usage">Usage</a> |
86
- <a href="https://v6.electronforge.io/configuration">Configuration</a> |
87
- <a href="https://github.com/electron-userland/electron-forge/blob/master/SUPPORT.md">Support</a> |
88
- <a href="https://github.com/electron-userland/electron-forge/blob/master/CONTRIBUTING.md">Contributing</a> |
89
- <a href="https://github.com/electron-userland/electron-forge/blob/master/CHANGELOG.md">Changelog</a></p>
90
- <h1 id="getting-started">Getting Started</h1>
91
- <p><strong>Note</strong>: Electron Forge requires Node 6 or above, plus git installed.</p>
92
- <pre><code class="lang-bash">npm install -g @electron-forge/cli
93
- electron-forge init my-new-app
94
- <span class="hljs-built_in">cd</span> my-new-app
95
- npm start
96
- </code></pre>
97
- <p>Alternatively, if you have a more recent version of <code>npm</code> or <code>yarn</code>, you can use
98
- <a href="https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b"><code>npx</code></a>,
99
- or
100
- <a href="https://yarnpkg.com/blog/2017/05/12/introducing-yarn/"><code>yarn create</code></a>.</p>
101
- <pre><code class="lang-bash">npx @electron-forge/cli init my-new-app
102
- <span class="hljs-comment"># or</span>
103
- yarn create electron-app my-new-app
104
-
105
- <span class="hljs-comment"># then</span>
106
- <span class="hljs-built_in">cd</span> my-new-app
107
- npm start
108
- </code></pre>
109
- <h1 id="project-goals">Project Goals</h1>
110
- <ol>
111
- <li>Starting with Electron should be as simple as a single command.</li>
112
- <li>Developers shouldn&#39;t have to worry about setting up build tooling,
113
- native module rebuilding, etc. Everything should &quot;just work&quot; for them out
114
- of the box.</li>
115
- <li>Everything from creating the project to packaging the project for release
116
- should be handled by one core dependency in a standard way while still offering
117
- users maximum choice and freedom.</li>
118
- </ol>
119
- <p>With these goals in mind, under the hood this project uses, among others:</p>
120
- <ul>
121
- <li><a href="https://github.com/electron/electron-rebuild"><code>electron-rebuild</code></a>:
122
- Automatically recompiles native Node.js modules against the correct
123
- Electron version.</li>
124
- <li><a href="https://github.com/electron-userland/electron-packager">Electron Packager</a>:
125
- Customizes and bundles your Electron app to get it ready for distribution.</li>
126
- </ul>
127
- <h1 id="docs-and-usage">Docs and Usage</h1>
128
- <p>For Electron Forge documentation and usage you should check out our website:
129
- <a href="https://v6.electronforge.io">electronforge.io</a></p>
130
- <h1 id="faq">FAQ</h1>
131
- <h2 id="how-do-i-use-this-with-webpack-babel-typescript-random-build-tool-">How do I use this with <code>webpack</code>/<code>babel</code>/<code>typescript</code>/<code>random build tool</code>?</h2>
132
- <p>As of Electron Forge 6+ by default we only do vanilla JavaScript but if you want
133
- to do some fancy build tool stuff you should check out the <a href="https://v6.electronforge.io/plugins">plugins</a>
134
- section of our docs site. We currently have plugins for Webpack, Parcel and
135
- Electron Compile.</p>
136
- <h1 id="team">Team</h1>
137
- <table>
138
- <thead>
139
- <tr>
140
- <th><img src="https://s.gravatar.com/avatar/1576c987b53868acf73d6ccb08110a78?s=144" width="144" /></th>
141
- <th><img src="https://avatars2.githubusercontent.com/u/11417?s=460&v=4" width="144" /></th>
142
- </tr>
143
- </thead>
144
- <tbody>
145
- <tr>
146
- <td><a href="https://samuelattard.com">Samuel Attard</a></td>
147
- <td><a href="https://github.com/malept">Malept</a></td>
148
- </tr>
149
- </tbody>
150
- </table>
151
- </div>
152
- </div>
153
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
154
- <nav class="tsd-navigation primary">
155
- <ul>
156
- <li class="globals ">
157
- <a href="globals.html"><em>Globals</em></a>
158
- </li>
159
- </ul>
160
- </nav>
161
- <nav class="tsd-navigation secondary menu-sticky">
162
- <ul class="before-current">
163
- <li class=" tsd-kind-interface">
164
- <a href="interfaces/forgeconfig.html" class="tsd-kind-icon">Forge<wbr>Config</a>
165
- </li>
166
- <li class=" tsd-kind-interface">
167
- <a href="interfaces/forgemakeresult.html" class="tsd-kind-icon">Forge<wbr>Make<wbr>Result</a>
168
- </li>
169
- <li class=" tsd-kind-interface">
170
- <a href="interfaces/iforgemaker.html" class="tsd-kind-icon">IForge<wbr>Maker</a>
171
- </li>
172
- <li class=" tsd-kind-interface">
173
- <a href="interfaces/iforgeplugin.html" class="tsd-kind-icon">IForge<wbr>Plugin</a>
174
- </li>
175
- <li class=" tsd-kind-interface">
176
- <a href="interfaces/iforgeplugininterface.html" class="tsd-kind-icon">IForge<wbr>Plugin<wbr>Interface</a>
177
- </li>
178
- <li class=" tsd-kind-interface">
179
- <a href="interfaces/iforgepublisher.html" class="tsd-kind-icon">IForge<wbr>Publisher</a>
180
- </li>
181
- <li class=" tsd-kind-interface">
182
- <a href="interfaces/iforgeresolvablemaker.html" class="tsd-kind-icon">IForge<wbr>Resolvable<wbr>Maker</a>
183
- </li>
184
- <li class=" tsd-kind-interface">
185
- <a href="interfaces/iforgeresolvablepublisher.html" class="tsd-kind-icon">IForge<wbr>Resolvable<wbr>Publisher</a>
186
- </li>
187
- <li class=" tsd-kind-interface">
188
- <a href="interfaces/startoptions.html" class="tsd-kind-icon">Start<wbr>Options</a>
189
- </li>
190
- <li class=" tsd-kind-type-alias">
191
- <a href="globals.html#forgearch" class="tsd-kind-icon">Forge<wbr>Arch</a>
192
- </li>
193
- <li class=" tsd-kind-type-alias">
194
- <a href="globals.html#forgehookfn" class="tsd-kind-icon">Forge<wbr>Hook<wbr>Fn</a>
195
- </li>
196
- <li class=" tsd-kind-type-alias">
197
- <a href="globals.html#forgeplatform" class="tsd-kind-icon">Forge<wbr>Platform</a>
198
- </li>
199
- </ul>
200
- </nav>
201
- </div>
202
- </div>
203
- </div>
204
- <footer>
205
- <div class="container">
206
- <h2>Legend</h2>
207
- <div class="tsd-legend-group">
208
- <ul class="tsd-legend">
209
- <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
210
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
211
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
212
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
213
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
214
- <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
215
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
216
- </ul>
217
- <ul class="tsd-legend">
218
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
219
- <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
220
- <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
221
- <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
222
- </ul>
223
- <ul class="tsd-legend">
224
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
225
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
226
- <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
227
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
228
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
229
- <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
230
- </ul>
231
- <ul class="tsd-legend">
232
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
233
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
234
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
235
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
236
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
237
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
238
- <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
239
- </ul>
240
- <ul class="tsd-legend">
241
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
242
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
243
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
244
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
245
- </ul>
246
- <ul class="tsd-legend">
247
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
248
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
249
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
250
- </ul>
251
- <ul class="tsd-legend">
252
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
253
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
254
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
255
- </ul>
256
- <ul class="tsd-legend">
257
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
258
- <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
259
- </ul>
260
- </div>
261
- </div>
262
- </footer>
263
- <div class="overlay"></div>
264
- <script src="assets/js/main.js"></script>
265
- <script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
266
- </body>
267
- </html>