v2.22.0

jdhitsolutions · jdhitsolutions · commit 9b2b90afc2de · 2020-04-17T09:24:18.000-04:00
diff --git a/PSScriptTools.psd1 b/PSScriptTools.psd1
diff --git a/README.md b/README.md
@@ -441,10 +441,10 @@ Computername    Path                                                TotalFiles
 BOVINE320       C:\work                                                   1375     137516856
 ```
 
- The command includes a format file with additional view to display the total size in KB, MB or GB.
+ The command includes a format file with additional view to display the total size in KB, MB, GB or TB.
 
 ```powershell
-PS C:\> Get-Childitem D:\ -Directory | Get-FolderSizeInfo -Hidden | Where-Object TotalSize -gt 1gb | Sort-Object TotalSize -Descending | format-table -View gb
+PS C:\> Get-ChildItem D:\ -Directory | Get-FolderSizeInfo -Hidden | Where-Object TotalSize -gt 1gb | Sort-Object TotalSize -Descending | format-table -View gb
 
 Computername    Path                                                TotalFiles   TotalSizeGB
 ------------    ----                                                ----------   -----------
@@ -1511,6 +1511,6 @@ If you find this module useful, you might also want to look at my tools for [cre
 
 ## Compatibility
 
-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. It is assumed you will __not__ be running this commands on any edition of PowerShell Core or any beta releases of PowerShell 7.
+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-03-12 15:22:43Z UTC*
+Last Updated *2020-04-17 13:14:01Z UTC*
diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,12 @@
 # Change Log for PSScriptTools
 
+## v2.22.0
+
++ Modified `Set-ConsoleTitle` to move parameter validation into the `Process` script block. (Issue #75)
++ Modified `Get-FolderSizeInfo` to fix an enumeration bug when used in Windows PowerShell. (Issue #77)
++ Added online help links for `Get-GitSize`, `Get-ModuleCommand` and `Remove-MergedBranch`.
++ Updated `foldersizeinfo.format.ps1xml` to include a view called `TB` to display values in TB.
+
 ## v2.21.0
 
 + Updated `Set-ConsoleTitle` and `Set-ConsoleColor` to display a warning if not in a console session. (Issue #75)
diff --git a/docs/Get-FolderSizeInfo.md b/docs/Get-FolderSizeInfo.md
@@ -67,7 +67,7 @@ BOVINE320       D:\logs                                                    134
 BOVINE320       D:\2016                                                      5        1.5608
 ```
 
-Get the top level directories from D and pipe them to Get-FolderSizeInfo. Items with a total size of greater an 1MB are sorted on the total size and then formatted as a table using a built-in view called MB which formats the total size in MB. There is also a view called GB.
+Get the top level directories from D and pipe them to Get-FolderSizeInfo. Items with a total size of greater an 1MB are sorted on the total size and then formatted as a table using a built-in view called MB which formats the total size in MB. There are also views named KB,GB and TB to display formatted results accordingly..
 
 ### Example 4
 
diff --git a/docs/Get-GitSize.md b/docs/Get-GitSize.md
@@ -1,7 +1,7 @@
 ---
 external help file: PSScriptTools-help.xml
 Module Name: psscripttools
-online version:
+online version: https://bit.ly/3bj81JZ
 schema: 2.0.0
 ---
 
@@ -19,10 +19,7 @@ Get-GitSize [[-Path] <String>] [<CommonParameters>]
 
 ## DESCRIPTION
 
-When using git, it creates a hidden folder for change tracking.
-Because the file is hidden it is easy to overlook how large it might become.
-The command uses a formatting file to display a default view.
-There is an additonal table view called MB that you can use.
+When using git, it creates a hidden folder for change tracking. Because the file is hidden it is easy to overlook how large it might become. The command uses a formatting file to display a default view. There is an additional table view called MB that you can use.
 
 ## EXAMPLES
 
diff --git a/docs/Get-ModuleCommand.md b/docs/Get-ModuleCommand.md
@@ -1,7 +1,7 @@
 ---
 external help file: PSScriptTools-help.xml
 Module Name: PSScriptTools
-online version:
+online version: https://bit.ly/2Kfjm1Q
 schema: 2.0.0
 ---
 
@@ -27,9 +27,7 @@ Get-ModuleCommand -FullyQualifiedName <ModuleSpecification> [-ListAvailable] [<C
 
 ## DESCRIPTION
 
-This is an alternative to Get-Command to make it easier to see at a glance what commands are contained within a module and what they can do.
-By default, Get-ModuleCommand looks for loaded modules. Use -ListAvailable to see commands in module not currently loaded.
-Note that if the help file is malformed or missing, you might get oddly formatted results.
+This is an alternative to Get-Command to make it easier to see at a glance what commands are contained within a module and what they can do. By default, Get-ModuleCommand looks for loaded modules. Use -ListAvailable to see commands in module not currently loaded. Note that if the help file is malformed or missing, you might get oddly formatted results.
 
 ## EXAMPLES
 
diff --git a/docs/Remove-MergedBranch.md b/docs/Remove-MergedBranch.md
@@ -1,7 +1,7 @@
 ---
 external help file: PSScriptTools-help.xml
 Module Name: psscripttools
-online version:
+online version: https://bit.ly/3crxxg9
 schema: 2.0.0
 ---
 
diff --git a/en-us/PSScriptTools-help.xml b/en-us/PSScriptTools-help.xml
@@ -4270,7 +4270,7 @@ BOVINE320       D:\rip                                                       3
 BOVINE320       D:\logs                                                    134        3.9517
 BOVINE320       D:\2016                                                      5        1.5608</dev:code>
         <dev:remarks>
-          <maml:para>Get the top level directories from D and pipe them to Get-FolderSizeInfo. Items with a total size of greater an 1MB are sorted on the total size and then formatted as a table using a built-in view called MB which formats the total size in MB. There is also a view called GB.</maml:para>
+          <maml:para>Get the top level directories from D and pipe them to Get-FolderSizeInfo. Items with a total size of greater an 1MB are sorted on the total size and then formatted as a table using a built-in view called MB which formats the total size in MB. There are also views named KB,GB and TB to display formatted results accordingly..</maml:para>
         </dev:remarks>
       </command:example>
       <command:example>
@@ -4320,7 +4320,7 @@ sunday                          47   24540.6523</dev:code>
       </maml:description>
     </command:details>
     <maml:description>
-      <maml:para>When using git, it creates a hidden folder for change tracking. Because the file is hidden it is easy to overlook how large it might become. The command uses a formatting file to display a default view. There is an additonal table view called MB that you can use.</maml:para>
+      <maml:para>When using git, it creates a hidden folder for change tracking. Because the file is hidden it is easy to overlook how large it might become. The command uses a formatting file to display a default view. There is an additional table view called MB that you can use.</maml:para>
     </maml:description>
     <command:syntax>
       <command:syntaxItem>
@@ -4419,6 +4419,10 @@ C:\scripts\PSReleaseTools                       440          3.0588</dev:code>
       </command:example>
     </command:examples>
     <command:relatedLinks>
+      <maml:navigationLink>
+        <maml:linkText>Online Version:</maml:linkText>
+        <maml:uri>https://bit.ly/3bj81JZ</maml:uri>
+      </maml:navigationLink>
       <maml:navigationLink>
         <maml:linkText>Get-ChildItem</maml:linkText>
         <maml:uri></maml:uri>
@@ -4613,6 +4617,10 @@ Synopsis : Ends forcibly the SMB session.
       </command:example>
     </command:examples>
     <command:relatedLinks>
+      <maml:navigationLink>
+        <maml:linkText>Online Version:</maml:linkText>
+        <maml:uri>https://bit.ly/2Kfjm1Q</maml:uri>
+      </maml:navigationLink>
       <maml:navigationLink>
         <maml:linkText>Get-Command</maml:linkText>
         <maml:uri></maml:uri>
@@ -9637,6 +9645,10 @@ Deleted branch patch-254 (was 75f6ab8).</dev:code>
       </command:example>
     </command:examples>
     <command:relatedLinks>
+      <maml:navigationLink>
+        <maml:linkText>Online Version:</maml:linkText>
+        <maml:uri>https://bit.ly/3crxxg9</maml:uri>
+      </maml:navigationLink>
       <maml:navigationLink>
         <maml:linkText>git.exe</maml:linkText>
         <maml:uri></maml:uri>
diff --git a/formats/foldersizeinfo.format.ps1xml b/formats/foldersizeinfo.format.ps1xml
@@ -36,10 +36,6 @@ format type data generated 01/29/2020 13:25:45 by BOVINE320\Jeff
         <TableRowEntries>
           <TableRowEntry>
             <TableColumnItems>
-              <!--
-            By default the entries use property names, but you can replace them with scriptblocks.
-            <ScriptBlock>$_.foo /1mb -as [int]</ScriptBlock>
-              -->
               <TableColumnItem>
                 <PropertyName>Computername</PropertyName>
               </TableColumnItem>
@@ -89,10 +85,6 @@ format type data generated 01/29/2020 13:25:45 by BOVINE320\Jeff
         <TableRowEntries>
           <TableRowEntry>
             <TableColumnItems>
-              <!--
-            By default the entries use property names, but you can replace them with scriptblocks.
-            <ScriptBlock>$_.foo /1mb -as [int]</ScriptBlock>
-              -->
               <TableColumnItem>
                 <PropertyName>Computername</PropertyName>
               </TableColumnItem>
@@ -142,10 +134,6 @@ format type data generated 01/29/2020 13:25:45 by BOVINE320\Jeff
         <TableRowEntries>
           <TableRowEntry>
             <TableColumnItems>
-              <!--
-            By default the entries use property names, but you can replace them with scriptblocks.
-            <ScriptBlock>$_.foo /1mb -as [int]</ScriptBlock>
-              -->
               <TableColumnItem>
                 <PropertyName>Computername</PropertyName>
               </TableColumnItem>
@@ -195,10 +183,6 @@ format type data generated 01/29/2020 13:25:45 by BOVINE320\Jeff
         <TableRowEntries>
           <TableRowEntry>
             <TableColumnItems>
-              <!--
-            By default the entries use property names, but you can replace them with scriptblocks.
-            <ScriptBlock>$_.foo /1mb -as [int]</ScriptBlock>
-              -->
               <TableColumnItem>
                 <PropertyName>Computername</PropertyName>
               </TableColumnItem>
@@ -223,14 +207,6 @@ format type data generated 01/29/2020 13:25:45 by BOVINE320\Jeff
         <TypeName>FolderSizeInfo</TypeName>
       </ViewSelectedBy>
       <GroupBy>
-        <!--
-            You can also use a scriptblock to define a custom property name.
-            You must have a Label tag.
-            <ScriptBlock>$_.machinename.toUpper()</ScriptBlock>
-            <Label>Computername</Label>
-
-            Use <Label> to set the displayed value.
--->
         <ScriptBlock>$(Split-Path $_.Path)</ScriptBlock>
         <Label>Path</Label>
       </GroupBy>
@@ -255,10 +231,6 @@ format type data generated 01/29/2020 13:25:45 by BOVINE320\Jeff
         <TableRowEntries>
           <TableRowEntry>
             <TableColumnItems>
-              <!--
-            By default the entries use property names, but you can replace them with scriptblocks.
-            <ScriptBlock>$_.foo /1mb -as [int]</ScriptBlock>
--->
               <TableColumnItem>
                 <PropertyName>Name</PropertyName>
               </TableColumnItem>
@@ -273,5 +245,54 @@ format type data generated 01/29/2020 13:25:45 by BOVINE320\Jeff
         </TableRowEntries>
       </TableControl>
     </View>
+    <View>
+      <!--Created 4/14/2020 by BOVINE320\Jeff-->
+      <Name>TB</Name>
+      <ViewSelectedBy>
+        <TypeName>FolderSizeInfo</TypeName>
+      </ViewSelectedBy>
+      <TableControl>
+        <TableHeaders>
+          <TableColumnHeader>
+            <Label>Computername</Label>
+            <Width>15</Width>
+            <Alignment>left</Alignment>
+          </TableColumnHeader>
+          <TableColumnHeader>
+            <Label>Path</Label>
+            <Width>48</Width>
+            <Alignment>left</Alignment>
+          </TableColumnHeader>
+          <TableColumnHeader>
+            <Label>TotalFiles</Label>
+            <Width>13</Width>
+            <Alignment>right</Alignment>
+          </TableColumnHeader>
+          <TableColumnHeader>
+            <Label>TotalSizeTB</Label>
+            <Width>13</Width>
+            <Alignment>right</Alignment>
+          </TableColumnHeader>
+        </TableHeaders>
+        <TableRowEntries>
+          <TableRowEntry>
+            <TableColumnItems>
+              <TableColumnItem>
+                <PropertyName>Computername</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>Path</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>TotalFiles</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <ScriptBlock>[math]::round($_.totalSize /1tb,4)</ScriptBlock>
+              </TableColumnItem>
+            </TableColumnItems>
+          </TableRowEntry>
+        </TableRowEntries>
+      </TableControl>
+    </View>
   </ViewDefinitions>
 </Configuration>
diff --git a/functions/Get-FolderSizeInfo.ps1 b/functions/Get-FolderSizeInfo.ps1
@@ -139,7 +139,11 @@ Function Get-FolderSizeInfo {
 
                 If ($files.count -gt 0) {
                     Write-Verbose "Found $($files.count) files"
-                    $stats = $files | Measure-Object -property length -sum
+                    # there appears to be a bug with the array list in Windows PowerShell
+                    # where it doesn't always properly enumerate. Passing the list
+                    # items via ForEach appears to solve the problem and doesn't
+                    # adversely affect PowerShell 7. Addeed in v2.22.0. JH
+                    $stats = $files.foreach( {$_}) | Measure-Object -property length -sum
                     $totalFiles = $stats.count
                     $totalSize = $stats.sum
                 }
diff --git a/functions/Utilities.ps1 b/functions/Utilities.ps1
@@ -280,21 +280,25 @@ Function Set-ConsoleTitle {
     Param(
         [Parameter(Position = 0, Mandatory, HelpMessage = "Enter the title for the console window.")]
         [ValidateNotNullorEmpty()]
-        [ValidateScript( {$_.length -le ($host.UI.RawUI.MaxWindowSize.Width * 2)})]
         [string]$Title
     )
     Begin {
         Write-Verbose "[$((Get-Date).TimeofDay) BEGIN  ] Starting $($myinvocation.mycommand)"
+        $width =  ($host.UI.RawUI.MaxWindowSize.Width * 2)
     } #begin
 
     Process {
         if ($host.Name -ne "ConsoleHost") {
             Write-Warning "This command must be run from a PowerShell console session. Not the PowerShell ISE or Visual Studio Code or similar environments."
-            #bail out
         }
-        Write-Verbose "[$((Get-Date).TimeofDay) PROCESS] Setting console title to $Title"
-        if ($pscmdlet.ShouldProcess($Title)) {
-            $host.ui.RawUI.WindowTitle = $Title
+        elseif (($title.length -ge $width)) {
+            Write-Warning "Your title is too long. It needs to be less than $width to fit your current console."
+        }
+        else {
+            Write-Verbose "[$((Get-Date).TimeofDay) PROCESS] Setting console title to $Title"
+            if ($pscmdlet.ShouldProcess($Title)) {
+                $host.ui.RawUI.WindowTitle = $Title
+            }
         }
     } #process
 
