-
Notifications
You must be signed in to change notification settings - Fork 40
/
package.json
4119 lines (4119 loc) · 207 KB
/
package.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
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"name": "brightscript",
"displayName": "BrightScript Language",
"version": "2.50.5",
"publisher": "RokuCommunity",
"description": "Language support for Roku's BrightScript language.",
"author": {
"name": "Bronley Plumb",
"email": "[email protected]"
},
"icon": "images/logo.png",
"license": "MIT",
"keywords": [
"multi-root-ready"
],
"engines": {
"vscode": "^1.81.0",
"node": "^12.12.0"
},
"repository": {
"type": "git",
"url": "https://github.com/RokuCommunity/vscode-brightscript-language"
},
"bugs": {
"url": "https://github.com/RokuCommunity/vscode-brightscript-language/issues"
},
"scripts": {
"postinstall": "cd webviews && npm install",
"preversion": "npm run build && npm run lint && npm run test && npm run check-extraneous",
"vscode:prepublish": "npm run build",
"copy-schema": "cpx ./node_modules/brighterscript/bsconfig.schema.json ./dist -L",
"build": "npm run copy-schema && tsc -p ./ && npm run build-webviews",
"build-webviews": "cd ./webviews && npm run build && cd ..",
"lint": "eslint \"./src/**/*.ts\"",
"watch": "npm run copy-schema && tsc -w -p ./",
"watch-webviews": "cd ./webviews && npm run watch",
"watch-all": "ts-node ./scripts/watch-all.ts",
"test": "nyc mocha",
"test:nocover": "mocha",
"publish-coverage": "nyc report --reporter=text-lcov | coveralls",
"check-extraneous": "npm list --production --parseable --depth=99999",
"package": "vsce package",
"package-local": "node scripts/package-local.js",
"publish": "vsce publish",
"clean": "rimraf dist",
"install-local": "npm i && ts-node scripts/install-local.ts",
"install-pull-local": "node scripts/install-local.js --pull",
"uninstall-local": "node scripts/uninstall-local.js",
"build-docs": "statigen -s docs -o .tmp/docs",
"watch-docs": "npm run build-docs -- --watch",
"releases": "ts-node scripts/releases.ts",
"sync-launch-settings": "ts-node scripts/sync-launch-settings.ts"
},
"dependencies": {
"@rokucommunity/logger": "^0.3.9",
"@types/request": "^2.48.12",
"@vscode/extension-telemetry": "^0.4.7",
"array-sort": "^1.0.0",
"backoff": "^2.5.0",
"brighterscript": "^0.67.8",
"brighterscript-formatter": "^1.7.6",
"clone-deep": "^4.0.1",
"debounce": "^1.2.0",
"dotenv": "^6.2.0",
"eventemitter3": "^5.0.1",
"fast-xml-parser": "^3.12.16",
"fs-extra": "^7.0.1",
"get-port": "^5.0.0",
"glob": "^7.1.3",
"hex-rgb": "^5.0.0",
"iconv-lite": "0.4.24",
"jszip": "^3.10.1",
"just-throttle": "^4.0.1",
"md5": "^2.3.0",
"net": "^1.0.2",
"node-cache": "^4.2.0",
"node-ssdp": "^4.0.0",
"open": "^8.4.2",
"postman-request": "^2.88.1-postman.32",
"pretty-bytes": "^5.6.0",
"resolve": "^1.22.8",
"roku-debug": "^0.21.12",
"roku-deploy": "^3.12.2",
"roku-test-automation": "^2.0.10",
"semver": "^7.1.3",
"source-map": "^0.7.3",
"thenby": "^1.3.4",
"undent": "^0.1.0",
"uuid": "^9.0.1",
"vscode-languageclient": "^7.0.0",
"vscode-uri": "^1.0.6"
},
"devDependencies": {
"@deboxsoft/cpx": "^1.5.0",
"@parcel/watcher": "^2.0.7",
"@types/backoff": "^2.5.2",
"@types/chai": "^4.1.5",
"@types/chalk": "^2.2.0",
"@types/clone-deep": "^4.0.3",
"@types/fs-extra": "^5.0.4",
"@types/glob": "^7.1.1",
"@types/lodash": "^4.17.7",
"@types/md5": "^2.3.5",
"@types/mocha": "^7.0.2",
"@types/node": "^20.14.10",
"@types/node-ssdp": "^3.3.0",
"@types/prompt": "^1.1.2",
"@types/resolve": "^1.20.6",
"@types/semver": "^7.1.0",
"@types/sinon": "7.0.6",
"@types/vscode": "^1.81.0",
"@types/xml2js": "^0.4.14",
"@types/yargs": "^17.0.10",
"@typescript-eslint/eslint-plugin": "^5.14.0",
"@typescript-eslint/parser": "^5.14.0",
"@vscode/vsce": "^2.22.0",
"chai": "^4.2.0",
"chalk": "^4.1.2",
"changelog-parser": "^2.8.0",
"coveralls-next": "^4.2.0",
"dayjs": "^1.11.12",
"deferred": "^0.7.11",
"eslint": "^8.10.0",
"eslint-plugin-github": "^4.3.5",
"eslint-plugin-no-only-tests": "^2.6.0",
"lodash": "^4.17.21",
"mocha": "^9.1.3",
"node-notifier": "^10.0.1",
"nyc": "^15.0.0",
"ovsx": "^0.8.3",
"prompt": "^1.3.0",
"rimraf": "^3.0.0",
"sinon": "^7.2.3",
"source-map-support": "^0.5.21",
"statigen": "^0.5.2",
"terminal-overwrite": "^2.0.1",
"ts-node": "^10.9.1",
"tslib": "^2.3.1",
"typescript": "^4.7.4",
"typescript-json-schema": "^0.50.1",
"vscode-tmgrammar-test": "^0.0.11",
"yargs": "^16.2.0"
},
"optionalDependencies": {
"fsevents": "~2.3.2"
},
"main": "./dist/extension",
"browser": "./dist/extension-web",
"activationEvents": [
"onDebug",
"onLanguage:brightscript",
"onLanguage:brighterscript",
"onLanguage:xml",
"workspaceContains:**/manifest",
"workspaceContains:**/bsconfig.json",
"onView:onlineDevicesView",
"onCommand:extension.brightscript.refreshDeviceList",
"onCommand:extension.brightscript.sendRemoteCommand",
"onCommand:extension.brightscript.toggleRemoteControlMode",
"onCommand:extension.brightscript.enableRemoteControlMode",
"onCommand:extension.brightscript.disableRemoteControlMode",
"onCommand:extension.brightscript.pressBackButton",
"onCommand:extension.brightscript.pressHomeButton",
"onCommand:extension.brightscript.pressUpButton",
"onCommand:extension.brightscript.pressDownButton",
"onCommand:extension.brightscript.pressRightButton",
"onCommand:extension.brightscript.pressLeftButton",
"onCommand:extension.brightscript.pressSelectButton",
"onCommand:extension.brightscript.pressPlayButton",
"onCommand:extension.brightscript.pressRevButton",
"onCommand:extension.brightscript.pressFwdButton",
"onCommand:extension.brightscript.pressStarButton",
"onCommand:extension.brightscript.pressInstantReplayButton",
"onCommand:extension.brightscript.pressSearchButton",
"onCommand:extension.brightscript.pressEnterButton",
"onCommand:extension.brightscript.pressFindRemote",
"onCommand:extension.brightscript.pressVolumeDown",
"onCommand:extension.brightscript.pressVolumeMute",
"onCommand:extension.brightscript.pressVolumeUp",
"onCommand:extension.brightscript.setVolume",
"onCommand:extension.brightscript.pressPowerOff",
"onCommand:extension.brightscript.pressChannelUp",
"onCommand:extension.brightscript.pressChannelDown",
"onCommand:extension.brightscript.pressBlue",
"onCommand:extension.brightscript.pressGreen",
"onCommand:extension.brightscript.pressRed",
"onCommand:extension.brightscript.pressYellow",
"onCommand:extension.brightscript.pressExit",
"onCommand:extension.brightscript.changeTvInput",
"onCommand:extension.brightscript.sendRemoteText",
"onCommand:brighterscript.showPreview",
"onCommand:brighterscript.showPreviewToSide",
"onCommand:extension.brightscript.captureScreenshot",
"onCommand:extension.brightscript.rekeyDevice",
"onCommand:extension.brightscript.createPackage",
"onCommand:extension.brightscript.rekeyAndPackage"
],
"contributes": {
"viewsContainers": {
"activitybar": [
{
"id": "vscode-brightscript-language",
"title": "BrightScript Language",
"icon": "images/icons/logo.svg"
}
]
},
"views": {
"vscode-brightscript-language": [
{
"id": "onlineDevicesView",
"name": "Devices"
}
],
"debug": [
{
"id": "rendezvousView",
"name": "Rendezvous",
"when": "debugType == 'brightscript'"
},
{
"id": "sceneGraphInspectorView",
"name": "SceneGraph Inspector",
"type": "webview"
},
{
"id": "rokuDeviceView",
"contextualTitle": "Roku Device View",
"name": "Roku Device View",
"type": "webview"
},
{
"id": "rokuFileSystemView",
"contextualTitle": "Roku File System",
"name": "Roku File System",
"type": "webview"
},
{
"id": "rokuAppOverlaysView",
"contextualTitle": "Roku App Overlays",
"name": "Roku App Overlays",
"type": "webview"
},
{
"id": "rokuRegistryView",
"name": "Roku Registry",
"type": "webview"
},
{
"id": "rokuCommandsView",
"name": "Roku Commands",
"type": "webview"
},
{
"id": "rokuAutomationView",
"name": "Roku Automation",
"type": "webview"
},
{
"id": "rokuReplView",
"name": "Roku REPL",
"type": "webview"
}
]
},
"menus": {
"editor/title": [
{
"when": "editorLangId == brighterscript && resourceScheme == file",
"command": "brighterscript.showPreviewToSide",
"group": "navigation"
}
],
"view/title": [
{
"command": "extension.brightscript.rendezvous.toggleSortMethod",
"when": "debugType == 'brightscript' && view == rendezvousView",
"group": "Rendezvous"
},
{
"command": "extension.brightscript.rendezvous.toggleSortDirection",
"when": "debugType == 'brightscript' && view == rendezvousView",
"group": "Rendezvous"
},
{
"command": "extension.brightscript.rendezvous.clearHistory",
"when": "debugType == 'brightscript' && view == rendezvousView",
"group": "navigation"
},
{
"command": "extension.brightscript.refreshDeviceList",
"when": "view == onlineDevicesView",
"group": "navigation"
},
{
"command": "extension.brightscript.rokuRegistry.refreshRegistry",
"when": "view == rokuRegistryView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@1"
},
{
"command": "extension.brightscript.rokuRegistry.importRegistry",
"when": "view == rokuRegistryView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@2"
},
{
"command": "extension.brightscript.rokuRegistry.exportRegistry",
"when": "view == rokuRegistryView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@3"
},
{
"command": "extension.brightscript.rokuRegistry.clearRegistry",
"when": "view == rokuRegistryView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@4"
},
{
"command": "extension.brightscript.disconnectFromDevice",
"when": "view == rokuRegistryView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@5"
},
{
"command": "extension.brightscript.rokuDeviceView.refreshScreenshot",
"when": "view == rokuDeviceView && !brightscript.rokuDeviceView.enableScreenshotCapture",
"group": "navigation@1"
},
{
"command": "extension.brightscript.rokuDeviceView.resumeScreenshotCapture",
"when": "view == rokuDeviceView && !brightscript.rokuDeviceView.enableScreenshotCapture && !brightscript.rokuDeviceView.isInspectingNodes",
"group": "navigation@2"
},
{
"command": "extension.brightscript.rokuDeviceView.pauseScreenshotCapture",
"when": "view == rokuDeviceView && brightscript.rokuDeviceView.enableScreenshotCapture && !brightscript.rokuDeviceView.isInspectingNodes",
"group": "navigation@2"
},
{
"command": "extension.brightscript.rokuDeviceView.enableNodeInspector",
"when": "view == rokuDeviceView && brightscript.isOnDeviceComponentAvailable && !brightscript.rokuDeviceView.isInspectingNodes",
"group": "navigation@3"
},
{
"command": "extension.brightscript.rokuDeviceView.disableNodeInspector",
"when": "view == rokuDeviceView && brightscript.isOnDeviceComponentAvailable && brightscript.rokuDeviceView.isInspectingNodes",
"group": "navigation@3"
},
{
"command": "extension.brightscript.rokuDeviceView.copyScreenshot",
"when": "view == rokuDeviceView",
"group": "navigation@4"
},
{
"command": "extension.brightscript.disconnectFromDevice",
"when": "view == rokuDeviceView && brightscript.rokuDeviceView.isOnDeviceComponentAvailable",
"group": "navigation@5"
},
{
"command": "extension.brightscript.rokuAutomationView.startRecording",
"when": "view == rokuAutomationView && !brightscript.rokuAutomationView.isRecording",
"group": "navigation"
},
{
"command": "extension.brightscript.rokuAutomationView.stopRecording",
"when": "view == rokuAutomationView && brightscript.rokuAutomationView.isRecording",
"group": "navigation"
},
{
"command": "extension.brightscript.rokuAutomationView.enableAutorunOnDeploy",
"when": "view == rokuAutomationView && !brightscript.rokuAutomationView.autorunOnDeploy",
"group": "navigation@2"
},
{
"command": "extension.brightscript.rokuAutomationView.disableAutorunOnDeploy",
"when": "view == rokuAutomationView && brightscript.rokuAutomationView.autorunOnDeploy",
"group": "navigation@2"
},
{
"command": "extension.brightscript.rokuFileSystemView.refresh",
"when": "view == rokuFileSystemView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@1"
},
{
"command": "extension.brightscript.disconnectFromDevice",
"when": "view == rokuFileSystemView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@2"
},
{
"command": "extension.brightscript.rokuAppOverlaysView.addNewOverlay",
"when": "view == rokuAppOverlaysView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@1"
},
{
"command": "extension.brightscript.rokuAppOverlaysView.removeAllOverlays",
"when": "view == rokuAppOverlaysView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@2"
},
{
"command": "extension.brightscript.disconnectFromDevice",
"when": "view == rokuAppOverlaysView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@3"
},
{
"command": "extension.brightscript.disconnectFromDevice",
"when": "view == rokuCommandsView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@1"
},
{
"command": "extension.brightscript.openSceneGraphInspectorInPanel",
"when": "view == sceneGraphInspectorView",
"group": "navigation@1"
},
{
"command": "extension.brightscript.disconnectFromDevice",
"when": "view == sceneGraphInspectorView && brightscript.isOnDeviceComponentAvailable",
"group": "navigation@2"
}
],
"webview/context": [
{
"command": "extension.brightscript.rokuDeviceView.copyScreenshot",
"when": "webviewId == rokuDeviceView"
}
],
"commandPalette": []
},
"breakpoints": [
{
"language": "brightscript"
},
{
"language": "brighterscript"
}
],
"debuggers": [
{
"label": "BrightScript Debug",
"type": "brightscript",
"program": "./dist/debugAdapter.js",
"runtime": "node",
"configurationAttributes": {
"launch": {
"required": [],
"properties": {
"host": {
"type": "string",
"description": "The host or ip address for the target Roku",
"default": "${promptForHost}"
},
"deepLinkUrl": {
"type": "string",
"description": "A full deep link url to start the debugging session. There's no pretty way of launching directly to a deep link, so the app must be side-loaded, it auto-runs, we stop the app, and then launch it again using the deep link. You may use ${promptForHost}, ${host}, ${promptForQueryParams} which only asks for the URL-encoded querystring, and ${promptForDeepLinkUrl} to enter the entire deep link url at launch-time.",
"default": "http://${host}:8060/launch/dev?${promptForQueryParams}"
},
"password": {
"type": "string",
"description": "The password for the developer page on the target Roku",
"default": "${promptForPassword}"
},
"rootDir": {
"type": "string",
"description": "The root directory that contains your Roku project. This path should point to the folder containing your manifest file",
"default": "${workspaceFolder}"
},
"debugRootDir": {
"type": "string",
"deprecationMessage": "Deprecated. Use sourceDirs instead",
"description": "If you have a build system, rootDir will point to the build output folder, and this path should point to the actual source folder so that breakpoints can be set in the source files when debugging. In order for this to work, your build process cannot change line offsets between source files and built files, otherwise debugger lines will be out of sync.",
"default": "${workspaceFolder}"
},
"sourceDirs": {
"type": "array",
"description": "If you have a build system, this array will point to paths of actual source folders so that breakpoints can be set in the source files when debugging. In order for this to work, your build process cannot change line offsets between source files and built files, otherwise, debugger lines will be out of sync.",
"default": [
"${workspaceFolder}"
]
},
"bsConst": {
"type": "object",
"description": "An object of bs_const values to be updated in the manifest before side loading.",
"patternProperties": {
"^[\\w]+$": {
"type": "boolean",
"required": true
}
},
"additionalProperties": false
},
"rendezvousTracking": {
"type": "boolean",
"description": "Should rendezvous tracking be enabled on launch? If `true`: turn on ECP rendezvous tracking, or turn on 8080 rendezvous tracking if ECP unsupported. If `false`, turn off both.",
"default": true
},
"componentLibrariesPort": {
"type": "number",
"description": "Port to access component libraries.",
"default": 8080
},
"componentLibrariesOutDir": {
"type": "string",
"deprecationMessage": "This no longer user-configurable. This value will be set to \"${outDir}/component-libraries\" by the extension.",
"default": ""
},
"componentLibraries": {
"type": "array",
"description": "An array of file path sets. One for each component library. Each index is an array of file paths, file globs. This will override the defaults, so if specified, you must provide ALL files. See https://npmjs.com/roku-deploy for examples. You must specify a componentLibrariesOutDir to use this.",
"default": [
{
"rootDir": "${workspaceFolder}/LibDir/",
"outFile": "LibName.zip",
"files": [
"manifest",
"source/**/*.*",
"components/**/*.*",
"images/**/*.*"
]
}
],
"items": {
"type": "object",
"description": "Component Library Schema.",
"default": {
"rootDir": "${workspaceFolder}/LibDir/",
"outFile": "LibName.zip",
"files": [
"manifest",
"source/**/*.*",
"components/**/*.*",
"images/**/*.*"
]
},
"required": [
"rootDir",
"outFile",
"files"
],
"properties": {
"rootDir": {
"type": "string",
"description": "Root directory of source files for this component library.",
"examples": [
"${workspaceFolder}/LibDir/"
]
},
"outFile": {
"type": "string",
"description": "A file name and extension used as the static file name for the zip. You can use manifest values in this property such as ${title} to be inferred from the library's manifest file.",
"default": "",
"examples": [
"LibName.zip"
],
"pattern": "^(.*)(\\.zip)$"
},
"files": {
"type": "array",
"description": "A file path or file glob that should be copied to the component library zip.",
"default": [
"manifest",
"source/**/*.*",
"components/**/*.*",
"assets/**/*.*"
],
"items": {
"anyOf": [
{
"type": "string",
"description": "A file path or file glob that should be copied to the component library zip."
},
{
"type": "object",
"properties": {
"src": {
"anyOf": [
{
"type": "string",
"description": "A file path or glob pattern of source file(s) to be included in the component library zip."
},
{
"type": "array",
"description": "An array of file path or globs",
"items": {
"type": "string",
"description": "A file path or glob pattern of source file(s) to be included in the component library zip."
}
}
]
},
"dest": {
"type": "string",
"description": "The destination for the file(s) found in 'src'. If this path is a directory, you must end it in a trailing slash"
}
},
"required": [
"src",
"dest"
]
}
]
}
},
"sourceDirs": {
"type": "array",
"description": "If you have a build system, this array will point to paths of actual source folders so that breakpoints can be set in the source files when debugging. In order for this to work, your build process cannot change line offsets between source files and built files, otherwise, debugger lines will be out of sync.",
"default": [
"${workspaceFolder}"
]
}
}
}
},
"autoRunSgDebugCommands": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"description": "Enables running the 'chanperf' command with a 1 second reporting interval at the start of a debug session.",
"enum": [
"chanperf"
]
},
{
"type": "string",
"description": "Enables running of the 'fps_display 1' command at the start of a debug session.",
"enum": [
"fpsdisplay"
]
},
{
"type": "string",
"description": "Enables running of the 'logrendezvous on' command at the start of a debug session.",
"enum": [
"logrendezvous"
]
},
{
"type": "string",
"description": "Changes the maximum number of brightscript warnings displayed on channel install to zero.",
"enum": [
"brightscript_warnings 0"
]
},
{
"type": "string",
"description": "Custom SGDebug command that will be run on port 8080"
}
]
}
},
"fileLogging": {
"oneOf": [
{
"type": "object",
"description": "Configure file logging for debug console logs as well as RokuCommunity debugger logs",
"default": {
"dir": "${workspaceFolder}/logs",
"rokuDevice": {
"enabled": true,
"filename": "rokuDevice.log",
"mode": "session",
"logLimit": 5
},
"debugger": {
"enabled": true,
"filename": "debugger.log",
"mode": "session",
"logLimit": 5
}
},
"properties": {
"enabled": {
"type": "boolean",
"description": "Should file logging be enabled"
},
"dir": {
"type": "string",
"description": "Directory where log files should be stored. used when filename is relative",
"default": "${workspaceFolder}/logs"
},
"logLimit": {
"type": "number",
"description": "The number of log files to keep. `null` means keep all logs",
"default": null
},
"rokuDevice": {
"oneOf": [
{
"type": "object",
"description": "File logging for the telnet or IO output from the Roku device currently being debugged. (i.e. all the stuff produced by `print` statements in your code)",
"properties": {
"enabled": {
"type": "boolean",
"description": "Should file logging be enabled"
},
"dir": {
"type": "string",
"description": "Directory where log files should be stored. used when filename is relative",
"default": "${workspaceFolder}/logs"
},
"logLimit": {
"type": "number",
"description": "The number of log files to keep. `null` means keep all logs",
"default": null
},
"mode": {
"type": "string",
"description": "`'session'` means a unique timestamped file will be created on every debug session.`'append'` means all logs will be appended to a single file",
"default": "session",
"enum": [
"session",
"append"
]
}
}
},
{
"type": "boolean",
"description": "Enable file logging for debug console logs as well as RokuCommunity debugger logs"
}
]
},
"debugger": {
"oneOf": [
{
"type": "object",
"description": "File logging for the debugger. Mostly used to provide crash logs to the RokuCommunity team.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Should file logging be enabled"
},
"dir": {
"type": "string",
"description": "Directory where log files should be stored. used when filename is relative",
"default": "${workspaceFolder}/logs"
},
"logLimit": {
"type": "number",
"description": "The number of log files to keep. `null` means keep all logs",
"default": null
},
"mode": {
"type": "string",
"description": "`'session'` means a unique timestamped file will be created on every debug session.`'append'` means all logs will be appended to a single file",
"default": "session",
"enum": [
"session",
"append"
]
}
}
},
{
"type": "boolean",
"description": "Enable file logging for debug console logs as well as RokuCommunity debugger logs"
}
]
}
}
},
{
"type": "boolean",
"description": "Enable file logging for debug console logs as well as RokuCommunity debugger logs"
}
]
},
"outDir": {
"type": "string",
"description": "The folder where the the build artifacts are placed (like the staging folder and .zip files of the apps)",
"default": "${workspaceFolder}/out"
},
"stagingDir": {
"type": "string",
"description": "The folder where the vscode will copy all the project files to before creating the zip",
"default": "${workspaceFolder}/out/.roku-deploy-staging"
},
"stopOnEntry": {
"type": "boolean",
"description": "Should the debugger stop on the first line of the program after launch.",
"default": false
},
"retainStagingFolder": {
"type": "boolean",
"description": "Prevent the staging folder from being deleted after the deployment package is created. This is helpful for troubleshooting why your package isn't being created the way you expected.",
"default": false
},
"retainDeploymentArchive": {
"type": "boolean",
"description": "Prevent the deployment package from being deleted after launching a debug session.",
"default": true
},
"enableVariablesPanel": {
"type": "boolean",
"description": "Enables automatic population of the debug variable panel on a breakpoint or runtime errors.",
"default": true
},
"showHiddenVariables": {
"type": "boolean",
"description": "Show variables that are prefixed with a special prefix designated to be hidden",
"default": false
},
"envFile": {
"type": "string",
"description": "A path to an environment variables file.",
"default": ".env"
},
"consoleOutput": {
"type": "string",
"description": "Determines which console output event to listen for. 'full' is every console message (including the ones from the adapter). 'normal' excludes output initiated by the adapter and rendezvous logs if enabled on the device.",
"default": "normal",
"enum": [
"full",
"normal"
]
},
"raleTrackerTaskFileLocation": {
"type": "string",
"description": "This is an absolute path to the TrackerTask.xml file to be injected into your Roku channel during a debug session.",
"scope": "resource"
},
"injectRaleTrackerTask": {
"type": "boolean",
"description": "Will inject the Roku Advanced Layout Editor(RALE) TrackerTask into your channel if one is defined in your user settings.",
"default": false
},
"injectRdbOnDeviceComponent": {
"type": "boolean",
"description": "Will inject the OnDeviceComponent used by RDB for RALE like functionality inside of the extension",
"default": false
},
"disableScreenSaver": {
"type": "boolean",
"description": "If injectRdbOnDeviceComponent is true and this is true the screen saver will be be disabled while the deployed application is running.",
"default": true
},
"files": {
"type": "array",
"description": "An array of file paths, file globs, or {src:string;dest:string} objects that will be copied into the deployment package. This will override the defaults, so if specified, you must provide ALL files. See https://npmjs.com/roku-deploy for examples.",
"default": [
"manifest",
"source/**/*.*",
"components/**/*.*",
"images/**/*.*"
],
"items": {
"anyOf": [
{
"type": "string",
"description": "A file path or file glob that should be copied to the deployment package."
},
{
"type": "object",
"properties": {
"src": {
"anyOf": [
{
"type": "string",
"description": "A file path or glob pattern of source file(s) to be included in the deployment package"
},
{
"type": "array",
"description": "An array of file path or globs",
"items": {
"type": "string",
"description": "A file path or glob pattern of source file(s) to be included in the deployment package"
}
}
]
},
"dest": {
"type": "string",
"description": "The destination for the file(s) found in 'src'. If this path is a directory, you must end it in a trailing slash"
}
},
"required": [
"src",
"dest"
]
}
]
}
},
"enableDebuggerAutoRecovery": {
"type": "boolean",
"description": "Enables automatic continue when hitting an incorrect 'break in' breakpoint, which are produced by a bug in the roku microdebugger, mishandling multiple runloops. This flag will enable you to recover in most cases - wait until the skipping bogus breakpoint messages have all stopped before continuing to use your app, for best results.",
"default": true
},
"stopDebuggerOnAppExit": {
"type": "boolean",
"description": "If true, will terminate the debug session if app exit is detected. This option is ignored when enableDebugProtocol is set to true. This currently relies on 9.1+ launch beacon notifications, so will not work on a pre 9.1 device.",
"default": true
},
"enableSourceMaps": {
"type": "boolean",
"default": true,
"description": "If true, the debugger will read any available sourcemaps and attempt to convert debugger locations into their original source locations.",
"scope": "resource"
},
"emitChannelPublishedEvent": {
"type": "boolean",
"description": "Should the ChannelPublishedEvent be emitted. This is a hack for when certain roku devices become locked up as a result of this event being emitted. You probably don't need to set this",
"default": true
},
"packagePort": {
"type": "number",
"description": "The port used for package-related requests. This is mainly used for things like emulators, or when your roku is behind a firewall with a port-forward.",
"default": 80
},
"remotePort": {
"type": "number",
"description": "The port used for sending remote control commands (like home press or back press). This is mainly used for things like emulators, or when your roku is behind a firewall with a port-forward.",
"default": 8060
},
"logfilePath": {
"type": "string",
"deprecationMessage": "Use `fileLogging` option instead",
"description": "A path to a file where all brightscript console output will be written. If null or empty, file logging will be disabled."
},
"packageTask": {
"type": "string",
"description": "Task to run instead of roku-deploy to produce the .zip file that will be uploaded to the Roku."
},
"packagePath": {
"type": "string",
"description": "Path to the .zip that will be uploaded to the Roku"
},
"packageUploadOverrides": {
"type": "object",
"description": "Overrides for values used during the roku-deploy zip upload process, like the route and various form data. You probably don't need to change these...",
"default": {
"route": "plugin_install",
"formData": {}
},
"required": [],
"properties": {
"route": {
"type": "string",
"description": "The route to use for uploading to the Roku device. Defaults to 'plugin_install'",
"default": "plugin_install"
},
"formData": {
"type": "object",
"description": "A dictionary of form fields to be included in the package upload request. Set a value to null to delete from the form",
"additionalProperties": true,
"default": {
"someformfield": "someFormValue"
}
}
}
},
"enableDebugProtocol": {
"type": "boolean",
"default": false,
"description": "If true, the debugger will use the new BrightScript debug protocol, and will disable the telnet debugger. See this link for more details: https://developer.roku.com/en-ca/docs/developer-program/debugging/socket-based-debugger.md"
},
"logLevel": {
"type": "string",
"enum": [
"off",
"error",
"warn",
"log",
"info",
"debug",
"trace"
],
"default": "log",
"description": "The level of logging that should be done during a debug session."
},
"deleteDevChannelBeforeInstall": {
"type": "boolean",
"default": false,
"description": "Delete any currently installed dev channel before starting the debug session"
},
"sceneGraphDebugCommandsPort": {
"type": "number",
"default": 8080,
"description": "Port for sending SceneGraph debug commands"
},
"remoteControlMode": {
"oneOf": [
{
"type": "object",
"description": "Options for activating and deactivating remote control mode",
"properties": {
"activateOnSessionStart": {
"type": "boolean",
"description": "Activate remote control mode on debug session start"
},
"deactivateOnSessionEnd": {
"type": "boolean",
"description": "Deactivate remote control mode on session end"
}
}
},
{
"type": "boolean",
"description": "Activate on session start, deactivate on session end."
}
]
}
}
}