3.1.0 updates

Author: jdhitsolutions

PSScriptTools.psd1

@@ -130,59 +130,33 @@ If the function relies on external or additional files, you will have to copy th
 
 ### [Get-PSProfile](docs/Get-PSProfile.md)
 
-This command is designed for Windows systems and makes it easy to identify all possible PowerShell profile scripts. Including those for hosts such as VSCode or the PowerShell ISE. The command writes a custom object to the pipeline which has defined formatting. The default view is a table.
+This command is designed to make it easy to identify all possible PowerShell profile scripts. Including those for hosts such as VSCode or the PowerShell ISE. The command writes a custom object to the pipeline which has defined formatting. The default view is a table.
 
-```dos
-PS C:\> Get-PSProfile
-
-   Name: PowerShell
+![Get-PSProfile Windows](images/get-psprofile-windows.png)
 
-Scope                  Path                                                                Exists
------                  ----                                                                ------
-AllUsersCurrentHost    C:\Program Files\PowerShell\7\Microsoft.PowerShell_profile.ps1      False
-AllUsersAllHosts       C:\Program Files\PowerShell\7\profile.ps1                           False
-CurrentUserAllHosts    C:\Users\Jeff\Documents\PowerShell\profile.ps1                      True
-CurrentUserCurrentHost C:\Users\Jeff\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 True
-
-
-   Name: Windows PowerShell
-
-Scope                  Path                                                                Exists
------                  ----                                                                ------
-AllUsersCurrentHost    C:\WINDOWS\System32\WindowsPowerShell\v1.0\Microsoft.PowerShell...  True
-AllUsersAllHosts       C:\WINDOWS\System32\WindowsPowerShell\v1.0\profile.ps1              True
-CurrentUserAllHosts    C:\Users\Jeff\Documents\WindowsPowerShell\profile.ps1               True
-CurrentUserCurrentHost C:\Users\Jeff\Documents\WindowsPowerShell\Microsoft.PowerShell_p... True
-```
+![Get-PSProfile Linux](images/get-psprofile-linux.png)
 
 There is also a list view.
 
 ```dos
-PS C:\> Get-PSProfile | Where-Object {$_.name -eq 'powershell'} | Format-List
-
+PS C:\> Get-PSProfile | Where-Object {$_.name -eq 'powershell' -AND $_.Exists} | Format-List
 
    Name: PowerShell
 
-
-Scope        : AllUsersCurrentHost
-Path         : C:\Program Files\PowerShell\7\Microsoft.PowerShell_profile.ps1
-Exists       : False
-LastModified :
-
 Scope        : AllUsersAllHosts
 Path         : C:\Program Files\PowerShell\7\profile.ps1
-Exists       : False
-LastModified :
+Exists       : True
+LastModified : 2/23/2022 1:27:30 PM
 
 Scope        : CurrentUserAllHosts
 Path         : C:\Users\Jeff\Documents\PowerShell\profile.ps1
 Exists       : True
-LastModified : 9/9/2024 2:35:45 PM
+LastModified : 10/5/2020 3:50:19 PM
 
 Scope        : CurrentUserCurrentHost
 Path         : C:\Users\Jeff\Documents\PowerShell\Microsoft.PowerShell_profile.ps1
 Exists       : True
-LastModified : 9/9/2024 2:03:44 PM
+LastModified : 10/5/2020 3:50:19 PM
 ```
 
 ### [Get-MyAlias](docs/Get-MyAlias.md)
@@ -212,67 +186,66 @@ This is an alternative to `Get-Command` to make it easier to see at a glance wha
 ```dos
 PS C:\> Get-ModuleCommand PSCalendar -ListAvailable
 
-   ModuleName: PSCalendar [v2.9.0]
-
-Name                        Alias Synopsis
-----                        ----- --------
-Get-Calendar                cal   Displays a visual representation of a
-                                  calendar.
-Get-MonthName                     Get the list of month names.
-Get-NCalendar               ncal  Display a Linux-style ncal calendar.
-Get-PSCalendarConfiguration       Get the current PSCalendar ANSI configuration.
-Set-PSCalendarConfiguration       Modify the PSCalendar ANSI configuration.
-Show-Calendar               scal  Display a colorized calendar month in the
-                                  console.
-Show-GuiCalendar            gcal  Display a WPF-based calendar.
-Show-PSCalendarHelp               Display a help PDF file for the PSCalendar
-                                  module.
+   ModuleName: PSCalendar [v2.10.1]
+
+Name                           Alias                        Synopsis
+----                           -----                        --------
+Export-PSCalendarConfiguration Save-PSCalendarConfiguration Save the current calendar configuration
+                                                            settings to a file.
+Get-Calendar                   cal                          Displays a visual representation of a
+                                                            calendar.
+Get-MonthName                  mon                          Get the list of month names.
+Get-NCalendar                  ncal                         Display a Linux-style ncal calendar.
+Get-PSCalendarConfiguration                                 Get the current PSCalendar ANSI
+                                                            configuration.
+Set-PSCalendarConfiguration                                 Modify the PSCalendar ANSI
+                                                            configuration.
+Show-Calendar                  scal                         Display a colorized calendar month in
+                                                            the console.
+Show-GuiCalendar               gcal                         Display a WPF-based calendar.
+Show-PSCalendarHelp                                         Display a help PDF file for the PSCalendar module.
 ```
 
 There are also alternate table views.
 
 ```dos
 PS C:\> Get-ModuleCommand PSCalendar | Format-Table -View verb
 
+   Verb: Export
+
+Name                           Alias           Type        Synopsis
+----                           -----           ----        --------
+Export-PSCalendarConfiguration Save-PSCalendar Function    Save the current calendar configuration
+                               Configuration               settings to a file.
+
    Verb: Get
 
 Name                           Alias           Type        Synopsis
 ----                           -----           ----        --------
-Get-Calendar                   cal             Function    Displays a visual
-                                                           representation of a
+Get-Calendar                   cal             Function    Displays a visual representation of a
                                                            calendar.
-Get-MonthName                                  Function    Get the list of
-                                                           month names.
-Get-NCalendar                  ncal            Function    Display a
-                                                           Linux-style ncal
-                                                           calendar.
-Get-PSCalendarConfiguration                    Function    Get the current
-                                                           PSCalendar ANSI
+Get-MonthName                  mon             Function    Get the list of month names.
+Get-NCalendar                  ncal            Function    Display a Linux-style ncal calendar.
+Get-PSCalendarConfiguration                    Function    Get the current PSCalendar ANSI
                                                            configuration.
 
-
    Verb: Set
 
 Name                           Alias           Type        Synopsis
 ----                           -----           ----        --------
-Set-PSCalendarConfiguration                    Function    Modify the
-                                                           PSCalendar ANSI
+Set-PSCalendarConfiguration                    Function    Modify the PSCalendar ANSI
                                                            configuration.
 
-
    Verb: Show
 
 Name                           Alias           Type        Synopsis
 ----                           -----           ----        --------
-Show-Calendar                  scal            Function    Display a colorized
-                                                           calendar month in
+Show-Calendar                  scal            Function    Display a colorized calendar month in
                                                            the console.
-Show-GuiCalendar               gcal            Function    Display a WPF-based
-                                                           calendar.
-Show-PSCalendarHelp                            Function    Display a help PDF
-                                                           file for the
+Show-GuiCalendar               gcal            Function    Display a WPF-based calendar.
+Show-PSCalendarHelp                            Function    Display a help PDF file for the
                                                            PSCalendar module.
-```
+                                                           ```
 
 Get module commands using the default formatted view. There is also a default view for `Format-List`.
 
@@ -608,9 +581,9 @@ You can also get detailed information.
 
 ![Windows PowerShell](images/get-powershellengine1.png)
 
-![PowerShell Core on Windows](images/get-powershellengine2.png)
+![PowerShell 7 on Windows](images/get-powershellengine2.png)
 
-![PowerShell Core on Linux](images/get-powershellengine3.png)
+![PowerShell 7 on Linux](images/get-powershellengine3.png)
 
 Results will vary depending on whether you are running PowerShell on Windows or non-Windows systems.
 

README.md

@@ -1,7 +1,7 @@
 ---
 external help file: PSScriptTools-help.xml
 Module Name: PSScriptTools
-online version: https://bit.ly/32DadcG
+online version:
 schema: 2.0.0
 ---
 

archive/ConvertTo-ASCIIArt.md

@@ -42,10 +42,10 @@ Function ConvertTo-ASCIIArt {
 }
 
 Register-ArgumentCompleter -CommandName ConvertTo-ASCIIArt -ParameterName Font -ScriptBlock {
-    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
+    param($commandName, $parameterName, $WordToComplete, $commandAst, $fakeBoundParameter)
 
     (Invoke-RestMethod https://artii.herokuapp.com/fonts_list).split() |
-        Where-Object { $_ -like "$wordToComplete*" } |
+        Where-Object { $_ -like "$WordToComplete*" } |
         ForEach-Object {
             [System.Management.Automation.CompletionResult]::new($_.Trim(), $_.Trim(), 'ParameterValue', $_)
         }

archive/ConvertTo-ASCIIArt.ps1

@@ -3,6 +3,34 @@
 This file contains the most recent change history for the PSScriptTools module.
 
 ## [Unreleased]
+### Added
+- Added the parameter `NoComments` to `New-PSFormatXml` to suppress the default helper comments.
+- Added a parameter alias `Property` for `Properties` in `New-PSFormatXML`.
+- Added a parameter alias `Property` for `Properties` in `New-PSFormatXML`.
+- Added alias `isAdmin` to `Test-IsElevated`.
+
+### Changed
+- Updated `Convert-CommandToHashTable` to better handle a hashtable as a paremeter value.
+- Updated `ConvertTo-Hashtable` to using PSObject` to get property names.
+- Updated `ConvertTo-Hashtable` to make an alphabetically sorted hashtable an ordered hashtable.
+- Updated `Convert-HashtableToCode` to accept a standard or ordered hashtable as input.
+- Revised `Get-MyVariable`. Removed the `-NoTypeInformation` and made it opt-in with -IncludeTypeInformation`. __This is a breaking change.__
+- Revised `Get-MyVariable` to get initial variables from a new PowerShell instance.
+- Revised `Get-MyAlias` to let user specify a name. The new version also skips aliases from common modules like PSReadline and Microsoft.PowerShell.PSResourceGet.
+- Revised formatting for `Get-ModuleCommand` to add a link to online help for each command if running PowerShell 7.
+- Updated `New-PSFormatXML` to incorporate a suggestion from [@scriptingstudio](https://github.com/scriptingstudio). [[Issue #155](https://github.com/jdhitsolutions/PSScriptTools/issues/155)]
+- Updated `Get-PSProfile` to support non-Windows platforms. Reformatted the default table view.
+- Updated `README`.
+- Updated `Get-PSLocation` to include locations in `%PSModulePath%` Also corrected values for `HOME` and `Documents`. These changes also meant updating the custom formatting file..
+- Updated `Get-PowerShellEngine` to define a type name (`PSEngine`) when writing a detailed object.
+- Modified `Show-ANSISequence` to adjust number of columns to display in PowerShell 7.
+- Code cleanup.
+- Help updates.
+- Replaced bit.ly online help links.
+
+### Fixed
+- Fixed bug in `Get-ModuleCommand` that failed to retrieve all command aliases.
+- Fixed error in DirectoryStat sizeKB format view that wasn't showing values in KB
 
 ## [3.0.0] - 2025-03-26
 

changelog.md

@@ -19,19 +19,36 @@ Convert-CommandToHashtable [-Text] <String> [<CommonParameters>]
 
 ## DESCRIPTION
 
-This command is intended to convert a long PowerShell expression with named parameters into a splatting alternative. The central concept is that you are editing a script file with a lengthy PowerShell expression with multiple parameters and you would like to turn it into splatting code.
+This command is intended to convert a long PowerShell expression with named parameters into a splatting alternative. The central concept is that you are editing a script file with a lengthy PowerShell expression with multiple parameters and you would like to turn it into splatting code. For best results, the command expression should use parameter names and not rely on positional parameters.
+
+The command may produce an invalid hashtable with complex expressions as parameter values.
 
 ## EXAMPLES
 
 ### Example 1
 
 ```powershell
-PS C:\> $text ="Get-WinEvent -ListLog p* -computername SRV1 -ErrorAction stop"
+PS C:\> $text = "Get-WinEvent -ListLog p* -computername SRV1 -ErrorAction stop"
 PS C:\> Convert-CommandToHashtable -Text $text | Set-Clipboard
 ```
 
 The $text variable might be a line of code from your script. The second line converts into a splatting sequence and copies it to the Windows clipboard so you can paste it back into your script. You could create a VS Code task sequence using this function.
 
+### Example 2
+
+```powershell
+PS C:\> Convert-CommandToHashtable -Text (h 149).Commandline
+$paramHash = @{
+  path = "c:\work"
+  filter = "*.ps1"
+  recurse = $True
+}
+
+Get-ChildItem @paramHash
+```
+
+Convert command 149 from command history into a hashtable.
+
 ## PARAMETERS
 
 ### -Text

docs/Convert-CommandToHashtable.md

@@ -16,26 +16,25 @@ Convert a hashtable to a string representation.
 ### psd1 (Default)
 
 ```yaml
-Convert-HashtableToCode [-Hashtable] <Hashtable> [-Indent <Int32>]
-[<CommonParameters>]
+Convert-HashtableToCode [-Hashtable] <Object> [-Indent <Int32>] [<CommonParameters>]
 ```
 
 ### inline
 
 ```yaml
-Convert-HashtableToCode [-Hashtable] <Hashtable> [-Inline] [<CommonParameters>]
+Convert-HashtableToCode [-Hashtable] <Object> [-Inline] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 
-Use this command to convert a hashtable into its text or string equivalent. It is assumed that any array values contain items of the same type. This command has not been tested with large or complex hashtables, so you might need to manually edit the output to meet your tastes or requirements.
+Use this command to convert a hashtable into its text or string equivalent. It is assumed that any array values contain items of the same type. This command has not been tested with large or complex hash tables, so you might need to manually edit the output to meet your requirements.
 
 ## EXAMPLES
 
 ### Example 1
 
 ```powershell
-PS C:\> $h = @{Name="SRV1";Asset=123454;Location="Omaha"}
+PS C:\> $h = [ordered]@{Name="SRV1";Asset=123454;Location="Omaha"}
 PS C:\> Convert-HashtableToCode $h
 @{
         Name = 'SRV1'
@@ -44,7 +43,7 @@ PS C:\> Convert-HashtableToCode $h
 }
 ```
 
-Convert a hashtable object to a string equivalent that you can copy into your script.
+Convert an ordered hashtable object to a string equivalent that you can copy into your script.
 
 ### Example 2
 
@@ -63,7 +62,7 @@ Create an inline string version of the hashtable.
 A hashtable to convert. It can be standard or ordered hashtable.
 
 ```yaml
-Type: Hashtable
+Type: Object
 Parameter Sets: (All)
 Aliases:
 
@@ -76,7 +75,7 @@ Accept wildcard characters: False
 
 ### -Indent
 
-Specify the number of tabs to indent. You shouldn't need to specify this parameter. It exists for situations where there are nested hashtables.
+Specify the number of tabs to indent. You shouldn't need to specify this parameter. It exists for situations where there are nested hash tables.
 
 ```yaml
 Type: Int32

docs/Convert-HashtableToCode.md

@@ -1,7 +1,7 @@
 ---
 external help file: PSScriptTools-help.xml
 Module Name: PSScriptTools
-online version: https://bit.ly/3qfPnwj
+online version: https://jdhitsolutions.com/yourls/e41450
 schema: 2.0.0
 ---
 

docs/Convert-HtmlToAnsi.md

@@ -27,9 +27,7 @@ This command will take an object and create a hashtable based on its properties.
 ### Example 1
 
 ```powershell
-PS C:\> Get-Process -id $pid |
-Select-Object name,id,handles,WorkingSet |
-ConvertTo-Hashtable
+PS C:\> Get-Process -id $pid | Select-Object name,id,handles,WorkingSet | ConvertTo-Hashtable
 
 Name                           Value
 ----                           -----

docs/ConvertTo-Hashtable.md

@@ -1,7 +1,7 @@
 ---
 external help file: PSScriptTools-help.xml
 Module Name: PSScriptTools
-online version: https://bit.ly/3gQclWl
+online version: https://jdhitsolutions.com/yourls/7011bb
 schema: 2.0.0
 ---