v1.4.0

Author: jdhitsolutions

ChangeLog.md

@@ -1,85 +1,98 @@
 # ChangeLog for PSFunctionInfo
 
+## 1.4.0
+
+### Changed
+
+- Code cleanup
+- Modified `Get-PSFunctionInfo` to sort functions by name.
+- Help updates
+- Updated `README`
+
+### Fixed
+
+- Added a warning to `Set-PSFunctionInfoDefaults` if the command is run without specifying any parameters.
+-
 ## 1.3.0
 
-+ Updated missing online help links.
-+ Help documentation updates.
-+ Updated `README.md`.
+- Updated missing online help links.
+- Help documentation updates.
+- Updated `README.md`.
 
 ## 1.2.0
 
-+ Added custom error messages to `ValidateScript()` parameter attributes.
-+ Added a `NoSource` parameter to `New-PSFunctionInfo` to not include the source path.
-+ Added `Set-PSFunctionInfo` and its alias `spfi`.
-+ Added `Remove-PSFunctionInfo` and its alias `rpfi`.
-+ Help updates.
-+ Updated `README.md`.
+- Added custom error messages to `ValidateScript()` parameter attributes.
+- Added a `NoSource` parameter to `New-PSFunctionInfo` to not include the source path.
+- Added `Set-PSFunctionInfo` and its alias `spfi`.
+- Added `Remove-PSFunctionInfo` and its alias `rpfi`.
+- Help updates.
+- Updated `README.md`.
 
 ## 1.1.0
 
-+ Fixed DefaultDisplayPropertySet in types.ps1xml file.
-+ Added online help links.
-+ Updated `README.md`.
+- Fixed DefaultDisplayPropertySet in types.ps1xml file.
+- Added online help links.
+- Updated `README.md`.
 
 ## 1.0.0
 
-+ Restructured module layout.
-+ Added a property set called `TagInfo`.
-+ Added command `Edit-PSFunctionInfo` with an alias of `efpi`. ([Issue #7](https://github.com/jdhitsolutions/PSFunctionInfo/issues/7))
-+ Added better error handling to `Get-PSFunctionInfo` where function can't be found.
-+ Help updates.
-+ First official release to the PowerShell Gallery.
-+ Updated `README.md`.
+- Restructured module layout.
+- Added a property set called `TagInfo`.
+- Added command `Edit-PSFunctionInfo` with an alias of `efpi`. ([Issue #7](https://github.com/jdhitsolutions/PSFunctionInfo/issues/7))
+- Added better error handling to `Get-PSFunctionInfo` where function can't be found.
+- Help updates.
+- First official release to the PowerShell Gallery.
+- Updated `README.md`.
 
 ## 0.6.0-preview
 
-+ Fixed the `-Name` parameter argument completer in `Get-PSFunctionInfo`. The function parameter changed from `Name` to `FunctionName` which is why it broke. ([Issue #6](https://github.com/jdhitsolutions/PSFunctionInfo/issues/6))
-+ Created private function `backup_file`.
-+ Added a `-Backup` parameter to `New-PSFunctionInfo`. ([Issue #1](https://github.com/jdhitsolutions/PSFunctionInfo/issues/1))
-+ Help updates
-+ Updated `README.md`.
+- Fixed the `-Name` parameter argument completer in `Get-PSFunctionInfo`. The function parameter changed from `Name` to `FunctionName` which is why it broke. ([Issue #6](https://github.com/jdhitsolutions/PSFunctionInfo/issues/6))
+- Created private function `backup_file`.
+- Added a `-Backup` parameter to `New-PSFunctionInfo`. ([Issue #1](https://github.com/jdhitsolutions/PSFunctionInfo/issues/1))
+- Help updates
+- Updated `README.md`.
 
 ## 0.5.0-preview
 
-+ Added an autocompleter for the `-Tag` parameter in `Get-PSFunctionInfo`. ([Issue #4](https://github.com/jdhitsolutions/PSFunctionInfo/issues/4))
-+ Added a private function, `new_psfunctioninfo`, to create a new PSFunctionInfo object from the metadata block.
-+ Changed `Name` parameter in `Get-PSFunctionInfo` to `FunctionName`. The parameter is positional, so it shouldn't make much difference. **This is a breaking change.**
-+ Modified `Get-PSFunctionInfo` to get metadata from files. ([Issue #3](https://github.com/jdhitsolutions/PSFunctionInfo/issues/3))
-+ Modified `PSFunctionInfo` class to not require Tags in the constructor.
-+ Added missing online help links.
-+ Added a table view called `tags` to `psfunctioninfor.format.ps1xml`.
-+ Modified `psfunctioninfor.format.ps1xml` to reduce the `Alias` column to 15.
-+ Added integration into the PowerShell ISE.
-+ Added integration into VS Code. ([Issue #2](https://github.com/jdhitsolutions/PSFunctionInfo/issues/2))
-+ Updated help documentation.
-+ Updated `README.md`.
+- Added an autocompleter for the `-Tag` parameter in `Get-PSFunctionInfo`. ([Issue #4](https://github.com/jdhitsolutions/PSFunctionInfo/issues/4))
+- Added a private function, `new_psfunctioninfo`, to create a new PSFunctionInfo object from the metadata block.
+- Changed `Name` parameter in `Get-PSFunctionInfo` to `FunctionName`. The parameter is positional, so it shouldn't make much difference. **This is a breaking change.**
+- Modified `Get-PSFunctionInfo` to get metadata from files. ([Issue #3](https://github.com/jdhitsolutions/PSFunctionInfo/issues/3))
+- Modified `PSFunctionInfo` class to not require Tags in the constructor.
+- Added missing online help links.
+- Added a table view called `tags` to `psfunctioninfor.format.ps1xml`.
+- Modified `psfunctioninfor.format.ps1xml` to reduce the `Alias` column to 15.
+- Added integration into the PowerShell ISE.
+- Added integration into VS Code. ([Issue #2](https://github.com/jdhitsolutions/PSFunctionInfo/issues/2))
+- Updated help documentation.
+- Updated `README.md`.
 
 ## 0.4.0-preview
 
-+ Added `Set-PSFunctionInfoDefaults` and `Get-PSFunctionInfoDefaults` to store default values. The defaults are stored in a JSON file at `$home\psfunctioninfo-defaults.json`. If the file is found when the module is imported, it will be used to set $PSDefaultParameterValues for this module.
-+ Added `Update-PSFunctionInfoDefaults` which can be used to update defaults if they are changed after the module has been loaded.
-+ Added `about_PSFunctionInfo` help.
-+ Minor help updates.
-+ Updated `README.md`.
+- Added `Set-PSFunctionInfoDefaults` and `Get-PSFunctionInfoDefaults` to store default values. The defaults are stored in a JSON file at `$home\psfunctioninfo-defaults.json`. If the file is found when the module is imported, it will be used to set $PSDefaultParameterValues for this module.
+- Added `Update-PSFunctionInfoDefaults` which can be used to update defaults if they are changed after the module has been loaded.
+- Added `about_PSFunctionInfo` help.
+- Minor help updates.
+- Updated `README.md`.
 
 ## 0.3.0-preview
 
-+ Added online help links.
-+ Published pre-release module to the PowerShell Gallery.
-+ Updated `README.md`.
+- Added online help links.
+- Published pre-release module to the PowerShell Gallery.
+- Updated `README.md`.
 
 ## 0.2.0
 
-+ Modified `Source` view in `psfunctioninfo.format.ps1xml` to not limit the Description width.
-+ Updated `New-PSFunctionInfo` to better handle different function layouts.
-+ Added Verbose output to `Get-PSFunctionInfoTag`.
-+ Help updates.
-+ Added an argument completer for the `Name` parameter of `Get-PSFunctionInfo`.
-+ Added alias `gpfi` for `Get-PSFunctionInfo`.
-+ Added alias `npfi` for `New-PSFunctionInfo`.
-+ Updated module manifest.
-+ Updated `README.md`.
+- Modified `Source` view in `psfunctioninfo.format.ps1xml` to not limit the Description width.
+- Updated `New-PSFunctionInfo` to better handle different function layouts.
+- Added Verbose output to `Get-PSFunctionInfoTag`.
+- Help updates.
+- Added an argument completer for the `Name` parameter of `Get-PSFunctionInfo`.
+- Added alias `gpfi` for `Get-PSFunctionInfo`.
+- Added alias `npfi` for `New-PSFunctionInfo`.
+- Updated module manifest.
+- Updated `README.md`.
 
 ## 0.1.0
 
-+ initial module files
+- initial module files

License.txt

@@ -1,4 +1,3 @@
-
 Get-ChildItem $PSScriptRoot\functions\*.ps1 | ForEach-Object {
     . $_.FullName
 }
@@ -7,37 +6,37 @@ Get-ChildItem $PSScriptRoot\functions\*.ps1 | ForEach-Object {
 $defaults = Join-Path $home -ChildPath psfunctioninfo-defaults.json
 if (Test-Path -path $defaults) {
     $d = Get-Content -Path $defaults | ConvertFrom-JSON
-    $d.psobject.properties | Foreach-Object {
+    $d.PSObject.properties | Foreach-Object {
         $global:PSDefaultParameterValues["New-PSFunctionInfo:$($_.name)"] = $_.value
     }
 }
 
 #Add VSCode Shortcuts
 if ($host.name -eq 'Visual Studio Code Host') {
-    $global:PSDefaultParameterValues["New-PSFunctionInfo:Path"] = {$pseditor.GetEditorContext().CurrentFile.Path}
+    $global:PSDefaultParameterValues["New-PSFunctionInfo:Path"] = {$PSEditor.GetEditorContext().CurrentFile.Path}
 
     #create an argument completer for the Name parameter
     Register-ArgumentCompleter -CommandName New-PSFunctionInfo -ParameterName Name -ScriptBlock {
-        param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
-
-        #PowerShell code to populate $wordtoComplete
-        $asttokens = $pseditor.GetEditorContext().CurrentFile.tokens
-        $namelist = @()
-        for ($i=0;$i -lt $asttokens.count;$i++) {
-            if ($asttokens[$i].text -eq 'function') {
-              $namelist+= $asttokens[$i+1].text
+        param($commandName, $parameterName, $WordToComplete, $commandAst, $fakeBoundParameter)
+
+        #PowerShell code to populate $WordToComplete
+        $ASTTokens = $PSEditor.GetEditorContext().CurrentFile.tokens
+        $NameList = @()
+        for ($i=0;$i -lt $ASTTokens.count;$i++) {
+            if ($ASTTokens[$i].text -eq 'function') {
+                $NameList+= $ASTTokens[$i+1].text
             }
-          }
-        $namelist | Where-Object {$_ -like "$WordtoComplete*"} |
+        }
+        $NameList | Where-Object {$_ -like "$WordToComplete*"} |
             ForEach-Object {
-                # completion text,listitem text,result type,Tooltip
+                # completion text,listItem text,result type,Tooltip
                 [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
             }
     }
 }
 elseif ($host.name -eq 'Windows PowerShell ISE Host') {
     #create shortcut for the ISE
-    $global:PSDefaultParameterValues["New-PSFunctionInfo:Path"] = {$psise.CurrentFile.fullpath}
+    $global:PSDefaultParameterValues["New-PSFunctionInfo:Path"] = {$PSIse.CurrentFile.FullPath}
 
     #add a menu item
     $sb = {
@@ -110,25 +109,25 @@ elseif ($host.name -eq 'Windows PowerShell ISE Host') {
             [void]($form.ShowDialog())
         }
 
-        if ($psise.CurrentFile.IsSaved) {
-            $Path = $psise.CurrentFile.FullPath
+        if ($PSIse.CurrentFile.IsSaved) {
+            $Path = $PSIse.CurrentFile.FullPath
 
-            New-Variable astTokens -Force
+            New-Variable ASTTokens -Force
             New-Variable astErr -Force
-            $AST = [System.Management.Automation.Language.Parser]::ParseFile($Path, [ref]$astTokens, [ref]$astErr)
+            $AST = [System.Management.Automation.Language.Parser]::ParseFile($Path, [ref]$ASTTokens, [ref]$astErr)
 
             $file = [System.Collections.Generic.list[string[]]]::new()
             Get-Content $path | ForEach-Object { $file.Add($_) }
 
             $name = @()
-            for ($i = 0; $i -lt $asttokens.count; $i++) {
-                if ($asttokens[$i].text -eq 'function') {
-                    $name += $asttokens[$i + 1].text
+            for ($i = 0; $i -lt $ASTTokens.count; $i++) {
+                if ($ASTTokens[$i].text -eq 'function') {
+                    $name += $ASTTokens[$i + 1].text
                 }
             } #for
             if ($name) {
                 Remove-Variable -Name SelectedPickItem -ErrorAction SilentlyContinue
-                picklist -name $name
+                PickList -name $name
                 #| Out-GridView -Title "Select a function" -OutputMode Single
 
                 if ($SelectedPickItem) {
@@ -137,9 +136,9 @@ elseif ($host.name -eq 'Windows PowerShell ISE Host') {
                     $idx = $file.findIndex( { $args[0] -match "[Ff]unction(\s+)$SelectedPickItem" })
                     $idx++
                     #save and re-open the file
-                    [void]$psISE.CurrentPowerShellTab.files.Remove($psise.CurrentFile)
-                    [void]$psise.CurrentPowerShellTab.Files.Add($path)
-                    $r = $psise.CurrentPowerShellTab.Files.where( { $_.fullpath -eq $path })
+                    [void]$PSIse.CurrentPowerShellTab.files.Remove($PSIse.CurrentFile)
+                    [void]$PSIse.CurrentPowerShellTab.Files.Add($path)
+                    $r = $PSIse.CurrentPowerShellTab.Files.where( { $_.FullPath -eq $path })
                     $r.Editor.Focus()
 
                     if ($idx -ge 0) {
@@ -158,26 +157,26 @@ elseif ($host.name -eq 'Windows PowerShell ISE Host') {
         }
     }
 
-    $psise.CurrentPowerShellTab.AddOnsMenu.Submenus.add("New-PSFunctionInfo", $sb, $Null)
+    $PSIse.CurrentPowerShellTab.AddOnsMenu.Submenus.add("New-PSFunctionInfo", $sb, $Null)
 }
 
 #create an argument completer
 Register-ArgumentCompleter -CommandName Get-PSFunctionInfo -ParameterName FunctionName -ScriptBlock {
-    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
+    param($commandName, $parameterName, $WordToComplete, $commandAst, $fakeBoundParameter)
 
-    Get-Childitem -path "Function:\$wordToComplete*" |
+    Get-ChildItem -path "Function:\$WordToComplete*" |
         ForEach-Object {
-            # completion text,listitem text,result type,Tooltip
+            # completion text,listItem text,result type,Tooltip
             [System.Management.Automation.CompletionResult]::new($_.name, $_.name, 'ParameterValue', $_.name)
         }
 }
 
 Register-ArgumentCompleter -CommandName Get-PSFunctionInfo -ParameterName Tag -ScriptBlock {
-    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
+    param($commandName, $parameterName, $WordToComplete, $commandAst, $fakeBoundParameter)
 
-    (Get-PSFunctionInfoTag).where({$_ -like "$wordToComplete*"}) |
+    (Get-PSFunctionInfoTag).where({$_ -like "$WordToComplete*"}) |
         ForEach-Object {
-            # completion text,listitem text,result type,Tooltip
+            # completion text,listItem text,result type,Tooltip
             [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
         }
 }