v1.5.0

Author: jdhitsolutions

ChangeLog.md

@@ -1,6 +1,22 @@
 # ChangeLog for PSFunctionInfo
 
-## 1.4.0
+## [Unreleased]
+
+## [1.5.0] - 2025-03-19
+
+### Added
+
+- Added a default formatted list view for `Get-PSFunctionInfo` output.
+- Added a script property type extension for `PSFunctionInfo` objects to show `Age`.
+
+### Changed
+
+- Replaced bitly online help links
+- Refined filtering regex for PSFunctionInfo objects to exclude functions that end in a colon. These are typically PSDrive shortcuts. __This is a potential breaking change.__
+- Converted changelog to new format.
+- Updated help documentation.
+
+## [1.4.0] - 2024-01-22
 
 ### Changed
 
@@ -9,90 +25,157 @@
 - Help updates
 - Updated `README`
 
-### Fixed
+### Added
 
 - Added a warning to `Set-PSFunctionInfoDefaults` if the command is run without specifying any parameters.
--
-## 1.3.0
+
+## [1.3.0] - 2022-07-22
+
+### Changed
 
 - Updated missing online help links.
 - Help documentation updates.
 - Updated `README.md`.
 
-## 1.2.0
+## [1.2.0] - 2022-07-22
+
+### Added
 
 - 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`.
+
+### Changed
+
 - Help updates.
 - Updated `README.md`.
 
-## 1.1.0
+## [1.1.0] - 2022-03-15
+
+### Added
 
-- Fixed DefaultDisplayPropertySet in types.ps1xml file.
 - Added online help links.
+
+### Updated
+
 - Updated `README.md`.
 
-## 1.0.0
+### Fixed
+
+- Fixed DefaultDisplayPropertySet in types.ps1xml file.
+
+## [1.0.0] - 2020-10-02
+
+First official release to the PowerShell Gallery.
+
+### Added
 
-- 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.
+
+### Changed
+
+- Restructured module layout.
 - Help updates.
-- First official release to the PowerShell Gallery.
 - Updated `README.md`.
 
-## 0.6.0-preview
+## [0.6.0] - 2021-04-27
+
+Preview release
+
+### Added
 
-- 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))
+- Created private function `backup_file`.
+
+### Changed
+
 - Help updates
 - Updated `README.md`.
 
-## 0.5.0-preview
+### Fixed
+
+- 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))
+
+## [0.5.0] - 2021-04-26
+
+Preview release
+
+### Added
 
-- Added an autocompleter for the `-Tag` parameter in `Get-PSFunctionInfo`. ([Issue #4](https://github.com/jdhitsolutions/PSFunctionInfo/issues/4))
+- Added an auto completer for the `-Tag` parameter in `Get-PSFunctionInfo`. ([Issue #4](https://github.com/jdhitsolutions/PSFunctionInfo/issues/4))
+- Added missing online help links.
+- Added a table view called `tags` to `psfunctioninfo.format.ps1xml`.
+- Added integration into the PowerShell ISE.
 - Added a private function, `new_psfunctioninfo`, to create a new PSFunctionInfo object from the metadata block.
+- Added integration into VS Code. ([Issue #2](https://github.com/jdhitsolutions/PSFunctionInfo/issues/2))
+
+### Changed
+
 - 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))
+- Modified `psfunctioninfo.format.ps1xml` to reduce the `Alias` column to 15.
 - Updated help documentation.
 - Updated `README.md`.
 
-## 0.4.0-preview
+## [0.4.0] - 2021-04-22
+
+Preview release
+
+### Added
 
 - 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.
+
+### Changed
+
 - Minor help updates.
 - Updated `README.md`.
 
-## 0.3.0-preview
+## 0.3.0 - 2021-04-21
+
+Preview release published to the PowerShell Gallery.
+
+### Added
 
 - Added online help links.
-- Published pre-release module to the PowerShell Gallery.
+
+### Changed
+
 - Updated `README.md`.
 
-## 0.2.0
+## 0.2.0 - 2021-04-21
+
+### Added
 
-- 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`.
+
+## Changed
+
+- Modified `Source` view in `psfunctioninfo.format.ps1xml` to not limit the Description width.
+- Updated `New-PSFunctionInfo` to better handle different function layouts.
+- Help updates.
 - Updated module manifest.
 - Updated `README.md`.
 
-## 0.1.0
+## 0.1.0 - 2021-03-10
 
 - initial module files
+
+[Unreleased]: https://github.com/jdhitsolutions/PSFunctionInfo/compare/v1.5.0..HEAD
+[1.5.0]: https://github.com/jdhitsolutions/PSFunctionInfo/compare/v1.4.0..v1.5.0
+[1.4.0]: https://github.com/jdhitsolutions/PSFunctionInfo/compare/v1.3.0..v1.4.0
+[1.3.0]: https://github.com/jdhitsolutions/PSFunctionInfo/compare/v1.2.0..v1.3.0
+[1.2.0]: https://github.com/jdhitsolutions/PSFunctionInfo/compare/v1.1.0..v1.2.0
+[1.1.0]: https://github.com/jdhitsolutions/PSFunctionInfo/compare/v1.0.0..v1.1.0
+[1.0.0]: https://github.com/jdhitsolutions/PSFunctionInfo/compare/v0.6.0..v1.0.0
+[0.6.0]: https://github.com/jdhitsolutions/PSFunctionInfo/compare/v0.5.0..v0.6.0
+[0.5.0]: https://github.com/jdhitsolutions/PSFunctionInfo/compare/v0.4.0..v0.5.0
+[0.4.0]: https://github.com/jdhitsolutions/PSFunctionInfo/compare/v0.3.0..v0.4.0

License.txt

@@ -11,7 +11,7 @@ if (Test-Path -path $defaults) {
     }
 }
 
-#Add VSCode Shortcuts
+#region Add VSCode Shortcuts
 if ($host.name -eq 'Visual Studio Code Host') {
     $global:PSDefaultParameterValues["New-PSFunctionInfo:Path"] = {$PSEditor.GetEditorContext().CurrentFile.Path}
 
@@ -40,7 +40,6 @@ elseif ($host.name -eq 'Windows PowerShell ISE Host') {
 
     #add a menu item
     $sb = {
-
         Function PickList {
             # A WPF function picker for the PowerShell ISE
             Param([string[]]$Name)
@@ -159,8 +158,9 @@ elseif ($host.name -eq 'Windows PowerShell ISE Host') {
 
     $PSIse.CurrentPowerShellTab.AddOnsMenu.Submenus.add("New-PSFunctionInfo", $sb, $Null)
 }
+#endregion
 
-#create an argument completer
+#region create argument completers
 Register-ArgumentCompleter -CommandName Get-PSFunctionInfo -ParameterName FunctionName -ScriptBlock {
     param($commandName, $parameterName, $WordToComplete, $commandAst, $fakeBoundParameter)
 
@@ -179,4 +179,13 @@ Register-ArgumentCompleter -CommandName Get-PSFunctionInfo -ParameterName Tag -S
             # completion text,listItem text,result type,Tooltip
             [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
         }
-}
+}
+#endregion
+
+#region type extensions
+
+Update-TypeData -TypeName PSFunctionInfo -MemberType ScriptProperty -MemberName Age -Value {
+    New-TimeSpan -Start $this.LastUpdate -end (Get-Date)
+} -Force
+
+#endregion

PSFunctionInfo.psd1

@@ -22,7 +22,7 @@ Or using `PSResourceGet`:
 Install-PSResource PSFunctionInfo  [-scope CurrentUser]
 ```
 
-The module should work on both Windows PowerShell and PowerShell 7, even cross-platform, except for a few PowerShell-ISE-related commands.
+The module should work on both Windows PowerShell and PowerShell 7, even cross-platform, except for a few PowerShell ISE related commands.
 
 ## Description
 
@@ -32,7 +32,7 @@ The code in this module isn't concerned with loading, running, or finding functi
 
 ![Get a single function](images/get-psfunctioninfo-1.png)
 
-The default behavior is to show all functions that __don't__ belong to a module.
+The default behavior is to show all functions that __don't__ belong to a module and excluding a few common functions that PowerShell defines.
 
 ![Get stand-alone functions](images/get-psfunctioninfo-2.png)
 
@@ -45,14 +45,13 @@ The PSFunctionInfo object includes a PropertySet called `AuthorInfo`.
 ```dos
 PS C:\> Get-PSFunctionInfo -Tag modules | Select-Object -property AuthorInfo
 
-
 Name        : Test-HelpLink
 Version     : 0.9.0
 Source      : C:\scripts\update-helplinks.ps1
 CompanyName : JDH IT Solutions, Inc.
 Copyright   : (c) JDH IT Solutions, Inc.
 Description : Test if help file is missing the online link
-LastUpdate  : 4/23/2021 9:21:00 AM
+LastUpdate  : 4/23/2024 9:21:00 AM
 ```
 
 Or you can use the `TagInfo` property set. This gives you the same result as using the `tag` named view with `Format-Table`.,
@@ -70,7 +69,7 @@ Finally, you can also search .ps1 files for PSFunctionInfo metadata.
 Use the [New-PSFunctionInfo](docs/New-PSFunctionInfo.md) command to insert the metadata tag into your script file.
 
 ```powershell
-New-PSFunctionInfo -Path c:\scripts\Test-ConsoleColors.ps1 -Description "show console color combinations" -Name Test-ConsoleColor -Author "Jeff Hicks" -CompanyName "JDH IT Solutions" -Copyright "2023 JDH IT Solutions, Inc." -Tags "scripting","console"
+New-PSFunctionInfo -Path c:\scripts\Test-ConsoleColors.ps1 -Description "show console color combinations" -Name Test-ConsoleColor -Author "Jeff Hicks" -CompanyName "JDH IT Solutions" -Copyright "2024 JDH IT Solutions, Inc." -Tags "scripting","console"
 ```
 
 The default behavior is to insert the metadata tag immediately after the opening brace (`{`) into the file. __This command will update the file__. Or you can use the `ToClipBoard` parameter which will copy the metadata to the clipboard. You can then manually insert it into your script file that defines the function. You should avoid changing the formatting of the comment block.
@@ -84,11 +83,11 @@ You should get something like this:
 Version 1.0.0
 Author Jeff Hicks
 CompanyName JDH IT Solutions
-Copyright 2023 JDH IT Solutions, Inc.
+Copyright 2024 JDH IT Solutions, Inc.
 Description show console color combinations
 Guid 8e43a9d9-1df6-48c7-8595-7363087aba43
 Tags scripting,console
-LastUpdate 2/22/2023 10:43 AM
+LastUpdate 2/22/2024 10:43 AM
 Source C:\scripts\Test-ConsoleColors.ps1
 
 #>
@@ -110,11 +109,11 @@ Function Get-Foo {
 Version 1.0.0
 Author Jeff Hicks
 CompanyName JDH IT Solutions
-Copyright 2023 JDH IT Solutions, Inc.
+Copyright 2024 JDH IT Solutions, Inc.
 Description Get Foo Stuff
 Guid 490595c6-6a0c-4572-baf4-f808c010de70
 Tags scripting,console
-LastUpdate 2/21/2023 10:41 AM
+LastUpdate 2/21/2024 10:41 AM
 Source C:\scripts\FooStuff.ps1
 
 #>
@@ -212,7 +211,11 @@ This code is a prototype for a [suggestion](https://github.com/PowerShell/PowerS
 
 This module was first described at <https://jdhitsolutions.com/blog/powershell/8343/a-better-way-to-manage-powershell-functions/>.
 
+## Related Modules
+
+:bulb: You might also be interested in the [PSFunctionTools](https://github.com/jdhitsolutions/PSFunctionTools) module which contains a set of PowerShell 7 tools for automating and accelerating script and module development.
+
 ## Roadmap
 
-+ Add function metadata by file, auto-detecting the function name.
-+ Consider a bulk removal command to clean PSFunctionInfo metadata from files.
+- Add function metadata by file, auto-detecting the function name.
+- Consider a bulk removal command to clean PSFunctionInfo metadata from files.

PSFunctionInfo.psm1

@@ -1,7 +1,7 @@
 ---
 external help file: PSFunctionInfo-help.xml
 Module Name: PSFunctionInfo
-online version: https://bit.ly/3w8SBFj
+online version: https://jdhitsolutions.com/yourls/06a244
 schema: 2.0.0
 ---
 
@@ -129,7 +129,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 This command has an alias of epfi.
 
-Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
+Learn more about PowerShell: https://jdhitsolutions.com/yourls/newsletter
 
 ## RELATED LINKS