forked from jdhitsolutions/ISEScriptingGeek
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathget-commandmetadata.ps1
More file actions
142 lines (116 loc) · 3.54 KB
/
get-commandmetadata.ps1
File metadata and controls
142 lines (116 loc) · 3.54 KB
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
#requires -version 3.0
#run this in the PowerShell ISE for best results
Function Get-CommandMetadata {
<#
.Synopsis
Create a proxy function of a PowerShell command.
.Description
This command will create a proxy version of a PowerShell cmdlet, function or alias. The intent is to simplify creating a new function from command metadata. You can give your command and opt to remove help references for the original command.
If you run this in the PowerShell ISE, code for the new function will be inserted into a new Powershell tab.
.Parameter Command
The name of a PowerShell command to proxy. This can be a cmdlet, function or alias.
.Parameter NewName
The name you want to use for your new command.
.Parameter NoHelp
Remove references to existing command help. Using this parameter will insert a comment-based help outline.
.Example
PS C:\> Get-CommandMetadata Get-WMIObject -nohelp -newname Get-MyOS
Create a proxy function for Get-WMIObject that will be called Get-MyOS. Help references will be replaced with a comment-help block.
.Notes
Last Updated: Sept. 3, 2014
Version : 1.1
.Link
http://jdhitsolutions.com/blog/2014/09/friday-fun-creating-powershell-scripts-with-powershell
#>
[cmdletbinding()]
Param(
[Parameter(Position=0,Mandatory,HelpMessage="Enter the name of a PowerShell command")]
[ValidateNotNullorEmpty()]
[string]$Command,
[string]$NewName,
[switch]$NoHelp
)
Try {
Write-Verbose "Getting command metadata for $command"
$gcm = Get-Command -Name $command -ErrorAction Stop
#allow an alias or command name
if ($gcm.CommandType -eq 'Alias') {
$cmdName = $gcm.ResolvedCommandName
}
else {
$cmdName = $gcm.Name
}
Write-Verbose "Resolved to $cmdName"
$cmd = New-Object System.Management.Automation.CommandMetaData ($gcm)
}
Catch {
Write-Warning "Failed to create command metadata for $command"
Write-Warning $_.Exception.Message
}
if ($cmd) {
#create the metadata
if ($NewName) {
$Name = $NewName
}
else {
$Name = $cmd.Name
}
if ($noHelp) {
#remove help link
$cmd.HelpUri = $Null
Write-Verbose "Defining a new comment based help block"
#define outline for comment based help
$myHelp = @"
.Synopsis
PUT SYNTAX HERE
.Description
PUT DESCRIPTION HERE
.Notes
Created:`t$(Get-Date -format d)
.Example
PS C:\> $Name
.Link
$cmdname
"@
Write-Verbose "Creating proxy command with help"
$metadata = [System.Management.Automation.ProxyCommand]::Create($cmd,$myHelp)
} #nohelp
else {
Write-Verbose "Creating proxy command"
$metadata = [System.Management.Automation.ProxyCommand]::Create($cmd)
}
Write-Verbose "Cleaning up parameter names"
[regex]$rx="[\s+]\$\{\w+\}[,|)]"
$metadata = $metadata.split("`n") | foreach {
If ($rx.ismatch($_)) {
#strip off { } around parameter names
$rx.Match($_).Value.Replace("{","").Replace("}","")
# "`n"
}
else {
#just write the line
$_
}
} #foreach
#define the text for the new command
$text = @"
#requires -version $($PSVersionTable.psversion)
Function $Name {
$metadata
} #end function $Name
"@
if ($host.Name -match "PowerShell ISE") {
#open in a new ISE tab
$tab = $psise.CurrentPowerShellTab.Files.Add()
Write-Verbose "Opening metadata in a new ISE tab"
$tab.editor.InsertText($Text)
#jump to the top
$tab.Editor.SetCaretPosition(1,1)
}
else {
$Text
}
}
Write-Verbose "Ending $($MyInvocation.MyCommand)"
} #end function
Set-Alias -Name gcmd -Value Get-CommandMetaData