/
package.json
1119 lines (1119 loc) · 50.7 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": "powershell",
"displayName": "PowerShell",
"version": "2024.2.2",
"preview": false,
"publisher": "ms-vscode",
"description": "Develop PowerShell modules, commands and scripts in Visual Studio Code!",
"engines": {
"vscode": "^1.82.0"
},
"author": "Microsoft Corporation",
"license": "SEE LICENSE IN LICENSE.txt",
"homepage": "https://github.com/PowerShell/vscode-powershell/blob/main/README.md",
"categories": [
"Debuggers",
"Formatters",
"Programming Languages",
"Snippets",
"Linters",
"Themes"
],
"keywords": [
"PowerShell",
"pwsh"
],
"icon": "media/PowerShell_Icon.png",
"galleryBanner": {
"color": "#ACD1EC",
"theme": "light"
},
"badges": [
{
"url": "https://github.com/PowerShell/vscode-powershell/actions/workflows/ci-test.yml/badge.svg",
"href": "https://github.com/PowerShell/vscode-powershell/actions/workflows/ci-test.yml?query=branch%3Amain",
"description": "Build Status"
},
{
"url": "https://img.shields.io/discord/180528040881815552.svg?label=%23vscode&logo=discord&logoColor=white",
"href": "https://aka.ms/powershell-vscode-discord",
"description": "Join the chat on Discord"
},
{
"url": "https://badges.gitter.im/PowerShell/vscode-powershell.svg",
"href": "https://gitter.im/PowerShell/vscode-powershell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge",
"description": "Join the chat on Gitter"
}
],
"repository": {
"type": "git",
"url": "https://github.com/PowerShell/vscode-powershell.git"
},
"bugs": {
"url": "https://github.com/PowerShell/vscode-powershell/issues"
},
"activationEvents": [
"onDebugResolve:PowerShell",
"onLanguage:powershell",
"onCommand:PowerShell.OpenExamplesFolder",
"onCommand:PowerShell.PickPSHostProcess",
"onCommand:PowerShell.PickRunspace",
"onCommand:PowerShell.SpecifyScriptArgs",
"onCommand:PowerShell.ShowSessionConsole",
"onCommand:PowerShell.ShowSessionMenu",
"onCommand:PowerShell.RestartSession",
"onCommand:PowerShell.ShowLogs",
"onCommand:PowerShell.OpenLogFolder",
"onCommand:PowerShell.GenerateBugReport",
"onCommand:PowerShell.OpenExamplesFolder",
"onCommand:PowerShell.EnableISEMode",
"onCommand:PowerShell.DisableISEMode",
"onCommand:PowerShell.ToggleISEMode",
"onView:PowerShellCommands",
"onWalkthrough:PowerShell"
],
"dependencies": {
"@vscode/extension-telemetry": "^0.9.6",
"node-fetch": "^2.7.0",
"semver": "^7.6.0",
"untildify": "^4.0.0",
"uuid": "^9.0.1",
"vscode-languageclient": "^9.0.1",
"vscode-languageserver-protocol": "^3.17.5"
},
"devDependencies": {
"@types/mocha": "^10.0.6",
"@types/mock-fs": "^4.13.4",
"@types/node": "^18.19.31",
"@types/node-fetch": "^2.6.11",
"@types/rewire": "^2.5.30",
"@types/semver": "^7.5.8",
"@types/sinon": "^17.0.3",
"@types/ungap__structured-clone": "^1.2.0",
"@types/uuid": "^9.0.8",
"@types/vscode": "~1.82.0",
"@typescript-eslint/eslint-plugin": "^7.8.0",
"@typescript-eslint/parser": "^7.8.0",
"@ungap/structured-clone": "^1.2.0",
"@vscode/debugprotocol": "^1.65.0",
"@vscode/test-electron": "^2.3.9",
"@vscode/vsce": "^2.26.1",
"esbuild": "^0.20.2",
"eslint": "^8.57.0",
"eslint-plugin-header": "^3.1.1",
"glob": "^10.3.12",
"mocha": "^10.4.0",
"mocha-explorer-launcher-scripts": "^0.4.0",
"mocha-multi-reporters": "^1.5.1",
"mock-fs": "^5.2.0",
"rewire": "^7.0.0",
"sinon": "^17.0.1",
"source-map-support": "^0.5.21",
"typescript": "^5.4.5"
},
"extensionDependencies": [
"vscode.powershell"
],
"main": "./dist/extension.js",
"scripts": {
"compile": "esbuild ./src/extension.ts --outdir=dist --sourcemap --bundle --external:vscode --platform=node",
"watch": "npm run compile -- --watch",
"lint": "eslint src test --ext .ts",
"package": "vsce package --out out/ --no-gitHubIssueLinking",
"publish": "vsce publish",
"compile-test": "npm run compile && tsc --incremental",
"watch-tests": "npm run compile-test -- --watch",
"test": "npm run compile-test && node ./test/runTests.js"
},
"contributes": {
"breakpoints": [
{
"language": "powershell"
}
],
"viewsContainers": {
"activitybar": [
{
"id": "PowerShell",
"title": "PowerShell",
"icon": "$(terminal-powershell)"
}
]
},
"views": {
"PowerShell": [
{
"id": "PowerShellCommands",
"name": "Command Explorer",
"when": "config.powershell.sideBar.CommandExplorerVisibility"
}
]
},
"keybindings": [
{
"command": "PowerShell.ShowHelp",
"key": "ctrl+f1",
"when": "editorTextFocus && editorLangId == 'powershell'"
},
{
"command": "PowerShell.ExpandAlias",
"key": "shift+alt+e",
"when": "editorTextFocus && editorLangId == 'powershell'"
},
{
"command": "PowerShell.ShowAdditionalCommands",
"key": "shift+alt+s",
"when": "editorTextFocus && editorLangId == 'powershell'"
},
{
"command": "PowerShell.RunSelection",
"key": "f8",
"when": "editorTextFocus && editorLangId == 'powershell'"
},
{
"command": "editor.action.insertSnippet",
"when": "editorTextFocus && editorLangId == 'powershell'",
"mac": "cmd+alt+j",
"win": "ctrl+alt+j",
"linux": "ctrl+alt+j"
}
],
"commands": [
{
"command": "PowerShell.ExpandAlias",
"title": "Expand Alias",
"category": "PowerShell"
},
{
"command": "PowerShell.EnableISEMode",
"title": "Enable ISE Mode",
"category": "PowerShell"
},
{
"command": "PowerShell.DisableISEMode",
"title": "Disable ISE Mode (restore to defaults)",
"category": "PowerShell"
},
{
"command": "PowerShell.ToggleISEMode",
"title": "Toggle ISE Mode",
"category": "PowerShell"
},
{
"command": "PowerShell.RefreshCommandsExplorer",
"title": "Refresh Command Explorer",
"category": "PowerShell",
"icon": "$(sync)"
},
{
"command": "PowerShell.InsertCommand",
"title": "Insert Command",
"category": "PowerShell",
"icon": "$(pencil)"
},
{
"command": "PowerShell.ShowHelp",
"title": "Get Help for Command",
"category": "PowerShell",
"icon": "$(question)"
},
{
"command": "PowerShell.Debug.Start",
"title": "Run",
"category": "PowerShell",
"icon": "$(run)"
},
{
"command": "PowerShell.RunSelection",
"title": "Run Selection",
"category": "PowerShell",
"icon": "$(debug-line-by-line)"
},
{
"command": "PowerShell.RestartSession",
"title": "Restart Session",
"category": "PowerShell"
},
{
"command": "PowerShell.ShowLogs",
"title": "Show PowerShell Extension Logs",
"category": "PowerShell"
},
{
"command": "PowerShell.OpenLogFolder",
"title": "Open PowerShell Extension Logs Folder",
"category": "PowerShell"
},
{
"command": "PowerShell.GenerateBugReport",
"title": "Upload Bug Report to GitHub",
"category": "PowerShell"
},
{
"command": "PowerShell.OpenInISE",
"title": "Open Current File in PowerShell ISE",
"category": "PowerShell"
},
{
"command": "PowerShell.PowerShellFindModule",
"title": "Find/Install PowerShell Modules from the Gallery",
"category": "PowerShell",
"deprecationMessage": "This feature is no longer available, we're sorry!"
},
{
"command": "PowerShell.ShowAdditionalCommands",
"title": "Show Additional Commands from PowerShell Modules",
"category": "PowerShell"
},
{
"command": "PowerShell.ShowSessionMenu",
"title": "Show Session Menu",
"category": "PowerShell"
},
{
"command": "PowerShell.ShowSessionConsole",
"title": "Show Extension Terminal",
"category": "PowerShell"
},
{
"command": "PowerShell.RunPesterTestsFromFile",
"title": "Run Pester tests",
"category": "PowerShell"
},
{
"command": "PowerShell.DebugPesterTestsFromFile",
"title": "Debug Pester tests",
"category": "PowerShell"
},
{
"command": "PowerShell.OpenExamplesFolder",
"title": "Open Examples Folder",
"category": "PowerShell"
},
{
"command": "PowerShell.InvokeRegisteredEditorCommand",
"title": "Invoke Registered Editor Command",
"category": "PowerShell"
},
{
"command": "PowerShell.ClosePanel",
"title": "Close panel",
"category": "PowerShell"
},
{
"command": "PowerShell.PositionPanelLeft",
"title": "Move panel left",
"category": "PowerShell",
"icon": "$(layout-sidebar-left)"
},
{
"command": "PowerShell.PositionPanelBottom",
"title": "Move panel to bottom",
"category": "PowerShell",
"icon": "$(layout-panel-right)"
}
],
"menus": {
"commandPalette": [
{
"command": "PowerShell.InsertCommand",
"when": "false"
},
{
"command": "PowerShell.RefreshCommandsExplorer",
"when": "config.powershell.sideBar.CommandExplorerVisibility"
},
{
"command": "PowerShell.InvokeRegisteredEditorCommand",
"when": "false"
}
],
"explorer/context": [
{
"command": "PowerShell.RunPesterTestsFromFile",
"when": "resourceFilename =~ /\\.tests\\.ps1$/i"
},
{
"command": "PowerShell.DebugPesterTestsFromFile",
"when": "resourceFilename =~ /\\.tests\\.ps1$/i"
}
],
"editor/context": [
{
"when": "editorLangId == powershell",
"command": "PowerShell.RunSelection",
"group": "2_powershell"
},
{
"when": "editorLangId == powershell",
"command": "PowerShell.ShowHelp",
"group": "2_powershell"
}
],
"editor/title": [
{
"when": "editorLangId == powershell && config.powershell.buttons.showPanelMovementButtons",
"command": "PowerShell.PositionPanelBottom",
"group": "navigation@97"
},
{
"when": "editorLangId == powershell && config.powershell.buttons.showPanelMovementButtons",
"command": "PowerShell.PositionPanelLeft",
"group": "navigation@98"
},
{
"when": "editorLangId == powershell && config.powershell.buttons.showRunButtons",
"command": "PowerShell.Debug.Start",
"group": "navigation@100"
},
{
"when": "editorLangId == powershell && config.powershell.buttons.showRunButtons",
"command": "PowerShell.RunSelection",
"group": "navigation@101"
}
],
"editor/title/context": [
{
"when": "resourceFilename =~ /\\.tests\\.ps1$/i",
"command": "PowerShell.RunPesterTestsFromFile"
},
{
"when": "resourceFilename =~ /\\.tests\\.ps1$/i",
"command": "PowerShell.DebugPesterTestsFromFile"
}
],
"view/title": [
{
"command": "PowerShell.RefreshCommandsExplorer",
"when": "view == PowerShellCommands",
"group": "navigation"
}
],
"view/item/context": [
{
"command": "PowerShell.ShowHelp",
"when": "view == PowerShellCommands",
"group": "inline@1"
},
{
"command": "PowerShell.InsertCommand",
"when": "view == PowerShellCommands",
"group": "inline@2"
}
]
},
"problemMatchers": [
{
"name": "pester",
"owner": "powershell",
"fileLocation": [
"absolute"
],
"severity": "error",
"pattern": [
{
"regexp": "^\\s*(?:\\[-\\]\\s+)(.*?)(?:\\s+\\d+\\.?\\d*\\s*m?s)(?:\\s+\\(\\d+\\.?\\d*m?s\\|\\d+\\.?\\d*m?s\\))?\\s*$",
"message": 1
},
{
"regexp": "^\\s+[Aa]t\\s+([^,]+,)?(.+?):(\\s+line\\s+)?(\\d+)(\\s+char:\\d+)?$",
"file": 2,
"line": 4
}
]
}
],
"snippets": [
{
"language": "powershell",
"path": "./snippets/PowerShell.json"
}
],
"debuggers": [
{
"type": "PowerShell",
"label": "PowerShell",
"variables": {
"PickPSHostProcess": "PowerShell.PickPSHostProcess",
"PickRunspace": "PowerShell.PickRunspace",
"SpecifyScriptArgs": "PowerShell.SpecifyScriptArgs"
},
"languages": [
"powershell"
],
"configurationSnippets": [
{
"label": "PowerShell: Launch Current File",
"description": "Launch and debug the file in the currently active editor window",
"body": {
"name": "PowerShell Launch Current File",
"type": "PowerShell",
"request": "launch",
"script": "^\"\\${file}\"",
"cwd": "^\"\\${cwd}\""
}
},
{
"label": "PowerShell: Launch Script",
"description": "Launch and debug the specified file or command",
"body": {
"name": "PowerShell Launch Script",
"type": "PowerShell",
"request": "launch",
"script": "^\"enter path or command to execute e.g.: \\${workspaceFolder}/src/foo.ps1 or Invoke-Pester\"",
"cwd": "^\"\\${cwd}\""
}
},
{
"label": "PowerShell: Interactive Session",
"description": "Debug commands executed from the Extension Terminal",
"body": {
"name": "PowerShell Interactive Session",
"type": "PowerShell",
"request": "launch",
"cwd": "^\"\\${cwd}\""
}
},
{
"label": "PowerShell: Attach to PowerShell Host Process",
"description": "Attach the debugger to a running PowerShell Host Process",
"body": {
"name": "PowerShell Attach to Host Process",
"type": "PowerShell",
"request": "attach"
}
},
{
"label": "PowerShell: Run Pester Tests",
"description": "Debug Pester Tests detected in your current directory (runs Invoke-Pester)",
"body": {
"name": "PowerShell Run Pester Tests",
"type": "PowerShell",
"request": "launch",
"script": "Invoke-Pester",
"createTemporaryIntegratedConsole": true,
"attachDotnetDebugger": true
}
},
{
"label": "PowerShell: Interactive Session (Module)",
"description": "Debug commands executed from the PowerShell Extension Terminal after auto-loading your module",
"body": {
"name": "PowerShell: Module Interactive Session",
"type": "PowerShell",
"request": "launch",
"script": "Enter command to import your binary module, for example: \"Import-Module -Force ${workspaceFolder}/path/to/module.psd1|dll\""
}
},
{
"label": "PowerShell: Interactive Session (Binary Module)",
"description": "Debug a .NET binary or hybrid module loaded into a PowerShell session. Breakpoints you set in your .NET (C#/F#/VB/etc.) code will be hit upon command execution. You may want to add a compile or watch action as a pre-launch task to this configuration.",
"body": {
"name": "PowerShell: Binary Module Interactive",
"type": "PowerShell",
"request": "launch",
"script": "Enter command to import your binary module, for example: \"Import-Module -Force ${workspaceFolder}/path/to/module.psd1|dll\"",
"createTemporaryIntegratedConsole": true,
"attachDotnetDebugger": true
}
},
{
"label": "Run Pester Tests (Binary Module)",
"description": "Debug a .NET binary or hybrid module by running Pester tests. Breakpoints you set in your .NET (C#/F#/VB/etc.) code will be hit upon command execution. You may want to add a compile or watch action as a pre-launch task to this configuration.",
"body": {
"name": "PowerShell: Binary Module Pester Tests",
"type": "PowerShell",
"request": "launch",
"script": "Invoke-Pester",
"createTemporaryIntegratedConsole": true,
"attachDotnetDebugger": true
}
}
],
"configurationAttributes": {
"launch": {
"properties": {
"script": {
"type": "string",
"description": "Optional: Absolute path to the PowerShell script to launch under the debugger."
},
"args": {
"type": "array",
"description": "Command line arguments to pass to the PowerShell script. Specify \"${command:SpecifyScriptArgs}\" if you want to be prompted for the args.",
"items": {
"type": "string"
},
"default": []
},
"cwd": {
"type": "string",
"description": "Absolute path to the working directory. Default is the current workspace folder.",
"default": "${workspaceFolder}"
},
"createTemporaryIntegratedConsole": {
"type": "boolean",
"description": "Determines whether a temporary PowerShell Extension Terminal is created for each debugging session, useful for debugging PowerShell classes and binary modules. Overrides the user setting 'powershell.debugging.createTemporaryIntegratedConsole'.",
"default": false
},
"attachDotnetDebugger": {
"type": "boolean",
"description": "If specified, a C# debug session will be started and attached to the new temporary extension terminal. This does nothing unless 'powershell.debugging.createTemporaryIntegratedConsole' is also specified.",
"default": false
},
"dotnetDebuggerConfigName": {
"type": "string",
"description": "If you would like to use a custom coreclr attach debug launch configuration for the debug session, specify the name here. Otherwise a default basic config will be used. The config must be a coreclr attach config. Launch configs are not supported.",
"default": false
}
}
},
"attach": {
"properties": {
"computerName": {
"type": "string",
"description": "Optional: The computer name to which a remote session will be established.",
"default": null
},
"processId": {
"type": "number",
"description": "Optional: The ID of the PowerShell host process that should be attached. Will prompt if unspecified.",
"default": null
},
"runspaceId": {
"type": "number",
"description": "Optional: The ID of the runspace to debug in the attached process. Will prompt if unspecified.",
"default": null
},
"runspaceName": {
"type": "string",
"description": "Optional: The name of the runspace to debug in the attached process.",
"default": null
},
"customPipeName": {
"type": "string",
"description": "The custom pipe name of the PowerShell host process to attach to.",
"default": null
}
}
}
},
"initialConfigurations": []
}
],
"configuration": {
"title": "PowerShell",
"properties": {
"powershell.sideBar.CommandExplorerVisibility": {
"type": "boolean",
"default": false,
"markdownDescription": "Specifies the visibility of the Command Explorer in the side bar."
},
"powershell.sideBar.CommandExplorerExcludeFilter": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"markdownDescription": "Specifies an array of modules to exclude from Command Explorer listing."
},
"powershell.powerShellAdditionalExePaths": {
"type": "object",
"default": {},
"markdownDescription": "Specifies a list of Item / Value pairs where the **Item** is a user-chosen name and the **Value** is an absolute path to a PowerShell executable. The name appears in the [Session Menu Command](command:PowerShell.ShowSessionMenu) and is used to reference this executable in the `#powershell.powerShellDefaultVersion#` setting.",
"additionalProperties": {
"type": "string"
}
},
"powershell.powerShellDefaultVersion": {
"type": "string",
"default": "",
"markdownDescription": "Specifies the default PowerShell version started by the extension. The name must match what is displayed in the [Session Menu command](command:PowerShell.ShowSessionMenu), for example, `Windows PowerShell (x86)`. You can specify additional PowerShell executables with the `#powershell.powerShellAdditionalExePaths#` setting."
},
"powershell.powerShellExePath": {
"type": "string",
"default": "",
"scope": "machine",
"markdownDescription": "**Deprecated:** Specifies the path to the PowerShell executable.",
"markdownDeprecationMessage": "**Deprecated:** Please use the `#powershell.powerShellAdditionalExePaths#` setting instead."
},
"powershell.promptToUpdatePowerShell": {
"type": "boolean",
"default": true,
"markdownDescription": "Specifies whether you may be prompted to update your version of PowerShell."
},
"powershell.promptToUpdatePackageManagement": {
"type": "boolean",
"default": false,
"markdownDescription": "**Deprecated:** Specifies whether you should be prompted to update your version of `PackageManagement` if it's under 1.4.6.",
"markdownDeprecationMessage": "**Deprecated:** This prompt has been removed as it's no longer strictly necessary to upgrade the `PackageManagement` module."
},
"powershell.suppressAdditionalExeNotFoundWarning": {
"type": "boolean",
"default": false,
"markdownDescription": "Suppresses the warning message when any of `#powershell.powerShellAdditionalExePaths#` is not found."
},
"powershell.startAsLoginShell.osx": {
"type": "boolean",
"default": true,
"markdownDescription": "Starts the PowerShell extension's underlying PowerShell process as a login shell, if applicable."
},
"powershell.startAsLoginShell.linux": {
"type": "boolean",
"default": false,
"markdownDescription": "Starts the PowerShell extension's underlying PowerShell process as a login shell, if applicable."
},
"powershell.startAutomatically": {
"type": "boolean",
"default": true,
"markdownDescription": "Starts the PowerShell extension automatically when a PowerShell file is opened. If `false`, to start the extension use the [Restart Session command](command:PowerShell.RestartSession). **IntelliSense, code navigation, the Extension Terminal, code formatting, and other features are not enabled until the extension starts.**"
},
"powershell.useX86Host": {
"type": "boolean",
"default": false,
"markdownDescription": "**Deprecated:** Uses the 32-bit language service on 64-bit Windows. This setting has no effect on 32-bit Windows or on the PowerShell extension debugger, which has its own architecture configuration.",
"markdownDeprecationMessage": "**Deprecated:** This setting was removed when the PowerShell installation searcher was added. Please use the `#powershell.powerShellAdditionalExePaths#` setting instead."
},
"powershell.enableProfileLoading": {
"type": "boolean",
"default": true,
"markdownDescription": "Specifies whether the extension loads [PowerShell profiles](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles). Note that the extension's \"Current Host\" profile is `Microsoft.VSCode_profile.ps1`, which will be loaded instead of the default \"Current Host\" profile of `Microsoft.PowerShell_profile.ps1`. Use the \"All Hosts\" profile `profile.ps1` for common configuration."
},
"powershell.enableReferencesCodeLens": {
"type": "boolean",
"default": true,
"markdownDescription": "Specifies if Code Lenses are displayed above function definitions, used to show the number of times the function is referenced in the workspace and navigate to those references. Large workspaces may want to disable this setting if performance is compromised. See also `#powershell.analyzeOpenDocumentsOnly#`."
},
"powershell.analyzeOpenDocumentsOnly": {
"type": "boolean",
"default": false,
"markdownDescription": "Specifies to search for references only within open documents instead of all workspace files. An alternative to `#powershell.enableReferencesCodeLens#` that allows large workspaces to support some references without the performance impact."
},
"powershell.bugReporting.project": {
"type": "string",
"default": "https://github.com/PowerShell/vscode-powershell",
"markdownDescription": "**Deprecated:** Specifies the URL of the GitHub project in which to generate bug reports.",
"markdownDeprecationMessage": "**Deprecated:** This setting was never meant to be changed!"
},
"powershell.helpCompletion": {
"type": "string",
"default": "BlockComment",
"enum": [
"Disabled",
"BlockComment",
"LineComment"
],
"markdownEnumDescriptions": [
"Disables the feature.",
"Inserts a block style help comment, for example:\n\n`<#`\n\n`.<help keyword>`\n\n`<help content>`\n\n`#>`",
"Inserts a line style help comment, for example:\n\n`# .<help keyword>`\n\n`# <help content>`"
],
"markdownDescription": "Specifies the [comment based help](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help) completion style triggered by typing ` ##`."
},
"powershell.cwd": {
"type": "string",
"default": "",
"markdownDescription": "A path where the Extension Terminal will be launched. Both the PowerShell process's and the shell's location will be set to this directory. Does not support variables, but does support the use of '~' and paths relative to a single workspace. **For multi-root workspaces, use the name of the folder you wish to have as the cwd.**"
},
"powershell.scriptAnalysis.enable": {
"type": "boolean",
"default": true,
"markdownDescription": "Enables real-time script analysis using [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) that populates the [Problems view](command:workbench.panel.markers.view.focus)."
},
"powershell.scriptAnalysis.settingsPath": {
"type": "string",
"default": "PSScriptAnalyzerSettings.psd1",
"markdownDescription": "Specifies the path to a [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) settings file. **This setting may not work as expected currently!**"
},
"powershell.codeFolding.enable": {
"type": "boolean",
"default": true,
"markdownDescription": "Enables syntax based code folding. When disabled, the default indentation based code folding is used."
},
"powershell.codeFolding.showLastLine": {
"type": "boolean",
"default": true,
"markdownDescription": "Shows the last line of a folded section similar to the default VS Code folding style. When disabled, the entire folded region is hidden."
},
"powershell.codeFormatting.autoCorrectAliases": {
"type": "boolean",
"default": false,
"markdownDescription": "Replaces aliases with their aliased name."
},
"powershell.codeFormatting.avoidSemicolonsAsLineTerminators": {
"type": "boolean",
"default": false,
"markdownDescription": "Removes redundant semicolon(s) at the end of a line where a line terminator is sufficient."
},
"powershell.codeFormatting.preset": {
"type": "string",
"default": "Custom",
"enum": [
"Custom",
"Allman",
"OTBS",
"Stroustrup"
],
"markdownEnumDescriptions": [
"The three brace settings are respected as-is.",
"Sets `#powershell.codeFormatting.openBraceOnSameLine#` to `false`, `#powershell.codeFormatting.newLineAfterOpenBrace#` to `true`, and `#powershell.codeFormatting.newLineAfterCloseBrace#` to `true`.",
"Sets `#powershell.codeFormatting.openBraceOnSameLine#` to `true`, `#powershell.codeFormatting.newLineAfterOpenBrace#` to `true`, and `#powershell.codeFormatting.newLineAfterCloseBrace#` to `false`.",
"Sets `#powershell.codeFormatting.openBraceOnSameLine#` to `true`, `#powershell.codeFormatting.newLineAfterOpenBrace#` to `true`, and `#powershell.codeFormatting.newLineAfterCloseBrace#` to `true`."
],
"markdownDescription": "Sets the code formatting options to follow the given indent style in a way that is compatible with PowerShell syntax. Any setting other than `Custom` will configure (and override) the settings:\n\n* `#powershell.codeFormatting.openBraceOnSameLine#`\n\n* `#powershell.codeFormatting.newLineAfterOpenBrace#`\n\n* `#powershell.codeFormatting.newLineAfterCloseBrace#`\n\nFor more information about the brace styles, please see [PoshCode's discussion](https://github.com/PoshCode/PowerShellPracticeAndStyle/issues/81)."
},
"powershell.codeFormatting.openBraceOnSameLine": {
"type": "boolean",
"default": true,
"markdownDescription": "Places open brace on the same line as its associated statement."
},
"powershell.codeFormatting.newLineAfterOpenBrace": {
"type": "boolean",
"default": true,
"markdownDescription": "Adds a newline (line break) after an open brace."
},
"powershell.codeFormatting.newLineAfterCloseBrace": {
"type": "boolean",
"default": true,
"markdownDescription": "Adds a newline (line break) after a closing brace."
},
"powershell.codeFormatting.pipelineIndentationStyle": {
"type": "string",
"default": "NoIndentation",
"enum": [
"IncreaseIndentationForFirstPipeline",
"IncreaseIndentationAfterEveryPipeline",
"NoIndentation",
"None"
],
"markdownEnumDescriptions": [
"Indent once after the first pipeline and keep this indentation.",
"Indent more after the first pipeline and keep this indentation.",
"Do not increase indentation.",
"Do not change any existing pipeline indentation (disables feature)."
],
"markdownDescription": "Whether to increase indentation after a pipeline for multi-line statements. See [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer/blob/a94d9f5666bba9f569cdf9c1bc99556934f2b8f4/docs/Rules/UseConsistentIndentation.md#pipelineindentation-string-default-value-is-increaseindentationforfirstpipeline) for examples. It is suggested to use `IncreaseIndentationForFirstPipeline` instead of the default `NoIndentation`. **This default may change in the future,** please see the [Request For Comment](https://github.com/PowerShell/vscode-powershell/issues/4296)."
},
"powershell.codeFormatting.whitespaceBeforeOpenBrace": {
"type": "boolean",
"default": true,
"markdownDescription": "Adds a space between a keyword and its associated script-block expression."
},
"powershell.codeFormatting.whitespaceBeforeOpenParen": {
"type": "boolean",
"default": true,
"markdownDescription": "Adds a space between a keyword (`if`, `elseif`, `while`, `switch`, etc.) and its associated conditional expression."
},
"powershell.codeFormatting.whitespaceAroundOperator": {
"type": "boolean",
"default": true,
"markdownDescription": "Adds spaces before and after an operator (`=`, `+`, `-`, etc.)."
},
"powershell.codeFormatting.whitespaceAfterSeparator": {
"type": "boolean",
"default": true,
"markdownDescription": "Adds a space after a separator (`,` and `;`)."
},
"powershell.codeFormatting.whitespaceInsideBrace": {
"type": "boolean",
"default": true,
"markdownDescription": "Adds a space after an opening brace (`{`) and before a closing brace (`}`)."
},
"powershell.codeFormatting.whitespaceBetweenParameters": {
"type": "boolean",
"default": false,
"markdownDescription": "Removes redundant whitespace between parameters."
},
"powershell.codeFormatting.whitespaceAroundPipe": {
"type": "boolean",
"default": true,
"markdownDescription": "**Deprecated:** Please use the `#powershell.codeFormatting.addWhitespaceAroundPipe#` setting instead. If you've used this setting before, we have moved it for you automatically.",
"markdownDeprecationMessage": "**Deprecated:** Please use the `#powershell.codeFormatting.addWhitespaceAroundPipe#` setting instead. If you've used this setting before, we have moved it for you automatically."
},
"powershell.codeFormatting.addWhitespaceAroundPipe": {
"type": "boolean",
"default": true,
"markdownDescription": "Adds a space before and after the pipeline operator (`|`) if it is missing."
},
"powershell.codeFormatting.trimWhitespaceAroundPipe": {
"type": "boolean",
"default": false,
"markdownDescription": "Trims extraneous whitespace (more than one character) before and after the pipeline operator (`|`)."
},
"powershell.codeFormatting.ignoreOneLineBlock": {
"type": "boolean",
"default": true,
"markdownDescription": "Does not reformat one-line code blocks, such as: `if (...) {...} else {...}`."
},
"powershell.codeFormatting.alignPropertyValuePairs": {
"type": "boolean",
"default": true,
"markdownDescription": "Align assignment statements in a hashtable or a DSC Configuration."
},
"powershell.codeFormatting.useConstantStrings": {
"type": "boolean",
"default": false,
"markdownDescription": "Use single quotes if a string is not interpolated and its value does not contain a single quote."
},
"powershell.codeFormatting.useCorrectCasing": {
"type": "boolean",
"default": false,
"markdownDescription": "Use correct casing for cmdlets."
},
"powershell.integratedConsole.showOnStartup": {
"type": "boolean",
"default": true,
"markdownDescription": "Shows the Extension Terminal when the PowerShell extension is initialized. When disabled, the pane is not opened on startup, but the Extension Terminal is still created in order to power the extension's features."
},
"powershell.integratedConsole.startInBackground": {
"type": "boolean",
"default": false,
"markdownDescription": "Starts the Extension Terminal in the background. **If this is enabled, to access the terminal you must run the [Show Extension Terminal command](command:PowerShell.ShowSessionConsole), and once shown it cannot be put back into the background.** This option completely hides the Extension Terminal from the terminals view. You are probably looking for the `#powershell.integratedConsole.showOnStartup#` option instead."
},
"powershell.integratedConsole.startLocation": {
"type": "string",
"default": "Panel",
"enum": [
"Editor",
"Panel"
],
"markdownEnumDescriptions": [
"Creates the Extension Terminal in Editor area",
"Creates the Extension Terminal in Panel area"
],
"markdownDescription": "Sets the startup location for Extension Terminal."
},
"powershell.integratedConsole.focusConsoleOnExecute": {
"type": "boolean",
"default": true,
"markdownDescription": "Switches focus to the console when a script selection is run or a script file is debugged."
},
"powershell.integratedConsole.useLegacyReadLine": {
"type": "boolean",
"default": false,
"markdownDescription": "This will disable the use of PSReadLine in the PowerShell Extension Terminal and use a legacy implementation. **This setting is not recommended and likely to be deprecated!**"
},
"powershell.integratedConsole.forceClearScrollbackBuffer": {
"type": "boolean",
"default": false,
"markdownDescription": "Use the VS Code API to clear the terminal since that's the only reliable way to clear the scrollback buffer. Turn this on if you're used to `Clear-Host` clearing scroll history. **This setting is not recommended and likely to be deprecated!**"
},
"powershell.integratedConsole.suppressStartupBanner": {
"type": "boolean",
"default": false,
"markdownDescription": "Do not show the startup banner in the PowerShell Extension Terminal."
},
"powershell.debugging.createTemporaryIntegratedConsole": {
"type": "boolean",
"default": false,
"markdownDescription": "Creates a temporary PowerShell Extension Terminal for each debugging session. This is useful for debugging PowerShell classes and binary modules."
},
"powershell.developer.bundledModulesPath": {
"type": "string",
"default": "../../PowerShellEditorServices/module",
"markdownDescription": "Specifies an alternative path to the folder containing modules that are bundled with the PowerShell extension, that is: PowerShell Editor Services, PSScriptAnalyzer and PSReadLine. **This setting is only meant for extension developers and requires the extension to be run in development mode!**"
},
"powershell.developer.editorServicesLogLevel": {
"type": "string",
"default": "Normal",
"enum": [
"Diagnostic",
"Verbose",
"Normal",
"Warning",
"Error",
"None"
],
"markdownEnumDescriptions": [
"Enables all logging possible, please use this setting when submitting logs for bug reports!",
"Enables more logging than normal.",
"The default logging level.",
"Only log warnings and errors.",
"Only log errors.",
"Disable all logging possible. No log files will be written!"
],
"markdownDescription": "Sets the log verbosity for both the extension and its LSP server, PowerShell Editor Services. **Please set to `Diagnostic` when recording logs for a bug report!**"
},
"powershell.developer.editorServicesWaitForDebugger": {
"type": "boolean",
"default": false,
"markdownDescription": "Launches the LSP server with the `/waitForDebugger` flag to force it to wait for a .NET debugger to attach before proceeding, and emit its PID until then. **This setting is only meant for extension developers and requires the extension to be run in development mode!**"
},
"powershell.developer.setExecutionPolicy": {
"type": "boolean",
"default": true,
"markdownDescription": "On Windows we launch the PowerShell executable with `-ExecutionPolicy Bypass` so that the LSP server (PowerShell Editor Services module) will launch without issue. Some anti-virus programs disallow this command-line argument and this flag can be used to remove it. **Using this setting may require trusting the script manually in order for it to launch!**"
},
"powershell.developer.featureFlags": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"markdownDescription": "An array of strings that enable experimental features in the PowerShell extension. **No flags are currently available!**"
},
"powershell.developer.waitForSessionFileTimeoutSeconds": {
"type": "number",
"default": 240,
"markdownDescription": "Specifies how many seconds the extension will wait for the LSP server, PowerShell Editor Services, to connect. The default is four minutes; try increasing this value if your computer is particularly slow (often caused by overactive anti-malware programs)."
},
"powershell.pester.useLegacyCodeLens": {
"type": "boolean",
"default": true,
"markdownDescription": "Use a CodeLens that is compatible with Pester 4. Disabling this will show `Run Tests` on all `It`, `Describe` and `Context` blocks, and will correctly work only with Pester 5 and newer."
},
"powershell.pester.codeLens": {
"type": "boolean",
"default": true,
"markdownDescription": "This setting controls the appearance of the `Run Tests` and `Debug Tests` CodeLenses that appears above Pester tests."
},
"powershell.pester.outputVerbosity": {
"type": "string",
"default": "FromPreference",
"enum": [
"FromPreference",
"None",
"Minimal",
"Normal",
"Detailed",
"Diagnostic"
],
"markdownDescription": "Defines the verbosity of output to be used. For Pester 5 and newer the default value `FromPreference` will use the `Output` settings from the `$PesterPreference` defined in the caller's context, and will default to `Normal` if there is none. For Pester 4 the `FromPreference` and `Normal` options map to `All`, and `Minimal` option maps to `Fails`."
},
"powershell.pester.debugOutputVerbosity": {
"type": "string",
"enum": [
"None",
"Minimal",
"Normal",
"Detailed",
"Diagnostic"
],
"default": "Diagnostic",
"markdownDescription": "Defines the verbosity of output to be used when debugging a test or a block. For Pester 5 and newer the default value `Diagnostic` will print additional information about discovery, skipped and filtered tests, mocking and more."
},
"powershell.buttons.showRunButtons": {
"type": "boolean",
"default": true,
"markdownDescription": "Show the `Run` and `Run Selection` buttons in the editor's title bar."
},
"powershell.buttons.showPanelMovementButtons": {
"type": "boolean",