forked from ScoopInstaller/Scoop
-
Notifications
You must be signed in to change notification settings - Fork 11
/
schema.json
640 lines (640 loc) · 25.1 KB
/
schema.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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
{
"$id": "http://scoop.sh/draft/schema#",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Application manifest schema definition for Shovel Installer.",
"additionalProperties": false,
"required": [
"version",
"description",
"homepage",
"license"
],
"definitions": {
"licenseIdentifiers": {
"description": "SPDX license identifier",
"type": "string",
"examples": [
"Freeware",
"Public Domain",
"Proprietary",
"Shareware",
"Unknown",
"Unlicense",
"Apache-2.0",
"BSD-3-Clause",
"GPL-2.0-only",
"GPL-2.0-or-later",
"GPL-3.0-only",
"GPL-3.0-or-later",
"ISC",
"LGPL-2.0-only",
"LGPL-2.0-or-later",
"LGPL-2.1-only",
"LGPL-2.1-or-later",
"LGPL-3.0-only",
"LGPL-3.0-or-later",
"MIT",
"MS-PL"
]
},
"jsonPathExpression": {
"description": "Validates JSON path expression.",
"type": "string",
"pattern": "^\\$[.\\[].*$"
},
"hashPattern": {
"description": "Validates all supported format of hash property",
"type": "string",
"pattern": "^([a-fA-F\\d]{64}|(sha1|sha256|sha512|md5):([a-fA-F\\d]{32}|[a-fA-F\\d]{40}|[a-fA-F\\d]{64}|[a-fA-F\\d]{128}))$"
},
"hash": {
"description": "File hash used for verification of downloaded file.",
"anyOf": [
{
"$ref": "#/definitions/hashPattern"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/hashPattern"
},
"minItems": 1,
"uniqueItems": true
}
]
},
"hashExtraction": {
"description": "Specify how the hashes are extracted while autoupdating.",
"type": "object",
"additionalProperties": false,
"properties": {
"regex": {
"description": "Regular expression which will be used for searching inside defined URL",
"type": "string",
"format": "regex"
},
"jsonpath": {
"description": "JSON query language used in case the URL points to JSON file.",
"$ref": "#/definitions/jsonPathExpression"
},
"xpath": {
"description": "XML query language used in case the URL points to XML file.",
"type": "string"
},
"mode": {
"description": "Specify how the hashes should be calculated.",
"enum": [
"download",
"extract",
"json",
"xpath",
"rdf",
"metalink",
"fosshub",
"sourceforge"
],
"default": "download"
},
"type": {
"description": "Deprecated, hash type is determined automatically",
"enum": [
"md5",
"sha1",
"sha256",
"sha512"
]
},
"url": {
"description": "URL of webpage/file which contains information about file integrity.",
"anyOf": [
{
"format": "uri",
"type": "string"
},
{
"pattern": "^(\\$url|\\$baseurl).[\\w\\d]+$",
"type": "string"
},
{
"pattern": "^.*(\\$url|\\$baseurl).*$",
"type": "string"
}
]
},
"find": {
"description": "Deprecated. Use 'regex' instead",
"type": "string",
"format": "regex"
},
"jp": {
"description": "Deprecated. Use 'jsonpath' instead",
"$ref": "#/definitions/jsonPathExpression"
}
}
},
"architecture": {
"description": "Defines objects allowed for specific architecture.",
"type": "object",
"additionalProperties": false,
"properties": {
"pre_download": {
"description": "Specify PowerShell commands to be executed before download process is executed.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"url": {
"description": "Specify URLs of files, which needs to be downloaded to install application.",
"$ref": "#/definitions/uriOrArrayOfUris"
},
"hash": {
"description": "Specify the hash of downloaded files to be used to verify integrity.",
"$ref": "#/definitions/hash"
},
"extract_dir": {
"description": "Specify the directory to be extracted from downloaded archive.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"pre_install": {
"description": "Specify PowerShell commands to be executed before 'installer' is invoked.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"installer": {
"description": "Specify process of application installation.",
"$ref": "#/definitions/installer"
},
"msi": {
"description": "Deprecated",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"post_install": {
"description": "PowerShell commands to be executed after 'installer' is invoked and after persist/binaries and shortcuts creation.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"pre_uninstall": {
"description": "PowerShell commands to be executed before 'uninstaller' is invoked.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"uninstaller": {
"description": "Specify the process of application uninstallation.",
"$ref": "#/definitions/uninstaller"
},
"post_uninstall": {
"description": "PowerShell commands to be executed after 'uninstaller' is invoked.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"bin": {
"description": "Specify executables to be available in PATH.",
"$ref": "#/definitions/stringOrArrayOfStringsOrAnArrayOfArrayOfStrings"
},
"shortcuts": {
"description": "Specify Start menu shortcuts to be created after installation.",
"$ref": "#/definitions/shortcutsArray"
},
"env_add_path": {
"description": "Specify directories to be added into PATH.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"env_set": {
"description": "Specify environment variables for the user (or machine if --global is used)",
"type": "object"
},
"checkver": {
"description": "Specify how the latest version of application is determined.",
"$ref": "#/definitions/checkver"
}
}
},
"arrayOfArrayOfStrings": {
"description": "Array containing Array containing Strings",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"minItems": 1
},
"stringOrArrayOfStrings": {
"description": "String or Array of Strings",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
]
},
"stringOrArrayOfStringsOrAnArrayOfArrayOfStrings": {
"description": "String or Array of String or Array of nested Array of Strings",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"minItems": 1
}
]
},
"uriOrArrayOfUris": {
"description": "Single URl or Array of URLs",
"anyOf": [
{
"type": "string",
"format": "uri",
"not": {
"pattern": "(\\$)"
}
},
{
"type": "array",
"items": {
"type": "string",
"format": "uri",
"not": {
"pattern": "(\\$)"
}
},
"minItems": 1,
"uniqueItems": true
}
]
},
"shortcutsArray": {
"description": "Array containing Array with 2 to 4 Strings",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 2,
"maxItems": 4
},
"minItems": 1
},
"checkver": {
"description": "Specify how the latest version of application is determined.",
"anyOf": [
{
"type": "string",
"format": "regex"
},
{
"additionalProperties": false,
"properties": {
"github": {
"description": "Automatic github release page flow. Same as URL property with releases/latest value.",
"type": "string",
"format": "uri"
},
"url": {
"description": "Specify URL where to look for version of application.",
"type": "string",
"format": "uri"
},
"regex": {
"description": "Regular expression which will be used for searching inside defined URL",
"type": "string",
"format": "regex"
},
"jsonpath": {
"description": "JSON query language used in case the URL points to JSON file.",
"$ref": "#/definitions/jsonPathExpression"
},
"xpath": {
"description": "XML query language used in case the URL points to XML file.",
"type": "string"
},
"reverse": {
"description": "Reverses the order of regex matches.",
"type": "boolean"
},
"replace": {
"description": "Allows rearrange the regexp matches",
"type": "string"
},
"useragent": {
"description": "Specify custom UserAgent while accessing the URL.",
"type": "string"
},
"script": {
"description": "Custom PowerShell script to retrieve application version using more complex approach.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"jp": {
"description": "Deprecated. Use 'jsonpath' instead",
"$ref": "#/definitions/jsonPathExpression"
},
"re": {
"description": "Deprecated. Use 'regex' instead",
"type": "string",
"format": "regex"
}
}
}
]
},
"installer": {
"description": "Installer",
"type": "object",
"additionalProperties": false,
"properties": {
"file": {
"description": "Specify the executable to be executed on installation. Default to $fname",
"type": "string"
},
"args": {
"description": "Specify arguments to be passed to installer file.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"keep": {
"description": "Specify the installer file should be kept for future use.",
"type": "boolean"
},
"script": {
"description": "Specify PowerShell commands required to install application. installer.script will be executed after installer.file. If running file and script sequentially is desired, you need to explicitly specify file or args properties.",
"$ref": "#/definitions/stringOrArrayOfStrings"
}
}
},
"uninstaller": {
"description": "Uninstaller",
"type": "object",
"properties": {
"file": {
"description": "Specify executable to be executed on uninstallation.",
"type": "string"
},
"args": {
"description": "Specify arguments to be passed to uninstaller file.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"script": {
"description": "Specify PowerShell commands required for application uninstallation.",
"$ref": "#/definitions/stringOrArrayOfStrings"
}
},
"oneOf": [
{
"required": [
"file"
]
},
{
"required": [
"script"
]
}
]
},
"autoupdateArchitecture": {
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Specify URLs to be updated.",
"type": "string",
"format": "uri"
},
"hash": {
"description": "Specify how hashes are calculated on update.",
"$ref": "#/definitions/hashExtraction"
},
"extract_dir": {
"description": "Specify extract directory to be updated.",
"type": "string"
}
}
},
"autoupdate": {
"description": "Specifies how the manifest is updated.",
"type": "object",
"additionalProperties": false,
"properties": {
"note": {
"description": "Specify message printed to user after autoupdate.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"changelog": {
"type": "string"
},
"architecture": {
"type": "object",
"additionalProperties": false,
"properties": {
"32bit": {
"$ref": "#/definitions/autoupdateArchitecture"
},
"64bit": {
"$ref": "#/definitions/autoupdateArchitecture"
}
}
},
"url": {
"description": "Specify the URL to be updated.",
"type": "string",
"format": "uri"
},
"hash": {
"description": "Specify the hash extraction process for URLs.",
"$ref": "#/definitions/hashExtraction"
},
"extract_dir": {
"description": "Specify the 'extract_dir' property has to be updated.",
"type": "string"
}
}
}
},
"properties": {
"_comment": {
"description": "Deprecated. Use '##' instead.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"##": {
"description": "A comment for other contributors.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"version": {
"description": "Specify application's version.",
"type": "string",
"pattern": "^[\\w.\\-+_]+$"
},
"description": {
"description": "Specify the brief description of application.",
"type": "string"
},
"homepage": {
"description": "Specify the URL of homepage for application.",
"type": "string",
"format": "uri"
},
"license": {
"description": "Specify application's license information.",
"anyOf": [
{
"$ref": "#/definitions/licenseIdentifiers"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"description": "Specify URL with license terms/agreement.",
"type": "string",
"format": "uri"
},
"identifier": {
"description": "Specify license identifier.",
"$ref": "#/definitions/licenseIdentifiers"
}
},
"required": [
"identifier"
]
}
]
},
"notes": {
"description": "Specify information to be displayed to user after installation.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"changelog": {
"description": "Specify file/url pointing to release notes. File reference should be relative to application directory.",
"type": "string"
},
"depends": {
"description": "Specify manifest(s) required to be installed before the application is installed.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"suggest": {
"description": "Specify manifest(s) with complementary features to be installed.",
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^(.*)$": {
"$ref": "#/definitions/stringOrArrayOfStrings"
}
}
},
"pre_download": {
"description": "Specify PowerShell commands to be executed before download process is executed.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"cookie": {
"description": "Specify the cookies required to download applicaiton.",
"type": "object"
},
"architecture": {
"description": "Specify the different properties for specific architecture.",
"type": "object",
"additionalProperties": false,
"properties": {
"64bit": {
"$ref": "#/definitions/architecture"
},
"32bit": {
"$ref": "#/definitions/architecture"
}
}
},
"url": {
"description": "Specify URLs of files, which needs to be downloaded to install application.",
"$ref": "#/definitions/uriOrArrayOfUris"
},
"hash": {
"description": "Specify the hash of downloaded files to be used to verify integrity.",
"$ref": "#/definitions/hash"
},
"extract_dir": {
"description": "Specify the directory to be extracted from downloaded archive.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"extract_to": {
"description": "Specify the destination directory of downloaded archive.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"innosetup": {
"description": "Specify the installer is InnoSetup based.",
"type": "boolean"
},
"pre_install": {
"description": "PowerShell commands to be executed before 'installer' is invoked.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"msi": {
"description": "Deprecated",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"installer": {
"description": "Specify process of application installation.",
"$ref": "#/definitions/installer"
},
"post_install": {
"description": "PowerShell commands to be executed after 'installer' is invoked and after persist/binaries and shortcuts creation.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"pre_uninstall": {
"description": "PowerShell commands to be executed before 'uninstaller' is invoked.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"uninstaller": {
"description": "Specify the process of application uninstallation.",
"$ref": "#/definitions/uninstaller"
},
"post_uninstall": {
"description": "PowerShell commands to be executed after 'uninstaller' is invoked.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"psmodule": {
"description": "Specify PowerShell module installation",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the module, which should match at least one file in the extracted directory for PowerShell to recognize this as a module.",
"type": "string"
}
}
},
"bin": {
"description": "Specify executables to be available in PATH.",
"$ref": "#/definitions/stringOrArrayOfStringsOrAnArrayOfArrayOfStrings"
},
"shortcuts": {
"description": "Specify Start menu shortcuts to be created after installation.",
"$ref": "#/definitions/shortcutsArray"
},
"env_add_path": {
"description": "Specify directories to be added into PATH.",
"$ref": "#/definitions/stringOrArrayOfStrings"
},
"env_set": {
"description": "Specify environment variables for the user (or machine if --global is used)",
"type": "object"
},
"persist": {
"description": "Specify folders and files to be preserved across updates.",
"$ref": "#/definitions/stringOrArrayOfStringsOrAnArrayOfArrayOfStrings"
},
"checkver": {
"description": "Specify how the latest version of application is determined.",
"$ref": "#/definitions/checkver"
},
"autoupdate": {
"description": "Specifies the process of manifest updating to latest available version.",
"$ref": "#/definitions/autoupdate"
}
}
}