Open-FunctionInISE

1. Function Open-FunctioninISE {
2. <#
3. .SYNOPSIS
4. Opens a function in ISE
5. .DESCRIPTION
6.     This enables you to specify the function to open. The definition
   
7.     comes from (Get-Command <command>).definition.
8.     You specify the name of the function to open, or select it
9.     in the ISE
10. .NOTES
11.     File Name : Open-FunctionInIse.ps1
12.     Author : Thomas Lee - tfl@psp.co.uk
13.     Requires : PowerShell Version 3.0
14.     Based on a technet script published at http://gallery.technet.microsoft.com/scriptcenter/Open-defined-functions-in-22788d0f 
15. .LINK
16.     This script posted to:
17.         http://www.pshscripts.blogspot.com
18. .PARAMETER Function
19.     The name of a defined function to open in new PowerShell ISE tab.
20. .EXAMPLE
21.     C:\Psh> Open-FunctionInIse Open-FunctioninISE
23.     Opens Open-FunctionInIse in a new PowerShell ISE tab
24. .EXAMPLE
25.     Select a function name in an open edit window, then hit
26.     Ctrl+Shift+E (or use the Add-ons menu)
27. #>
29. # Define parameters
30. [Cmdletbinding()]
31. Param(
32. [Parameter(Position=0)]
33. [ValidateScript({ Get-Command -commandtype function -name $_ })]
34. [String] $function
35. )
37. # Start of the function.
38. Process{
40. # Get the function name (i.e. the selected text) and ensure it's not empty
41. $fn = $psise.currentfile.Editor.selectedText
42. # if nothing selected, see if we got called with it
43. If (!$fn -or ($fn.length -LE 0)) {
44. if ($function -and ($function.length -GT 0)){
45. $fn = $function}
46. Else {
47. $fn = Read-Host -Prompt "Enter function name to view"
48. }
49. }
51. If (!$Fn) {'No function to edit';return}
53. # Get the definition, if there is one
54. $definition = (Get-Command -commandtype function -name $fn).definition
55. If (!$definition -or ($Definition.Length -le 0)) {return "Function [$fn] not found"}
57. # Create What to see
58. $FunctionHeader = "Function $fn {`n"
59. $comments = "`# Description : $($definition.description)`n"
60. $comments += "`# Module : $($definition.module)`n`n"
61. $FunctionTrailer = "`n}"
63. # Wrap it all up
64. $definition = $functionHeader + $Comments + $Definition + $FunctionTrailer
65. "function $fn {" + $definition + "}"
67. # Add a tab, add text to the tab, set caret position to first character
68. $tab = $Psise.CurrentPowerShellTab.Files.Add()
69. $tab.Editor.text = $definition
70. $tab.Editor.SetCaretPosition(1,1)
72. # Sleep for a moment. Ran into issues without this.
73. Start-Sleep -Milliseconds 200
74. } # End process block
75. } # End Function
77. Set-ALias OFISE .\Open-FunctionInISE
79. # Here we could test the function from the command line.
80. # Function test123 {'testing 1-2-3'}
81. # Open-FunctioninISE test123
83. # I assume you'll just use this function so I've left the following
84. # Code in place to add this as a menu item
86. # Here add to the ISE as long as it's not there already!
87. $x = ($psise.CurrentPowerShellTab.AddOnsMenu.Submenus).displayname
88. if (! ($x -contains "_Edit Function in ISE")) {
89. $Psise.CurrentPowerShellTab.AddOnsMenu.Submenus.Add("_Edit Function in ISE", {Open-FunctioninISE},
90. "Ctrl+Shift+E") | Out-Null
91. }
92. Else {
93. 'Function already added in ISE'
94. }

Technorati Tags: PowerShell,ISE,Open Function in ISE