/
config.v2.json
397 lines (397 loc) · 15.1 KB
/
config.v2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://wails.io/schemas/config.v2.json",
"required": [],
"title": "Wails configuration schema",
"description": "A JSON representation of a Wails project config file.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The project name",
"default": "wailsapp"
},
"assetdir": {
"type": "string",
"description": "Relative path to the directory containing the compiled assets. This is normally inferred, and can be left empty."
},
"reloaddirs": {
"type": "string",
"description": "Additional directories to trigger reloads (comma separated). Often, this is only used for advanced asset configurations."
},
"build:dir": {
"type": "string",
"description": "The directory where the build files reside.",
"default": "build",
"examples": [
"./build",
"/absolute/path/to/build",
"C:\\absolute\\path\\to\\build"
]
},
"frontend:dir": {
"type": "string",
"description": "The directory where the frontend files reside.",
"default": "frontend",
"examples": [
"./src",
"/absolute/path/to/frontend",
"C:\\absolute\\path\\to\\frontend"
]
},
"frontend:install": {
"type": "string",
"description": "The command to install dependencies. Run in the frontend directory.",
"examples": [
"npm install"
]
},
"frontend:build": {
"type": "string",
"description": "The command to build the assets. Run in the frontend directory.",
"examples": [
"npm run build"
]
},
"frontend:dev": {
"type": "string",
"description": "[Deprecated] This command has been replaced by `frontend:dev:build`. If `frontend:dev:build` is not specified, Wails will fall back to this command. If this command is also not specified, Wails will fall back to `frontend:build`."
},
"frontend:dev:build": {
"type": "string",
"description": "The equivalent of `frontend:build` during development. If not specified, it falls back to `frontend:dev`."
},
"frontend:dev:install": {
"type": "string",
"description": "The equivalent of `frontend:install` during development. If not specified, it falls back to `frontend:install`."
},
"frontend:dev:watcher": {
"type": "string",
"description": "This command is run in a separate process on `wails dev`. Useful for third-party watchers or for starting third-party dev servers."
},
"frontend:dev:serverUrl": {
"type": "string",
"description": "URL to a 3rd party dev server to be used to serve assets (eg. Vite). If this is set to 'auto', then the devServerUrl will be inferred from the Vite output",
"examples": [
"auto",
"http://localhost:3000"
],
"oneOf": [
{
"format": "uri"
},
{
"const": "auto"
}
]
},
"wailsjsdir": {
"type": "string",
"description": "Relative path to the directory where the auto-generated JS modules will be created.",
"format": "uri-reference",
"default": "The value of frontend:dir"
},
"version": {
"description": "Project config version",
"default": "2",
"enum": [
"2"
]
},
"outputfilename": {
"type": "string",
"description": "The name of the binary"
},
"debounceMS": {
"type": "number",
"description": "The debounce time for hot-reload of the built-in dev server. Measured in milliseconds.",
"default": 100
},
"devServer": {
"type": "string",
"description": "The address to bind the wails dev server to.",
"default": "localhost:34115",
"format": "uri"
},
"appargs": {
"type": "string",
"description": "Arguments passed to the application in shell style when in dev mode."
},
"runNonNativeBuildHooks": {
"type": "boolean",
"description": "Whether to run build hooks that are defined for an OS other than the host OS.",
"default": false
},
"preBuildHooks": {
"$ref": "#/definitions/buildHooks"
},
"postBuildHooks": {
"$ref": "#/definitions/buildHooks"
},
"author": {
"type": "object",
"description": "The application author",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
}
}
},
"info": {
"type": "object",
"description": "Data used to populate manifests and version info.",
"properties": {
"companyName": {
"type": "string",
"description": "The company name. Defaults to the project name."
},
"productName": {
"type": "string",
"description": "The product name. Defaults to the project name."
},
"productVersion": {
"type": "string",
"description": "The version of the product",
"default": "1.0.0"
},
"copyright": {
"type": "string",
"description": "A copyright string for the product",
"default": "Copyright........."
},
"comments": {
"type": "string",
"description": "A short comment for the app",
"default": "Built using Wails (https://wails.io)"
},
"fileAssociations": {
"type": "array",
"description": "File associations for the app",
"items": {
"type": "object",
"properties": {
"ext": {
"type": "string",
"description": "The extension (minus the leading period). e.g. png"
},
"name": {
"type": "string",
"description": "The name. e.g. PNG File"
},
"description": {
"type": "string",
"description": "Windows-only. The description. It is displayed on the `Type` column on Windows Explorer."
},
"iconName": {
"type": "string",
"description": "The icon name without extension. Icons should be located in build folder. Proper icons will be generated from .png file for both macOS and Windows)"
},
"role": {
"description": "macOS-only. The app’s role with respect to the type. Corresponds to CFBundleTypeRole.",
"allOf": [
{
"$ref": "#/definitions/BundleTypeRole"
}
]
}
}
}
},
"protocols": {
"type": "array",
"description": "Custom URI protocols that should be opened by the application",
"items": {
"type": "object",
"properties": {
"scheme": {
"type": "string",
"description": "protocol scheme. e.g. myapp"
},
"description": {
"type": "string",
"description": "Windows-only. The description. It is displayed on the `Type` column on Windows Explorer."
},
"role": {
"description": "macOS-only. The app’s role with respect to the type. Corresponds to CFBundleTypeRole.",
"allOf": [
{
"$ref": "#/definitions/BundleTypeRole"
}
]
}
}
}
}
}
},
"nsisType": {
"type": "string",
"default": "multiple",
"description": "Type of NSIS Installer for Windows",
"oneOf": [
{
"const": "multiple",
"description": "One installer per architecture"
},
{
"const": "single",
"description": "Single universal installer for all architectures being built"
}
]
},
"obfuscated": {
"type": "boolean",
"default": false,
"description": "Whether the binary should be obfuscated. Uses <https://github.com/burrowers/garble>."
},
"garbleargs": {
"type": "string",
"description": "The arguments to pass to the garble command when using the obfuscated flag"
},
"bindings": {
"type": "object",
"description": "Bindings configurations",
"properties": {
"ts_generation": {
"type": "object",
"description": "model.ts file generation config",
"properties": {
"prefix": {
"type": "string",
"description": "All generated JavaScript entities will be prefixed with this value"
},
"suffix": {
"type": "string",
"description": "All generated JavaScript entities will be suffixed with this value"
},
"outputType": {
"allOf": [
{
"$ref": "#/definitions/BindingsOutputTypes"
}
]
}
}
}
}
}
},
"dependencies": {
"garbleargs": [
"obfuscated"
]
},
"definitions": {
"OsHook": {
"title": "GOOS/*",
"type": "string",
"description": "Executed at build level before/after a build of the specific platform"
},
"OsArchHook": {
"title": "GOOS/GOARCH",
"type": "string",
"description": "Executed at build level before/after a build of the specific platform and arch"
},
"buildHooks": {
"type": "object",
"description": "Build hooks for different targets.",
"additionalProperties": false,
"properties": {
"{GOOS}/{GOARCH}": {
"$ref": "#/definitions/OsArchHook"
},
"{GOOS}/*": {
"$ref": "#/definitions/OsHook"
},
"windows/*": {
"$ref": "#/definitions/OsHook"
},
"linux/*": {
"$ref": "#/definitions/OsHook"
},
"darwin/*": {
"$ref": "#/definitions/OsHook"
},
"*/*": {
"type": "string",
"description": "Executed at build level before/after a build"
}
},
"patternProperties": {
"^[a-zA-Z0-9]+/[a-zA-Z0-9]+$": {
"type": "string",
"title": "GOOS/GOARCH",
"description": "Executed at build level before/after a build of the specific platform and arch"
},
"^[a-zA-Z0-9]+/\\*$": {
"type": "string",
"title": "GOOS/*",
"description": "Executed at build level before/after a build of the specific platform"
}
}
},
"BundleTypeRole": {
"description": "macOS-only. Corresponds to CFBundleTypeRole",
"oneOf": [
{
"description": "CFBundleTypeRole.Editor. Files can be read and edited.",
"type": "string",
"enum": [
"Editor"
]
},
{
"description": "CFBundleTypeRole.Viewer. Files can be read.",
"type": "string",
"enum": [
"Viewer"
]
},
{
"description": "CFBundleTypeRole.Shell",
"type": "string",
"enum": [
"Shell"
]
},
{
"description": "CFBundleTypeRole.QLGenerator",
"type": "string",
"enum": [
"QLGenerator"
]
},
{
"description": "CFBundleTypeRole.None",
"type": "string",
"enum": [
"None"
]
}
]
},
"BindingsOutputTypes": {
"description": "Type of output to generate",
"oneOf": [
{
"description": "Classes",
"type": "string",
"enum": [
"classes"
]
},
{
"description": "Interfaces",
"type": "string",
"enum": [
"interfaces"
]
}
]
}
}
}