v2.25.0

Author: jdhitsolutions

PSScriptTools.psd1

@@ -46,6 +46,10 @@ $global:PSSpecialChar = @{
     Club             = ([char]0x2663)
     Heart            = ([char]0x2665)
     Spade            = ([char]0x2660)
+    Section          = ([char]0x00A7)
+    RightPointer     = ([char]0x25BA)
+    LeftPointer      = ([char]0x25C4)
+    BlackRectangle   = ([char]0x25CA)
 }
 
 Write-Verbose "Defining the variable `$PSSamplePath to the samples folder for this module"

PSScriptTools.psm1

@@ -1571,4 +1571,4 @@ If you find this module useful, you might also want to look at my tools for [cre
 
 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 this commands on any edition of PowerShell Core or any beta releases of PowerShell 7.
 
-> Last Updated *2020-05-21 20:11:54Z UTC*
+> Last Updated *2020-05-29 13:36:08Z UTC*

README.md

@@ -1,5 +1,24 @@
 # Change Log for PSScriptTools
 
+## v2.25.0
+
+### Add
+
++ Added a set of ANSI mappings for temporary files and system files in `psansifilemap.json`.
++ Added additional file extensions to `psansifilemap.json`.
++ Added pointers, section sign, and black rectangle to PSSpecialChars hashtable.
+
+### Change
+
++ Modified `Show-Tree` to make the `InColor` parameter always available. (Issue #80)
++ Modified `Add-Border` to use ANSI escape codes that will work in both Windows PowerShell and PowerShell 7.
++ Updated `New-PSFormatXML` to better handle empty or null property values. (Issue #81)
++ Help Updates
+
+### Delete
+
++ None
+
 ## v2.24.0
 
 ### Add

changelog.md

@@ -23,9 +23,9 @@ New-PSFormatXML [-InputObject] <Object> [[-Properties] <String[]>] [-Typename <S
 
 When defining custom objects with a new typename, PowerShell by default will display all properties. However, you may wish to have a specific default view, be it a table or list. Or you may want to have different views display the object differently. Format directives are stored in format.ps1xml files which can be tedious to create. This command simplifies that process.
 
-Pipe an instance of your custom object to this function and it will generate a format.ps1xml file based on either all the properties or a subset that you provide. When creating the file make sure the object you are modeling with does not have empty property values. You can repeat the process to add additional views. When finished, edit the format.ps1xml file and fine tune it. The file will have notes on how to substitute script blocks. If you run this command inside the Visual Studio Code PowerShell Integrated Console and use -Passthru, the new file will automatically be opened in your editor.
+Pipe an instance of your custom object to this function and it will generate a format.ps1xml file based on either all the properties or a subset that you provide. You can repeat the process to add additional views. When finished, edit the format.ps1xml file and fine tune it. The file will have notes on how to substitute script blocks. If you run this command inside the Visual Studio Code PowerShell Integrated Console and use -Passthru, the new file will automatically be opened in your editor.
 
-Note that table views are set to Autosize. But the table definition will include best guesses for column widths. If you prefer a more granular approach you can delete the Autosize tag and experiment with varying widths. Don't forget to run Update-FormatData to load your new file. You may need to start a new PowerShell session to test changes.
+Note that table views are set to Autosize. But the table definition will include best guesses for column widths. If you prefer a more granular approach you can delete the Autosize tag and experiment with varying widths. Don't forget to run Update-FormatData to load your new file. You may need to start a new PowerShell session to fully test changes.
 
 ## EXAMPLES
 
@@ -119,6 +119,14 @@ Once loaded into PowerShell, you can run a command like this:
 
 Get-Service | Sort-Object Status | Format-Wide -view Status
 
+### Example 6
+
+```powershell
+PS C:\> '' | Select-Object -Property Name,Size,Date,Count,Age | New-PSFormatXML -Typename myThing -Path c:\scripts\mything.format.ps1xml
+```
+
+This is an example of creating a formatting file from an empty object. Normally you would first define your object and verify it has all the properties you need and then you would create the formatting file. But you may want to create the formatting file in parallel using a technique like this.
+
 ## PARAMETERS
 
 ### -Append
@@ -172,7 +180,7 @@ Accept wildcard characters: False
 
 ### -InputObject
 
-Specify an object to analyze and generate or update a ps1xml file. All you need is one instance of the object.
+Specify an object to analyze and generate or update a ps1xml file. All you need is one instance of the object. Ideally, the object will have values for all properties.
 
 ```yaml
 Type: Object

docs/New-PSFormatXML.md

@@ -17,23 +17,23 @@ Shows the specified path as a tree.
 
 ```yaml
 Show-Tree [[-Path] <String[]>] [[-Depth] <Int32>] [-IndentSize <Int32>] [-ShowItem] [-ShowProperty <String[]>]
- [<CommonParameters>]
+ [-InColor] [<CommonParameters>]
 ```
 
 ### LiteralPath
 
 ```yaml
 Show-Tree [[-LiteralPath] <String[]>] [[-Depth] <Int32>] [-IndentSize <Int32>] [-ShowItem]
- [-ShowProperty <String[]>] [<CommonParameters>]
+ [-ShowProperty <String[]>] [-InColor] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 
-Shows the specified path as a graphical tree in the console. This is intended as PowerShell alternative to the tree DOS command. This function should work for any type of PowerShell provider and can be used to explore providers used for configuration like the WSMan provider or the registry. Currently, this will not work with any PSDrives created with the Certificate provider.
+Shows the specified path as a graphical tree in the console. This is intended as PowerShell alternative to the tree DOS command. This function should work for any type of PowerShell provider and can be used to explore providers used for configuration like the WSMan provider or the registry. Currently, this will *not work* with any PSDrives created with the Certificate provider. It should work cross-platform.
 
 By default, the output will only show directory or equivalent structures. But you can opt to include items well as item details by using the ShowProperty parameter. Specify a comma separated list of properties or use * to view them all.
 
-It should work cross-platform. If you are running PowerShell 7, there is a dynamic parameter, -InColor, that will write ANSI-colored output to the pipeline. The color scheme is designed for the file system. This parameter has an alias of -ansi.
+If the Path is a FileSystem path there is a dynamic parameter, -InColor, that will write ANSI-colored output to the pipeline. This parameter has an alias of -ansi.
 
 Note: This is an update to an older function in my library. I seem to recall I found the original code somewhere online, perhaps from someone like Lee Holmes. Sadly, I neglected to record the source.
 
@@ -125,7 +125,7 @@ Shows all the containers and items in the WSMan: drive.
 ### Example 4
 
 ```powershell
-PS C:\> pstree c:\work\alpha -files -properties LastWriteTime,Length
+PS C:\> pstree c:\work\alpha -files -properties LastWriteTime,Length -ansi
 
 C:\work\Alpha\
 +-- LastWriteTime = 02/28/2020 11:19:32
@@ -152,7 +152,7 @@ C:\work\Alpha\
 ...
 ```
 
-Show a tree listing with files including a few user specified properties. This example is using parameter and command aliases.
+Show a tree listing with files including a few user specified properties in color. This example is using parameter and command aliases.
 
 ## PARAMETERS
 
@@ -238,8 +238,7 @@ Accept wildcard characters: False
 
 ### -ShowProperty
 
-Shows the properties on containers and items.
-Use * to display all properties otherwise specify a comma separated list.
+Shows the properties on containers and items. Use * to display all properties otherwise specify a comma separated list.
 
 ```yaml
 Type: String[]
@@ -253,6 +252,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -InColor
+
+Show tree and item colorized. Values are from the $PSAnsiMap variable.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: ansi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### CommonParameters
 
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
@@ -267,8 +282,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## NOTES
 
-If you are using PowerShell 7, you can use the InColor parameter, or its alias ansi, to display the tree in a color code format.
-
 Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
 
 ## RELATED LINKS

docs/Show-Tree.md

@@ -8172,16 +8172,16 @@ PS DeepDive:\&gt;</dev:code>
     </command:details>
     <maml:description>
       <maml:para>When defining custom objects with a new typename, PowerShell by default will display all properties. However, you may wish to have a specific default view, be it a table or list. Or you may want to have different views display the object differently. Format directives are stored in format.ps1xml files which can be tedious to create. This command simplifies that process.</maml:para>
-      <maml:para>Pipe an instance of your custom object to this function and it will generate a format.ps1xml file based on either all the properties or a subset that you provide. When creating the file make sure the object you are modeling with does not have empty property values. You can repeat the process to add additional views. When finished, edit the format.ps1xml file and fine tune it. The file will have notes on how to substitute script blocks. If you run this command inside the Visual Studio Code PowerShell Integrated Console and use -Passthru, the new file will automatically be opened in your editor.</maml:para>
-      <maml:para>Note that table views are set to Autosize. But the table definition will include best guesses for column widths. If you prefer a more granular approach you can delete the Autosize tag and experiment with varying widths. Don't forget to run Update-FormatData to load your new file. You may need to start a new PowerShell session to test changes.</maml:para>
+      <maml:para>Pipe an instance of your custom object to this function and it will generate a format.ps1xml file based on either all the properties or a subset that you provide. You can repeat the process to add additional views. When finished, edit the format.ps1xml file and fine tune it. The file will have notes on how to substitute script blocks. If you run this command inside the Visual Studio Code PowerShell Integrated Console and use -Passthru, the new file will automatically be opened in your editor.</maml:para>
+      <maml:para>Note that table views are set to Autosize. But the table definition will include best guesses for column widths. If you prefer a more granular approach you can delete the Autosize tag and experiment with varying widths. Don't forget to run Update-FormatData to load your new file. You may need to start a new PowerShell session to fully test changes.</maml:para>
     </maml:description>
     <command:syntax>
       <command:syntaxItem>
         <maml:name>New-PSFormatXML</maml:name>
         <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
           <maml:name>InputObject</maml:name>
           <maml:Description>
-            <maml:para>Specify an object to analyze and generate or update a ps1xml file. All you need is one instance of the object.</maml:para>
+            <maml:para>Specify an object to analyze and generate or update a ps1xml file. All you need is one instance of the object. Ideally, the object will have values for all properties.</maml:para>
           </maml:Description>
           <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
           <dev:type>
@@ -8364,7 +8364,7 @@ PS DeepDive:\&gt;</dev:code>
       <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
         <maml:name>InputObject</maml:name>
         <maml:Description>
-          <maml:para>Specify an object to analyze and generate or update a ps1xml file. All you need is one instance of the object.</maml:para>
+          <maml:para>Specify an object to analyze and generate or update a ps1xml file. All you need is one instance of the object. Ideally, the object will have values for all properties.</maml:para>
         </maml:Description>
         <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
         <dev:type>
@@ -8586,6 +8586,13 @@ Jeff 2/10/2019 8:49:10 AM Microsoft Windows 10 Pro 40.20:56:24.5411481</dev:code
           <maml:para>Get-Service | Sort-Object Status | Format-Wide -view Status</maml:para>
         </dev:remarks>
       </command:example>
+      <command:example>
+        <maml:title>-------------------------- Example 6 --------------------------</maml:title>
+        <dev:code>PS C:\&gt; '' | Select-Object -Property Name,Size,Date,Count,Age | New-PSFormatXML -Typename myThing -Path c:\scripts\mything.format.ps1xml</dev:code>
+        <dev:remarks>
+          <maml:para>This is an example of creating a formatting file from an empty object. Normally you would first define your object and verify it has all the properties you need and then you would create the formatting file. But you may want to create the formatting file in parallel using a technique like this.</maml:para>
+        </dev:remarks>
+      </command:example>
     </command:examples>
     <command:relatedLinks>
       <maml:navigationLink>
@@ -11802,9 +11809,9 @@ Mode                LastWriteTime         Length Name
       </maml:description>
     </command:details>
     <maml:description>
-      <maml:para>Shows the specified path as a graphical tree in the console. This is intended as PowerShell alternative to the tree DOS command. This function should work for any type of PowerShell provider and can be used to explore providers used for configuration like the WSMan provider or the registry. Currently, this will not work with any PSDrives created with the Certificate provider.</maml:para>
+      <maml:para>Shows the specified path as a graphical tree in the console. This is intended as PowerShell alternative to the tree DOS command. This function should work for any type of PowerShell provider and can be used to explore providers used for configuration like the WSMan provider or the registry. Currently, this will not work with any PSDrives created with the Certificate provider. It should work cross-platform.</maml:para>
       <maml:para>By default, the output will only show directory or equivalent structures. But you can opt to include items well as item details by using the ShowProperty parameter. Specify a comma separated list of properties or use * to view them all.</maml:para>
-      <maml:para>It should work cross-platform. If you are running PowerShell 7, there is a dynamic parameter, -InColor, that will write ANSI-colored output to the pipeline. The color scheme is designed for the file system. This parameter has an alias of -ansi.</maml:para>
+      <maml:para>If the Path is a FileSystem path there is a dynamic parameter, -InColor, that will write ANSI-colored output to the pipeline. This parameter has an alias of -ansi.</maml:para>
       <maml:para>Note: This is an update to an older function in my library. I seem to recall I found the original code somewhere online, perhaps from someone like Lee Holmes. Sadly, I neglected to record the source.</maml:para>
     </maml:description>
     <command:syntax>
@@ -11869,6 +11876,17 @@ Mode                LastWriteTime         Length Name
           </dev:type>
           <dev:defaultValue>False</dev:defaultValue>
         </command:parameter>
+        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ansi">
+          <maml:name>InColor</maml:name>
+          <maml:Description>
+            <maml:para>Show tree and item colorized. Values are from the $PSAnsiMap variable.</maml:para>
+          </maml:Description>
+          <dev:type>
+            <maml:name>SwitchParameter</maml:name>
+            <maml:uri />
+          </dev:type>
+          <dev:defaultValue>False</dev:defaultValue>
+        </command:parameter>
       </command:syntaxItem>
       <command:syntaxItem>
         <maml:name>Show-Tree</maml:name>
@@ -11931,6 +11949,17 @@ Mode                LastWriteTime         Length Name
           </dev:type>
           <dev:defaultValue>False</dev:defaultValue>
         </command:parameter>
+        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ansi">
+          <maml:name>InColor</maml:name>
+          <maml:Description>
+            <maml:para>Show tree and item colorized. Values are from the $PSAnsiMap variable.</maml:para>
+          </maml:Description>
+          <dev:type>
+            <maml:name>SwitchParameter</maml:name>
+            <maml:uri />
+          </dev:type>
+          <dev:defaultValue>False</dev:defaultValue>
+        </command:parameter>
       </command:syntaxItem>
     </command:syntax>
     <command:parameters>
@@ -12006,6 +12035,18 @@ Mode                LastWriteTime         Length Name
         </dev:type>
         <dev:defaultValue>False</dev:defaultValue>
       </command:parameter>
+      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ansi">
+        <maml:name>InColor</maml:name>
+        <maml:Description>
+          <maml:para>Show tree and item colorized. Values are from the $PSAnsiMap variable.</maml:para>
+        </maml:Description>
+        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
+        <dev:type>
+          <maml:name>SwitchParameter</maml:name>
+          <maml:uri />
+        </dev:type>
+        <dev:defaultValue>False</dev:defaultValue>
+      </command:parameter>
     </command:parameters>
     <command:inputTypes>
       <command:inputType>
@@ -12029,7 +12070,6 @@ Mode                LastWriteTime         Length Name
     </command:returnValues>
     <maml:alertSet>
       <maml:alert>
-        <maml:para>If you are using PowerShell 7, you can use the InColor parameter, or its alias ansi, to display the tree in a color code format.</maml:para>
         <maml:para>Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/</maml:para>
       </maml:alert>
     </maml:alertSet>
@@ -12116,7 +12156,7 @@ WSMan:\
       </command:example>
       <command:example>
         <maml:title>-------------------------- Example 4 --------------------------</maml:title>
-        <dev:code>PS C:\&gt; pstree c:\work\alpha -files -properties LastWriteTime,Length
+        <dev:code>PS C:\&gt; pstree c:\work\alpha -files -properties LastWriteTime,Length -ansi
 
 C:\work\Alpha\
 +-- LastWriteTime = 02/28/2020 11:19:32
@@ -12142,7 +12182,7 @@ C:\work\Alpha\
 |  +--gamma
 ...</dev:code>
         <dev:remarks>
-          <maml:para>Show a tree listing with files including a few user specified properties. This example is using parameter and command aliases.</maml:para>
+          <maml:para>Show a tree listing with files including a few user specified properties in color. This example is using parameter and command aliases.</maml:para>
         </dev:remarks>
       </command:example>
     </command:examples>