Skip to content

Commit

Permalink
Clarify descriptions for the 'Requires*Directive' snippets
Browse files Browse the repository at this point in the history
  • Loading branch information
travisclagrone committed May 22, 2019
1 parent 83ac228 commit 572df38
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions snippets/PowerShell.json
Original file line number Diff line number Diff line change
Expand Up @@ -1029,51 +1029,51 @@
"RequiresVersionDirective": {
"prefix": "require-version",
"body": [
"#Requires -Version ${1:Version}"
"#Requires -Version ${1:MinimumVersion}"
],
"description": "Require a minimum version of PowerShell to run the script."
"description": "Require a minimum version or greater of PowerShell to run the script."
},
"RequiresPSSnapinDirective": {
"prefix": "require-snapin",
"body": [
"#Requires -PSSnapin ${1:Name}"
],
"description": "Require a PowerShell snap-in to run the script."
"description": "Require a specific PowerShell snap-in to run the script."
},
"RequiresPSSnapinVersionDirective": {
"prefix": "require-snapin-version",
"body": [
"#Requires -PSSnapIn ${1:Name} -Version ${2:Version}"
"#Requires -PSSnapIn ${1:Name} -Version ${2:MinimumVersion}"
],
"description": "Require a PowerShell snap-in of minimum version to run the script."
"description": "Require a specific PowerShell snap-in of minimum version or greater to run the script."
},
"RequiresModulesDirective": {
"prefix": "require-module",
"body": [
"#Requires -Modules ${1:Name}"
],
"description": "Require one or more PowerShell modules to run the script."
"description": "Require one or more specific PowerShell modules to run the script."
},
"RequiresModulesVersionDirective": {
"prefix": "require-module-version",
"body": [
"#Requires -Modules @{ ModuleName='${1:Name}'; ModuleVersion='${2:Version}' }"
"#Requires -Modules @{ ModuleName='${1:Name}'; ModuleVersion='${2:MinimumVersion}' }"
],
"description": "Require a PowerShell module of minimum version to run the script."
"description": "Require a specific PowerShell module of minimum version or greater to run the script."
},
"RequiresModulesRequiredVersionDirective": {
"prefix": "require-module-required-version",
"body": [
"#Requires -Modules @{ ModuleName='${1:Name}'; RequiredVersion='${2:Version}' }"
"#Requires -Modules @{ ModuleName='${1:Name}'; RequiredVersion='${2:ExactVersion}' }"
],
"description": "Require a PowerShell module of exact version to run the script."
"description": "Require a specific PowerShell module of exact version to run the script."
},
"RequiresPSEditionDirective": {
"prefix": "require-edition",
"body": [
"#Requires -PSEdition ${1|Core,Desktop|}"
],
"description": "Require a PowerShell edition to run the script."
"description": "Require a specific PowerShell edition to run the script."
},
"RequiresShellIdDirective": {
"prefix": "require-shell",
Expand Down

0 comments on commit 572df38

Please sign in to comment.