Skip to content

Commit fbaf540

Browse files
travisclagronerjmholt
authored andcommitted
Add #Requires snippets (#1974)
* Add script requirement directive snippets Adds the following snippets (listed by name, not prefix): - Requires Assembly - Requires Assembly Path - Requires Assembly Version - Requires Module - Requires Module RequiredVersion - Requires Module Version - Requires PSEdition - Requires PSSnapin - Requires PSSnapin Version - Requires RunAsAdministrator - Requires ShellId - Requires Version
1 parent 32da4c2 commit fbaf540

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

snippets/PowerShell.json

+61
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// The "Requires *" snippets should be removed if-and-when intellisense is implemented for the script requirement directive syntax.
12
{
23
"ModuleManifest": {
34
"prefix": "manifest",
@@ -1082,5 +1083,65 @@
10821083
"}"
10831084
],
10841085
"description": "IArgumentCompleter implementation class definition"
1086+
},
1087+
"Requires Assembly": {
1088+
"prefix": "requires-assembly",
1089+
"body": "#Requires -Assembly '${1:${TM_SELECTED_TEXT:fully-qualified-name}}'",
1090+
"description": "Requires an assembly (by name) in order to execute the containing script file."
1091+
},
1092+
"Requires Assembly Path": {
1093+
"prefix": "requires-assembly-path",
1094+
"body": "#Requires -Assembly ${0:${TM_SELECTED_TEXT:path/to/assembly.dll}}",
1095+
"description": "Requires an assembly (by relative or absolute path) in order to execute the containing script file."
1096+
},
1097+
"Requires Assembly Version": {
1098+
"prefix": "requires-assembly-version",
1099+
"body": "#Requires -Assembly '${1:${TM_SELECTED_TEXT:fully-qualified-name}}, Version=${2:1.0.0.0}'",
1100+
"description": "Requires an assembly (by name and minimum version) in order to execute the containing script file."
1101+
},
1102+
"Requires Module": {
1103+
"prefix": "requires-module",
1104+
"body": "#Requires -Module ${0:${TM_SELECTED_TEXT:fully-qualified-name}}",
1105+
"description": "Requires a module (by name) in order to execute the containing script file."
1106+
},
1107+
"Requires Module RequiredVersion": {
1108+
"prefix": "requires-module-required-version",
1109+
"body": "#Requires -Module @{ ModuleName = '${1:${TM_SELECTED_TEXT:fully-qualified-name}}'; RequiredVersion = '${2:exact-required-version}' }",
1110+
"description": "Requires a module (by name and exact version) in order to execute the containing script file."
1111+
},
1112+
"Requires Module Version": {
1113+
"prefix": "requires-module-version",
1114+
"body": "#Requires -Module @{ ModuleName = '${1:${TM_SELECTED_TEXT:fully-qualified-name}}'; ModuleVersion = '${2:minimum-acceptable-version}' }",
1115+
"description": "Requires a module (by name and minimum version) in order to execute the containing script file."
1116+
},
1117+
"Requires PSEdition": {
1118+
"prefix": "requires-ps-edition",
1119+
"body": "#Requires -PSEdition ${1|Core,Desktop|}",
1120+
"description": "Requires a specific edition of PowerShell in order to execute the containing script file."
1121+
},
1122+
"Requires PSSnapin": {
1123+
"prefix": "requires-ps-snapin",
1124+
"body": "#Requires -PSSnapin ${0:${TM_SELECTED_TEXT:fully-qualified-name}}",
1125+
"description": "Requires a PowerShell snap-in (by name) in order to execute the containing script file."
1126+
},
1127+
"Requires PSSnapin Version": {
1128+
"prefix": "requires-ps-snapin-version",
1129+
"body": "#Requires -PSSnapin ${1:${TM_SELECTED_TEXT:fully-qualified-name}} -Version ${2:minimum-acceptable-version}",
1130+
"description": "Requires a PowerShell snap-in (by name and minimum version) in order to execute the containing script file."
1131+
},
1132+
"Requires RunAsAdministrator": {
1133+
"prefix": "requires-run-as-administrator",
1134+
"body": "#Requires -RunAsAdministrator",
1135+
"description": "Requires elevated user rights in order to execute the containing script file. Ignored on non-Windows systems. On Windows systems, it requires that the PowerShell session in which the containing script file is run must have been started with elevated user rights (\"Run as Administrator\")."
1136+
},
1137+
"Requires ShellId": {
1138+
"prefix": "requires-shell-id",
1139+
"body": "#Requires -ShellId ${0:${TM_SELECTED_TEXT:shell-id}}",
1140+
"description": "Requires a specific shell id in order to execute the containing script file. The current shell id may be determined by querying the $ShellId automatic variable."
1141+
},
1142+
"Requires Version": {
1143+
"prefix": "requires-version",
1144+
"body": "#Requires -Version ${0:${TM_SELECTED_TEXT:minimum-acceptable-version}}",
1145+
"description": "Requires a minimum version of PowerShell in order to execute the containing script file."
10851146
}
10861147
}

0 commit comments

Comments
 (0)