Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add #Requires snippets #1974

Merged
merged 4 commits into from
Jul 9, 2019
Merged

Add #Requires snippets #1974

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8140cee
Empty commit to reopen the accidentally-closed PR #1974
travisclagrone Jul 2, 2019
b34ab49
Add script requirement directive snippets
travisclagrone Jul 3, 2019
7546e2a
Correct mix-up between the snippets named "Required Module RequiredVe…
travisclagrone Jul 4, 2019
cd8d22a
Comment to remove the "Requires *" snippets if-and-when the relevant …
travisclagrone Jul 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions snippets/PowerShell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// The "Requires *" snippets should be removed if-and-when intellisense is implemented for the script requirement directive syntax.
{
"ModuleManifest": {
"prefix": "manifest",
Expand Down Expand Up @@ -1082,5 +1083,65 @@
"}"
],
"description": "IArgumentCompleter implementation class definition"
},
"Requires Assembly": {
"prefix": "requires-assembly",
"body": "#Requires -Assembly '${1:${TM_SELECTED_TEXT:fully-qualified-name}}'",
"description": "Requires an assembly (by name) in order to execute the containing script file."
},
"Requires Assembly Path": {
"prefix": "requires-assembly-path",
"body": "#Requires -Assembly ${0:${TM_SELECTED_TEXT:path/to/assembly.dll}}",
"description": "Requires an assembly (by relative or absolute path) in order to execute the containing script file."
},
"Requires Assembly Version": {
"prefix": "requires-assembly-version",
"body": "#Requires -Assembly '${1:${TM_SELECTED_TEXT:fully-qualified-name}}, Version=${2:1.0.0.0}'",
"description": "Requires an assembly (by name and minimum version) in order to execute the containing script file."
},
"Requires Module": {
"prefix": "requires-module",
"body": "#Requires -Module ${0:${TM_SELECTED_TEXT:fully-qualified-name}}",
"description": "Requires a module (by name) in order to execute the containing script file."
},
"Requires Module RequiredVersion": {
travisclagrone marked this conversation as resolved.
Show resolved Hide resolved
"prefix": "requires-module-required-version",
"body": "#Requires -Module @{ ModuleName = '${1:${TM_SELECTED_TEXT:fully-qualified-name}}'; RequiredVersion = '${2:exact-required-version}' }",
"description": "Requires a module (by name and exact version) in order to execute the containing script file."
},
"Requires Module Version": {
"prefix": "requires-module-version",
"body": "#Requires -Module @{ ModuleName = '${1:${TM_SELECTED_TEXT:fully-qualified-name}}'; ModuleVersion = '${2:minimum-acceptable-version}' }",
"description": "Requires a module (by name and minimum version) in order to execute the containing script file."
},
"Requires PSEdition": {
"prefix": "requires-ps-edition",
"body": "#Requires -PSEdition ${1|Core,Desktop|}",
"description": "Requires a specific edition of PowerShell in order to execute the containing script file."
},
"Requires PSSnapin": {
"prefix": "requires-ps-snapin",
"body": "#Requires -PSSnapin ${0:${TM_SELECTED_TEXT:fully-qualified-name}}",
"description": "Requires a PowerShell snap-in (by name) in order to execute the containing script file."
},
"Requires PSSnapin Version": {
"prefix": "requires-ps-snapin-version",
"body": "#Requires -PSSnapin ${1:${TM_SELECTED_TEXT:fully-qualified-name}} -Version ${2:minimum-acceptable-version}",
"description": "Requires a PowerShell snap-in (by name and minimum version) in order to execute the containing script file."
},
"Requires RunAsAdministrator": {
"prefix": "requires-run-as-administrator",
"body": "#Requires -RunAsAdministrator",
"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\")."
},
"Requires ShellId": {
"prefix": "requires-shell-id",
"body": "#Requires -ShellId ${0:${TM_SELECTED_TEXT:shell-id}}",
"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."
},
"Requires Version": {
"prefix": "requires-version",
"body": "#Requires -Version ${0:${TM_SELECTED_TEXT:minimum-acceptable-version}}",
"description": "Requires a minimum version of PowerShell in order to execute the containing script file."
}
}