Add -NoColor switch parameter to control colored output in formatters

ChocoLogParse/ChocoLog.format.ps1xml

@@ -36,12 +36,16 @@
               </TableColumnItem>
               <TableColumnItem>
                 <ScriptBlock>
-                $style = if ($_.exitCode -eq 0) {
-                  $PSStyle.Foreground.White
+                if ($script:ChocoLogNoColor) {
+                  [String]::Format("{0}", $_.exitCode)
                 } else {
-                  $PSStyle.Foreground.Yellow
+                  $style = if ($_.exitCode -eq 0) {
+                    $PSStyle.Foreground.White
+                  } else {
+                    $PSStyle.Foreground.Yellow
+                  }
+                  [String]::Format("{0}{1}{2}", $style, $_.exitCode, $PSStyle.Reset)
                 }
-                [String]::Format("{0}{1}{2}", $bg, $_.exitCode, $PSStyle.Reset)
                 </ScriptBlock>
               </TableColumnItem>
               <TableColumnItem>

ChocoLogParse/ChocoLogParse.psm1

@@ -10,6 +10,9 @@
   }
 }
 
+# Initialize module variable for color control (default to colored output)
+$script:ChocoLogNoColor = $false
+
 # Add our custom formatter that needed classes first
 $format = Join-Path -Path $PSScriptRoot -ChildPath 'ChocoLog.format.ps1xml'
 Update-FormatData -PrependPath $format
@@ -23,7 +26,7 @@
   [ChocoLog]
 )
 # Get the internal TypeAccelerators class to use its static methods.
 $TypeAcceleratorsClass = [psobject].Assembly.GetType(
   'System.Management.Automation.TypeAccelerators'
 )
 # Ensure none of the types would clobber an existing type accelerator.

ChocoLogParse/Public/Get-ChocoLogEntry.ps1

@@ -1,6 +1,6 @@
 <#
 .SYNOPSIS
   Grab a single session from the latest log file. Defaults to last exection.
 .DESCRIPTION
   Reads the latest log file and grabs the last session
 .NOTES
@@ -8,7 +8,11 @@
 .EXAMPLE
   Get-ChocoLogEntry
 
   Grabs the laste entry from the latest log
+.EXAMPLE
+  Get-ChocoLogEntry -NoColor
+
+  Grabs the latest entry from the latest log without colored output
 .PARAMETER Report
   This changes the output to be more friendly for reporting
 .PARAMETER Path
@@ -20,6 +24,9 @@
   The log4net pattern layout used to parse the log. It is very unlikely that you
   need to supply this. The code expects pattern names: time, session, level, and
   message.
+.PARAMETER NoColor
+  Disables colored output in the formatter. When specified, the output will be
+  displayed without ANSI color codes.
 #>
 function Get-ChocoLogEntry {
   [CmdletBinding()]
@@ -36,20 +43,21 @@
     $Filter = 'chocolatey*.log',
     [string]
     $PatternLayout = '%date %thread [%-5level] - %message',
-    [switch]$Report
+    [switch]$Report,
+    [switch]$NoColor
   )
   # ToDo:
   # - Support searching for a cli entry
   # - sub command type (e.g. search, list, upgrade)
   # - Exit code
   # - Filter to recent time to make sure we get the right one
 
-  $entry = Read-ChocoLog -FileLimit 1 -Path $Path -Filter $Filter -PatternLayout $PatternLayout | Select-Object -Last 1
+  $entry = Read-ChocoLog -FileLimit 1 -Path $Path -Filter $Filter -PatternLayout $PatternLayout -NoColor:$NoColor | Select-Object -Last 1
   if ($report) {
     # Print out in a format that's useful for Chef logging
     Write-Host ('Command: {0}' -F $entry.cli)
     Write-Host ('Exit Code: {0}' -F $entry.exitCode )
     # This will print out the configuration in a more readble way
     Write-Host "Configuration: `n - "
     $entry.Configuration
 

ChocoLogParse/Public/Read-ChocoLog.ps1

@@ -12,6 +12,10 @@
   Read-ChocoLog
 
   This will read the latest Chocolatey.log on the machine.
+.EXAMPLE
+  Read-ChocoLog -NoColor
+
+  This will read the latest Chocolatey.log on the machine without colored output.
 .PARAMETER Path
   The log path you want to parse. This will default to the latest local log.
   This can be a directory of logs.
@@ -23,6 +27,9 @@
   The log4net pattern layout used to parse the log. It is very unlikely that you
   need to supply this. The code expects pattern names: time, session, level, and
   message.
+.PARAMETER NoColor
+  Disables colored output in the formatter. When specified, the output will be
+  displayed without ANSI color codes.
 #>
 function Read-ChocoLog {
   # This makes PlatyPS sad.
@@ -41,8 +48,14 @@
     [String]
     $Filter = 'chocolatey*.log',
     [string]
-    $PatternLayout = '%date %thread [%-5level] - %message'
+    $PatternLayout = '%date %thread [%-5level] - %message',
+    [switch]
+    $NoColor
   )
+
+  # Set module-level variable to control coloring in formatter
+  $script:ChocoLogNoColor = $NoColor.IsPresent
+
   $files = Get-Item -Path $Path
   if ($files.PSIsContainer) {
     $files = Get-ChildItem -Path $Path -Filter $Filter |
@@ -110,6 +123,6 @@
   }
 
   # Return the whole parsed object
   Write-Verbose "Returning results in desceding order. Count: $($parsed.Count)"
   $parsed.Values | Sort-Object -Descending Time
 }

docs/en-US/Get-ChocoLogEntry.md

@@ -9,12 +9,12 @@
 
 ## SYNOPSIS
 Grab a single session from the latest log file.
 Defaults to last exection.
 
 ## SYNTAX
 
 ```
-Get-ChocoLogEntry [[-Path] <String[]>] [[-Filter] <String>] [[-PatternLayout] <String>] [-Report]
+Get-ChocoLogEntry [[-Path] <String[]>] [[-Filter] <String>] [[-PatternLayout] <String>] [-Report] [-NoColor]
  [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
@@ -28,7 +28,7 @@
 Get-ChocoLogEntry
 ```
 
 Grabs the laste entry from the latest log
 
 ## PARAMETERS
 
@@ -99,13 +99,29 @@
 Accept wildcard characters: False
 ```
 
+### -NoColor
+Disables colored output in the formatter. When specified, the output will be
+displayed without ANSI color codes.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ProgressAction
 {{ Fill ProgressAction Description }}
 
 ```yaml
 Type: ActionPreference
 Parameter Sets: (All)
 Aliases: proga
 
 Required: False
 Position: Named

docs/en-US/Read-ChocoLog.md

@@ -14,7 +14,7 @@ Parses a Chocolatey log into an object that is easier to search and filter.
 
 ```
 Read-ChocoLog [[-Path] <String[]>] [[-FileLimit] <Int32>] [[-Filter] <String>] [[-PatternLayout] <String>]
- [<CommonParameters>]
+ [-NoColor] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -100,6 +100,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -NoColor
+Disables colored output in the formatter. When specified, the output will be
+displayed without ANSI color codes.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+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).
 

requirements.psd1

@@ -9,13 +9,13 @@
         }
     }
     'psake' = @{
-        Version = '4.9.0'
+        Version = '4.9.1'
     }
     'BuildHelpers' = @{
         Version = '2.0.16'
     }
     'PowerShellBuild' = @{
-        Version = '0.6.1'
+        Version = '0.7.3'
     }
     'PSScriptAnalyzer' = @{
         Version = '1.19.1'

tests/ChocoLogParse.tests.ps1

@@ -1,5 +1,8 @@
 # cSpell:ignore BHPS Ffoo Subkeys
 BeforeDiscovery {
+  if ($null -eq $env:BHPSModuleManifest) {
+    .\build.ps1 -Task Init
+  }
   $manifest = Import-PowerShellDataFile -Path $env:BHPSModuleManifest
   $outputDir = Join-Path -Path $env:BHProjectPath -ChildPath 'Output'
   $outputModDir = Join-Path -Path $outputDir -ChildPath $env:BHProjectName
@@ -106,7 +109,7 @@ Describe 'Read-ChocoLog' {
 
   Context 'For Single File' {
     It 'Parses the correct number of sessions' {
-        ($script:parsed).Count | Should -Be 3
+      ($script:parsed).Count | Should -Be 3
     }
 
     It 'Parses the correct number of lines per session' {
@@ -140,7 +143,8 @@ Describe 'Read-ChocoLog' {
     }
 
     It 'Parses the correct number of lines per session' {
-      $script:multiple[0].logs.Count | Should -Be 9
+      $multiLine = $script:multiple | Where-Object { $_.Thread -eq 8748 }
+      $multiLine.logs.Count | Should -Be 9
     }
   }
 }
@@ -153,7 +157,7 @@ Describe 'Get-ChocoLogEntry' {
 
   Context 'For Single File' {
     It 'Parses the correct number of sessions' {
-        ($script:parsedEntry).Count | Should -Be 1
+      ($script:parsedEntry).Count | Should -Be 1
     }
 
     It 'Parses the correct number of lines per session' {