2.34.0 changes

Author: jdhitsolutions

Archive-ChangeLog.md

@@ -2,6 +2,25 @@
 
 This file contains older change history. It is maintained for reference purposes.
 
+## v2.31.0
+
++ Merged PR from @corbob to fix an issue detecting profiles scripts when the user's Documents location has changed. (Issue #93)
++ Modified `Convert-HasthtableToCode` to explicitly use `@()` for array elements. This is a continuation of a fix for Issue #91.
++ Updated `New-PSFormatXML` to process a custom hashtable as a property name and convert the XML property to a scriptblock.
++ Updated `New-PSFormatXML` so that Wide views are auto-sized by default.
++ Modified the metadata comment generated by `New-PSFormatXML`.
++ Modified `New-PSFormatXML` to only display the warning message once when detecting additional objects.
++ Added `Get-FormatView` with an alias of `gfv` to show defined format views. This command uses a format file, `formatview.format.ps1xml`.
++ Added `Changelog.md` to `PSScriptToolsManual.pdf`.
++ Moved older change log information to `Archive-Changelog.md`.
++ Help and documentation updates.
+
+## v2.30.0
+
++ Fixed a bug in `Convert-HashtableToCode` when converting hashtables with nested hashtables. (Issue #91)
++ Modified `Convert-HashtableToCode` to honor `-Inline` when processing nested hashtables.
++ Updated help documentation for `Convert-HashtableToCode` to clarify the use of array values in a hashtable.
+
 ## v2.29.0
 
 + Modified `Get-WindowsVersion` to not use remoting when connecting to the local computer. (Issue #90)

PSScriptTools.psd1

@@ -11,18 +11,33 @@ Get-ChildItem -path $PSScriptRoot\functions\*.ps1 | ForEach-Object -process {
 
 Write-Verbose "Define the global PSAnsiFileMap variable"
 $json = "psansifilemap.json"
-#test for user version
+
+#test for user version in $HOME
 $userjson = Join-Path -path $HOME -ChildPath $json
 $modjson = Join-Path -path $PSScriptRoot -ChildPath $json
 
 if (Test-Path -path $userjson) {
     $map = $userjson
 }
 else {
+    #use the file from this module
     $map = $modjson
 }
 
-Set-Variable -Name PSAnsiFileMap -value (Get-Content -path $map | ConvertFrom-Json) -Scope Global
+#ConvertFrom-Json doesn't write simple objects to the pipeline in Windows PowerShell so I
+#need to process the results individually.
+$mapData = [System.Collections.Generic.List[object]]::new()
+
+Get-Content -path $map | ConvertFrom-Json | Foreach-Object {$_} | foreach-Object {
+    $entry = [pscustomobject]@{
+        PSTypeName  = "PSAnsiFileEntry"
+        Description = $_.description
+        Pattern = $_.pattern
+        Ansi = $_.ansi
+    }
+    $mapData.Add($entry)
+}
+Set-Variable -Name PSAnsiFileMap -value $mapdata -Scope Global
 
 Write-Verbose "Define special character map"
 $global:PSSpecialChar = @{

PSScriptTools.psm1

@@ -23,6 +23,7 @@ The contents of this file and other documentation can be viewed using the `Open-
 + [Console Utilities](#Console-Utilities)
 + [Format Functions](#Format-Functions)
 + [Scripting Tools](#Scripting-Tools)
++ [ANSI Tools](#Ansi-Tools)
 + [Other Module Features](#Other-Module-Features)
 + [Related Modules](#Related-Modules)
 + [Compatibility](#Compatibility)
@@ -1088,7 +1089,7 @@ Get-Process | after (Get-Date).Addminutes(-1) -Property StartTime
 
 This is selecting all processes that started within the last minute.
 
-### [Select-Before](docs/Select-Before.md)]
+### [Select-Before](docs/Select-Before.md)
 
 `Select-Before` is the opposite of `Select-After`.
 
@@ -1987,9 +1988,9 @@ Mode                 LastWriteTime         Length Name
 
 You will need to manually install the file.
 
-## Other Module Features
+## ANSI Tools
 
-From time to time I will include additional items that you might find useful in your PowerShell work. This module includes several custom format files for common objects like services. You can run `Get-Service` and pipe it to the custom table view.
+This module includes several custom format files for common objects like services. You can run `Get-Service` and pipe it to the custom table view.
 
 ```powershell
 Get-Service | Format-Table -view ansi
@@ -2069,11 +2070,11 @@ TopContainer
 ChildContainer
 ```
 
-The map includes ANSI settings for different file types. You won't see the ANSI value in the output. The module will add a custom table view called `ansi` which you can use to display file results colorized in PowerShell 7.
+The map includes ANSI settings for different file types. You won't see the ANSI value in the output. The module will add a custom table view called `ansi` which you can use to display colorized file results.
 
 ![ANSI File listing](images/ansi-file-format.png)
 
-The mapping file is user-customizable. Copy the `psansifilemap.json` file from the module's root directory to $HOME. When you import this module, if the file is found, it will be imported and used as `psansifilemap`, otherwise the module's file will be used.
+The mapping file is user-customizable. Copy the `psansifilemap.json` file from the module's root directory to $HOME. When you import this module, if the file is found, it will be imported and used as `psansifilemap`, otherwise, the module's file will be used.
 
 The file will look like this:
 
@@ -2127,7 +2128,39 @@ The file will look like this:
 ]
 ```
 
-You can create or modify file groups. The Pattern value should be a regular expression pattern to match on the filename. Don't forget you will need to escape characters for the JSON format. The Ansi value will be an ANSI escape sequence. You can use `\u001b` for the \``e` character.
+You can create or modify file groups. The Pattern value should be a regular expression pattern to match the filename. Don't forget you will need to escape characters for the JSON format. The Ansi value will be an ANSI escape sequence. You can use `\u001b` for the \``e` character.
+
+If you prefer not to edit JSON files, you can use the PSAnsiFileMap commands from the module.
+
+### [Get-PSAnsiFileMap](docs/Get-PSAnsiFileMap.md)
+
+This command will display the value of the `$PSAnsiFileMap` variable, but will also show the ANSI sequence using the sequence itself.
+
+![get-psansifilemap](images/get-psansifilemap.png)
+
+### [Set-PSAnsiFileMap](docs/Set-PSAnsiFileMap.md)
+
+Use this command to modify an existing entry. You need to specify a regular expression pattern to match on the filename and/or an ANSI escape sequence. If the entry description doesn't exist, you will need to specify the regex pattern and the ANSI sequence to add the entry to $PSAnsiFileMap.
+
+```powershell
+Set-PSAnsiFileMap Archive -Ansi "`e[38;5;75m"
+```
+
+### [Remove-PSAnsiFileEntry](docs/Remove-PSAnsiFileEntry.md)
+
+If you need to, you can remove an entry from `$PSAnsiFileMap`.
+
+```powershell
+Remove-PSAnsiFileEntry DevFiles
+```
+
+### [Export-PSAnsiFileMap](docs/Export-PSAnsiFileMap.md)
+
+Any changes you make to `$PSAnsiFileMap` will only last until you import the module again. To make the change permanent, use [Export-PSAnsiFileMap](docs/Export-PSAnsiFileMap.md). This will create the `psansifilemap.json` file in your `$HOME` directory. When you import the PSSCriptTools module, if this file is found, it will be imported. Otherwise, the default module file will be used.
+
+## Other Module Features
+
+From time to time I will include additional items that you might find useful in your PowerShell work.
 
 ### PSSpecialChar
 
@@ -2181,4 +2214,4 @@ If you find this module useful, you might also want to look at my PowerShell too
 
 Where possible these commands have been tested with PowerShell 7, but not every platform. If you encounter problems, have suggestions or other feedback, please post an [issue](https://github.com/jdhitsolutions/PSScriptTools/issues). It is assumed you will __not__ be running these commands on any edition of PowerShell Core or any beta releases of PowerShell 7.
 
-Last Updated *2020-11-12 18:56:02Z*
+Last Updated *2020-12-28 18:38:04Z*

PSScriptToolsManual.pdf

@@ -1,6 +1,22 @@
 # Change Log for PSScriptTools
 
-This is the most recent change log history for this module.
+This is the most recent change history for this module.
+
+## v2.34.0
+
++ Fixed typo bug in `Get-PSScriptTools` that was failing to get command aliases. (Issue #99)
++ Modified `Get-PSScriptTools` to improve performance. Assuming that all exported functions use standard verbs.
++ Added `Get-PSAnsiFileMap`.
++ Added `Set-PSAnsiFileMapEntry`.
++ Added `Remove-PSAnsiFileMapEntry`.
++ Added `Export-PSAnsiFileMap`.
++ Added `Show-ANSISequence`.
++ Updated `filesystem.ansi.format.ps1xml` to use last matching pattern.
++ Modified `Show-Tree` to better handle piped-in file and directory objects.
++ Added an alias `ab` for `Add-Border`.
++ Added an alias of `nab` for `New-AnsiBar`.
++ Updated `README.md`.
++ Help updates.
 
 ## v2.33.1
 
@@ -34,25 +50,6 @@ This is the most recent change log history for this module.
 + Added a splash header to `Get-PSScriptTools`. The header writes to the host so it isn't part of the command output.
 + Updated `README.md`.
 
-## v2.31.0
-
-+ Merged PR from @corbob to fix an issue detecting profiles scripts when the user's Documents location has changed. (Issue #93)
-+ Modified `Convert-HasthtableToCode` to explicitly use `@()` for array elements. This is a continuation of a fix for Issue #91.
-+ Updated `New-PSFormatXML` to process a custom hashtable as a property name and convert the XML property to a scriptblock.
-+ Updated `New-PSFormatXML` so that Wide views are auto-sized by default.
-+ Modified the metadata comment generated by `New-PSFormatXML`.
-+ Modified `New-PSFormatXML` to only display the warning message once when detecting additional objects.
-+ Added `Get-FormatView` with an alias of `gfv` to show defined format views. This command uses a format file, `formatview.format.ps1xml`.
-+ Added `Changelog.md` to `PSScriptToolsManual.pdf`.
-+ Moved older change log information to `Archive-Changelog.md`.
-+ Help and documentation updates.
-
-## v2.30.0
-
-+ Fixed a bug in `Convert-HashtableToCode` when converting hashtables with nested hashtables. (Issue #91)
-+ Modified `Convert-HashtableToCode` to honor `-Inline` when processing nested hashtables.
-+ Updated help documentation for `Convert-HashtableToCode` to clarify the use of array values in a hashtable.
-
 ## Archive
 
 If you need to see older change history, look at the [Archive ChangeLog](https://github.com/jdhitsolutions/PSScriptTools/blob/master/Archive-ChangeLog.md)

README.md

@@ -29,7 +29,7 @@ Add-Border [-TextBlock] <String[]> [-Character <String>] [-InsertBlanks]
 
 ## DESCRIPTION
 
-This command will create a character or text based border around a line of text. You might use this to create a formatted text report or to improve the display of information to the screen.
+This command will create a character or text-based border around a line of text. You might use this to create a formatted text report or to improve the display of information to the screen.
 
 ## EXAMPLES
 
@@ -247,7 +247,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
-### [System.String]
+### System.String
 
 ## NOTES
 

changelog.md

@@ -129,7 +129,7 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
 
 ## INPUTS
 
-### [string]
+### System.String
 
 ## OUTPUTS
 

docs/Add-Border.md

@@ -31,13 +31,13 @@ PS C:\> Compare-Script | Where-object {$_.UpdateNeeded}
 Name             : DNSSuffix
 OnlineVersion    : 0.4.1
 InstalledVersion : 0.2.0
-PublishedDate    : 10/22/2018 8:21:46 PM
+PublishedDate    : 10/22/2020 8:21:46 PM
 UpdateNeeded     : True
 
 Name             : InvokeBuild
 OnlineVersion    : 5.4.2
 InstalledVersion : 3.2.2
-PublishedDate    : 12/7/2018 1:30:46 AM
+PublishedDate    : 12/7/2020 1:30:46 AM
 UpdateNeeded     : True
 ...
 ```
@@ -48,7 +48,7 @@ List all scripts that could be updated.
 
 ```powershell
 PS C:\> Compare-Script | Where UpdateNeeded |
-Out-Gridview -title "Select scripts to update" -outputMode multiple |
+Out-Gridview -Title "Select scripts to update" -OutputMode multiple |
 Foreach-Object { Update-Script $_.name }
 ```
 
@@ -95,7 +95,7 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
 
 ## INPUTS
 
-### [string]
+### System.String
 
 ## OUTPUTS
 

docs/Compare-Module.md

@@ -19,7 +19,7 @@ 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 using a number of 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.
 
 ## EXAMPLES
 
@@ -61,7 +61,7 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
 
 ## OUTPUTS
 
-### [Hashtable]
+### Hashtable
 
 ## NOTES
 

docs/Compare-Script.md

@@ -20,7 +20,7 @@ Convert-EventLogRecord [-LogRecord] <EventLogRecord[]> [<CommonParameters>]
 ## DESCRIPTION
 
 When you use Get-WinEvent, the results are objects you can work with in PowerShell. However, often times there is additional information that is part of the eventlog record, such as replacement strings, that are used to construct a message. This additional information is not readily exposed.
-You can use this command to convert results of a Get-WinEvent command into a PowerShell custom object with additional information. For best results you, should pipe the same event IDs to this command.
+You can use this command to convert the results of a Get-WinEvent command into a PowerShell custom object with additional information. For best results, you should pipe the same event IDs to this command.
 
 Note that not every event record exposes data that is compatible with this command. For those types of event log records, you will see a RawProperties property with most likely an array of strings.
 Use the Message property for more information.
@@ -191,7 +191,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### [System.Diagnostics.Eventing.Reader.EventLogRecord[]]
+### System.Diagnostics.Eventing.Reader.EventLogRecord
 
 ## OUTPUTS
 

docs/Convert-CommandToHashtable.md

@@ -31,11 +31,11 @@ PS C:\> get-content c:\work\test.psd1 | unprotect-cmsmessage | Convert-Hashtable
 Name                           Value
 ----                           -----
 CreatedBy                      BOVINE320\Jeff
-CreatedAt                      10/02/2018 21:28:47 UTC
+CreatedAt                      10/02/2020 21:28:47 UTC
 Computername                   Think51
 Error
 Completed                      True
-Date                           10/02/2018 21:29:35 UTC
+Date                           10/02/2020 21:29:35 UTC
 Scriptblock                    restart-service spooler -force
 CreatedOn                      BOVINE320
 ```
@@ -71,7 +71,7 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
 
 ## OUTPUTS
 
-### [hashtable]
+### hashtable
 
 ## NOTES
 

docs/Convert-EventLogRecord.md

@@ -28,7 +28,7 @@ Convert-HashtableToCode [-Hashtable] <Hashtable> [-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 is not 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 hashtables, so you might need to manually edit the output to meet your tastes or requirements.
 
 ## EXAMPLES
 
@@ -60,7 +60,7 @@ Create an inline string version of the hashtable.
 
 ### -Hashtable
 
-A hashtable to convert. In can be standard or ordered hashtable.
+A hashtable to convert. It can be standard or ordered hashtable.
 
 ```yaml
 Type: Hashtable

docs/Convert-HashtableString.md

@@ -75,8 +75,7 @@ Accept wildcard characters: False
 
 ### -String
 
-Enter a lexical time string like P23DT3H43M.
-This is case-sensitive.
+Enter a lexical time string like P23DT3H43M. This is case-sensitive.
 
 ```yaml
 Type: String
@@ -106,8 +105,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## NOTES
 
-Learn more about PowerShell:
-http://jdhitsolutions.com/blog/essential-powershell-resources/
+Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
 
 ## RELATED LINKS