PSWriteColor.psm1
|
function Write-Color { <# .SYNOPSIS Write-Color is a wrapper around Write-Host. It provides: - Easy manipulation of colors, - Logging output to file (log) - Nice formatting options out of the box. .DESCRIPTION Author: przemyslaw.klys at evotec.pl Project website: https://evotec.xyz/hub/scripts/write-color-ps1/ Project support: https://github.com/EvotecIT/PSWriteColor Original idea: Josh (https://stackoverflow.com/users/81769/josh) .EXAMPLE Write-Color -Text "Red ", "Green ", "Yellow " -Color Red,Green,Yellow .EXAMPLE Write-Color -Text "This is text in Green ", "followed by red ", "and then we have Magenta... ", "isn't it fun? ", "Here goes DarkCyan" -Color Green,Red,Magenta,White,DarkCyan .EXAMPLE Write-Color -Text "This is text in Green ", "followed by red ", "and then we have Magenta... ", "isn't it fun? ", "Here goes DarkCyan" -Color Green,Red,Magenta,White,DarkCyan -StartTab 3 -LinesBefore 1 -LinesAfter 1 .EXAMPLE Write-Color "1. ", "Option 1" -Color Yellow, Green Write-Color "2. ", "Option 2" -Color Yellow, Green Write-Color "3. ", "Option 3" -Color Yellow, Green Write-Color "4. ", "Option 4" -Color Yellow, Green Write-Color "9. ", "Press 9 to exit" -Color Yellow, Gray -LinesBefore 1 .EXAMPLE Write-Color -LinesBefore 2 -Text "This little ","message is ", "written to log ", "file as well." ` -Color Yellow, White, Green, Red, Red -LogFile "C:\testing.txt" -TimeFormat "yyyy-MM-dd HH:mm:ss" Write-Color -Text "This can get ","handy if ", "want to display things, and log actions to file ", "at the same time." ` -Color Yellow, White, Green, Red, Red -LogFile "C:\testing.txt" .EXAMPLE # Added in 0.5 Write-Color -T "My text", " is ", "all colorful" -C Yellow, Red, Green -B Green, Green, Yellow wc -t "my text" -c yellow -b green wc -text "my text" -c red .NOTES CHANGELOG Version 0.5 (25th April 2018) ----------- - Added backgroundcolor - Added aliases T/B/C to shorter code - Added alias to function (can be used with "WC") - Fixes to module publishing Version 0.4.0-0.4.9 (25th April 2018) ------------------- - Published as module - Fixed small issues Version 0.31 (20th April 2018) ------------ - Added Try/Catch for Write-Output (might need some additional work) - Small change to parameters Version 0.3 (9th April 2018) ----------- - Added -ShowTime - Added -NoNewLine - Added function description - Changed some formatting Version 0.2 ----------- - Added logging to file Version 0.1 ----------- - First draft Additional Notes: - TimeFormat https://msdn.microsoft.com/en-us/library/8kb3ddd4.aspx #> [alias('Write-Colour')] [CmdletBinding()] param ( [alias ('T')] [String[]]$Text, [alias ('C', 'ForegroundColor', 'FGC')] [ConsoleColor[]]$Color = [ConsoleColor]::White, [alias ('B', 'BGC')] [ConsoleColor[]]$BackGroundColor = $null, [alias ('Indent')][int] $StartTab = 0, [int] $LinesBefore = 0, [int] $LinesAfter = 0, [int] $StartSpaces = 0, [alias ('L')] [string] $LogFile = '', [Alias('DateFormat', 'TimeFormat')][string] $DateTimeFormat = 'yyyy-MM-dd HH:mm:ss', [alias ('LogTimeStamp')][bool] $LogTime = $true, [ValidateSet('unknown', 'string', 'unicode', 'bigendianunicode', 'utf8', 'utf7', 'utf32', 'ascii', 'default', 'oem')][string]$Encoding = 'Unicode', [switch] $ShowTime, [switch] $NoNewLine ) $DefaultColor = $Color[0] if ($null -ne $BackGroundColor -and $BackGroundColor.Count -ne $Color.Count) { Write-Error "Colors, BackGroundColors parameters count doesn't match. Terminated." ; return } #if ($Text.Count -eq 0) { return } if ($LinesBefore -ne 0) { for ($i = 0; $i -lt $LinesBefore; $i++) { Write-Host -Object "`n" -NoNewline } } # Add empty line before if ($StartTab -ne 0) { for ($i = 0; $i -lt $StartTab; $i++) { Write-Host -Object "`t" -NoNewLine } } # Add TABS before text if ($StartSpaces -ne 0) { for ($i = 0; $i -lt $StartSpaces; $i++) { Write-Host -Object ' ' -NoNewLine } } # Add SPACES before text if ($ShowTime) { Write-Host -Object "[$([datetime]::Now.ToString($DateTimeFormat))]" -NoNewline} # Add Time before output if ($Text.Count -ne 0) { if ($Color.Count -ge $Text.Count) { # the real deal coloring if ($null -eq $BackGroundColor) { for ($i = 0; $i -lt $Text.Length; $i++) { Write-Host -Object $Text[$i] -ForegroundColor $Color[$i] -NoNewLine } } else { for ($i = 0; $i -lt $Text.Length; $i++) { Write-Host -Object $Text[$i] -ForegroundColor $Color[$i] -BackgroundColor $BackGroundColor[$i] -NoNewLine } } } else { if ($null -eq $BackGroundColor) { for ($i = 0; $i -lt $Color.Length ; $i++) { Write-Host -Object $Text[$i] -ForegroundColor $Color[$i] -NoNewLine } for ($i = $Color.Length; $i -lt $Text.Length; $i++) { Write-Host -Object $Text[$i] -ForegroundColor $DefaultColor -NoNewLine } } else { for ($i = 0; $i -lt $Color.Length ; $i++) { Write-Host -Object $Text[$i] -ForegroundColor $Color[$i] -BackgroundColor $BackGroundColor[$i] -NoNewLine } for ($i = $Color.Length; $i -lt $Text.Length; $i++) { Write-Host -Object $Text[$i] -ForegroundColor $DefaultColor -BackgroundColor $BackGroundColor[0] -NoNewLine } } } } if ($NoNewLine -eq $true) { Write-Host -NoNewline } else { Write-Host } # Support for no new line if ($LinesAfter -ne 0) { for ($i = 0; $i -lt $LinesAfter; $i++) { Write-Host -Object "`n" -NoNewline } } # Add empty line after if ($Text.Count -ne 0 -and $LogFile -ne "") { # Save to file $TextToFile = "" for ($i = 0; $i -lt $Text.Length; $i++) { $TextToFile += $Text[$i] } try { if ($LogTime) { Write-Output -InputObject "[$([datetime]::Now.ToString($DateTimeFormat))]$TextToFile" | Out-File -FilePath $LogFile -Encoding $Encoding -Append } else { Write-Output -InputObject "$TextToFile" | Out-File -FilePath $LogFile -Encoding $Encoding -Append } } catch { $_.Exception } } } function Write-ColorDev { [CmdletBinding()] param( [Parameter(Position = 0, Mandatory, ValueFromPipeline)] [Alias('Text')] [string[]] $Message, [Alias('Color', 'FGC')] [ConsoleColor[]] $ForegroundColor = 'White', [Alias('BGC')] [ConsoleColor[]] $BackgroundColor, [Alias('StartTab')] [ValidateRange(0, 5)] [int] $Indent = 0, [Alias('LinesBefore')] [ValidateRange(0, 10)] [int] $LeadingSpace = 0, [Alias('LinesAfter')] [ValidateRange(0, 10)] [int] $TrailingSpace = 0, [Alias('File', 'L')] [ValidateScript( { Test-Path -IsValid $_ })] [string] $LogFile, [Alias('DateFormat', 'TimeFormat')] [string] $DateTimeFormat = "yyyy-MM-dd HH:mm:ss", [Alias('LTS')] [switch] $NoLogTimestamp, [Alias('Encoding')] [System.Text.Encoding] $OutputEncoding = [System.Text.Encoding]::UTF8, [switch] $ShowTime, [switch] $NoNewLine ) begin { if ($PSBoundParameters.ContainsKey('LogFile')) { $StringBuilder = [System.Text.StringBuilder]::new() } $InvalidParams = ($BackgroundColor.Count -gt 0 -and $BackgroundColor.Count -ne $ForegroundColor.Count) -or $ForegroundColor.Count -gt $Message.Count -or $BackgroundColor.Count -gt $Message.Count if ($InvalidParams) { $ErrorRecord = [System.Management.Automation.ErrorRecord]::new( [System.Management.Automation.ParameterBindingException]::new( 'The number of provided Foreground and Background colors does not match, or more colors were provided than entered messages.' ), 'InvalidColorMapping', # ErrorID [System.Management.Automation.ErrorCategory]::InvalidArgument, # Category $null # Target ) $PSCmdlet.ThrowTerminatingError($ErrorRecord) } # Add leading lines Write-Host ("`n" * $LeadingSpace) @BaseParams if ($ShowTime) { # Add Time before output Write-Host ('[{0}]' -f [datetime]::Now.ToString($DateTimeFormat)) @BaseParams } } process { # Add TABS before text Write-Host ("`t" * $Indent) @BaseParams if ($PSBoundParameters.ContainsKey('ForegroundColor') -or $PSBoundParameters.ContainsKey('BackgroundColor')) { # Fallback defaults if one of the values isn't set $LastForegroundColor = [console]::ForegroundColor $LastForegroundColor = [console]::BackgroundColor # The real deal coloring for ($i = 0; $i -lt $Message.Count; $i++) { $CurrentFGColor = if ($ForegroundColor[$i]) { $ForegroundColor[$i] } else { $LastForegroundColor } $CurrentBGColor = if ($BackgroundColor[$i]) { $BackgroundColor[$i] } else { $LastBackgroundColor } $WriteParams = @{ NoNewLine = $true ForegroundColor = $CurrentFGColor BackgroundColor = $CurrentBGColor } Write-Host $Message[$i] @WriteParams if ($PSBoundParameters.ContainsKey('LogFile')) { $StringBuilder.Append($Message[$i]) > $null } # Store last color set, in case next iteration doesn't have a set color $LastForegroundColor, $LastBackgroundColor = $CurrentFGColor, $CurrentBGColor } } else { Write-Host $Message -NoNewline } if (-not $NoNewLine) { Write-Host } Write-Host ("`n" * $TrailingSpace) # Add empty line after } end { if ($PSBoundParameters.ContainsKey('LogFile')) { # Save to file try { if ($NoLogTimestamp) { $StringBuilder.ToString() | Add-Content -Path $LogFile -Encoding $OutputEncoding } else { "[{0}]{1}" -f [datetime]::Now.ToString($DateTimeFormat), $StringBuilder.ToString() | Add-Content -Path $LogFile -Encoding $OutputEncoding } } catch { $PSCmdlet.WriteError($_) } } } } Export-ModuleMember ` -Function @('Write-Color','Write-ColorDev') ` -Alias @('Write-Colour') |