RichWrite

1.1

Public/Enable-RichWrite.ps1

<#
.Synopsis
   Short description
.DESCRIPTION
   Import and overwrite enhanced versions of
   - Write-Host
   - Write-Debug
   - Write-Verbose
   - Write-Information
   - Write-Warning
.EXAMPLE
   Enable-RichWrite -ForAll
.EXAMPLE
   Enable-RichWrite -ForDebug -ForVerbose -ForInformation -ForWarning -ForHost
.EXAMPLE
   Enable-RichWrite -ForAll -Caller -Date -Time
.EXAMPLE
   Enable-RichWrite -ForAll -Format "%caller% %date% %time%"
. Link
   https://www.powershellgallery.com/packages/Disable-RichWrite
#>
function Enable-RichWrite 
{
    [CmdletBinding(SupportsShouldProcess=$true)]
    Param(
        [Parameter(Mandatory=$false,ParameterSetName="Per level - Column format")]
        [Parameter(Mandatory=$false,ParameterSetName="Per level - Custom format")]
        [switch]$For=$false,
        [Parameter(Mandatory=$false,ParameterSetName="Per level - Column format")]
        [Parameter(Mandatory=$false,ParameterSetName="Per level - Custom format")]
        [switch]$ForVerbose=$false,
        [Parameter(Mandatory=$false,ParameterSetName="Per level - Column format")]
        [Parameter(Mandatory=$false,ParameterSetName="Per level - Custom format")]
        [switch]$ForInformation=$false,
        [Parameter(Mandatory=$false,ParameterSetName="Per level - Column format")]
        [Parameter(Mandatory=$false,ParameterSetName="Per level - Custom format")]
        [switch]$ForWarning=$false,
        [Parameter(Mandatory=$false,ParameterSetName="Per level - Column format")]
        [Parameter(Mandatory=$false,ParameterSetName="Per level - Custom format")]
        [switch]$ForHost=$false,
        [Parameter(Mandatory=$true,ParameterSetName="All - Column format")]
        [Parameter(Mandatory=$true,ParameterSetName="All - Custom format")]
        [switch]$ForAll,
        [Parameter(Mandatory=$false,ParameterSetName="All - Column format")]
        [switch]$Caller=$false,
        [Parameter(Mandatory=$false,ParameterSetName="All - Column format")]
        [switch]$Date=$false,
        [Parameter(Mandatory=$false,ParameterSetName="All - Column format")]
        [switch]$Time=$false,
        [Parameter(Mandatory=$false,ParameterSetName="All - Column format")]
        [String]$Separator=": ",
        [Parameter(Mandatory=$true,ParameterSetName="All")]
        [Parameter(Mandatory=$true,ParameterSetName="All - Custom format")]
        [string]$Format
    )
    begin {
        Disable-RichWrite

        $parameterSetName=$PSCmdlet.ParameterSetName
        Microsoft.PowerShell.Utility\Write-Debug "parameterSetName=$parameterSetName"

        #region Define format

        switch($PSCmdlet.ParameterSetName)
        {
            {$_ -like '*Column format'} {
                $prefix=@()
                if(-not ($Caller -or $TimeStamp))
                {
                    $prefix+='$($callerName)'
                }
        
                if($Caller)
                {
                    $prefix+='$($callerName)'
                }
                if($Date)
                {
                    $prefix+='$($dateStamp)'
                }
                if($Time)
                {
                    $prefix+='$($timeStamp)'
                }
                $prefix=$prefix -join $Separator
                $prefix+=$Separator
            }
            {$_ -like '*Custom format'} {
                $prefix=$Format.Replace("%caller%",'$($callerName)').Replace("%date%",'$($dateStamp)').Replace("%time%",'$($timeStamp)')
            }
        }

        Microsoft.PowerShell.Utility\Write-Debug "prefix=$prefix"

        Set-Variable -Name "RichWrite:Prefix" -Value $prefix -Scope Global
        #Get-Variable -Name "RichWrite:Prefix" -Scope Global -ValueOnly
        #endregion
        #region Injection fragments

        $injections=@{
            'Write-Host'=@{
                Begin=@'
        #region Begin step injection
 
        $callerName=(Get-PSCallStack)[1].Command
        $dateStamp=Get-Date -Format "yyyyMMdd"
        $timeStamp=Get-Date -Format "hh:mm:ss.fff"
        # $callerParameterSetName=$null
        $prefix=Get-Variable -Name "RichWrite:Prefix" -Scope Global -ValueOnly
        $prefix=$ExecutionContext.InvokeCommand.ExpandString($prefix)
 
        $PSBoundParameters.Object=$prefix+$PSBoundParameters.Object
 
        #endregion
'@
            }
            'Write-Debug'=@{
                Begin=@'
        #region Begin step injection
 
        $callerName=(Get-PSCallStack)[1].Command
        $dateStamp=Get-Date -Format "yyyyMMdd"
        $timeStamp=Get-Date -Format "hh:mm:ss.fff"
        # $callerParameterSetName=$null
        $prefix=Get-Variable -Name "RichWrite:Prefix" -Scope Global -ValueOnly
        $prefix=$ExecutionContext.InvokeCommand.ExpandString($prefix)
 
        $PSBoundParameters.Message=$prefix+$PSBoundParameters.Message
 
        #endregion
'@
            }
            'Write-Information'=@{
                Begin=@'
        #region Begin step injection
 
        $callerName=(Get-PSCallStack)[1].Command
        $dateStamp=Get-Date -Format "yyyyMMdd"
        $timeStamp=Get-Date -Format "hh:mm:ss.fff"
        # $callerParameterSetName=$null
        $prefix=Get-Variable -Name "RichWrite:Prefix" -Scope Global -ValueOnly
        $prefix=$ExecutionContext.InvokeCommand.ExpandString($prefix)
 
        $PSBoundParameters.MessageData=$prefix+$PSBoundParameters.MessageData
     
        #endregion
'@
            }
        }

        $injections["Write-Verbose"]=$injections["Write-Debug"]
        $injections["Write-Warning"]=$injections["Write-Debug"]


        #endregion

        #region command names to overwrite

        switch($PSCmdlet.ParameterSetName)
        {
            {$_ -like 'All*'} {
                $ForDebug=$true
                $ForVerbose=$true
                $ForInformation=$true
                $ForWarning=$true
                $ForHost=$true
            }
        }

        $cmdNames=@(
        )

        if($ForDebug)
        {
            $cmdNames+="Write-Debug"
        }
        if($ForVerbose)
        {
            $cmdNames+="Write-Verbose"
        }
        if($ForInformation)
        {
            if($PSVersionTable.PSVersion.Major -ge 5)
            {
                $cmdNames+="Write-Information"
            }
            else
            {
                Microsoft.PowerShell.Utility\Write-Warning "Write-Information is not available on PowerShell version $($PSVersionTable.PSVersion)"
            }
        }
        if($ForWarning)
        {
            $cmdNames+="Write-Warning"
        }
        if($ForHost)
        {
            $cmdNames+="Write-Host"
        }

        #endregion
    }

    process {
        
        #region Build bodies

        foreach($name in $cmdNames)
        {
            Microsoft.PowerShell.Utility\Write-Debug "name=$name"
            $originalCommand=Get-Command -Name "Microsoft.PowerShell.Utility\$name"
            $metaData = New-Object -TypeName 'System.Management.Automation.CommandMetaData' -ArgumentList $originalCommand

            $proxyLines = [System.Management.Automation.ProxyCommand]::Create($metaData) -split [System.Environment]::NewLine
        
            $enhancedProxyLines=@()

            $stepName=""
            $insideTryBlock=$false

            foreach($proxyLine in $proxyLines)
            {
                switch ($proxyLine)
                {
                    'begin' {
                        $stepName="begin"
                    }
                    'process' {
                        $stepName="process"
                    }
                    'end' {
                        $stepName="end"
                    }
                    {$_ -like '*try* {'} {
                        $insideTryBlock=$true
                    }
                    Default {}
                }

                $enhancedProxyLines+=$proxyLine

                if($insideTryBlock)
                {
                    if($injections[$name][$stepName])
                    {
                        $enhancedProxyLines+=""
                        $enhancedProxyLines+=$injections[$name][$stepName] -split [Environment]::NewLine
                        $enhancedProxyLines+=""
                    }
                    $stepName=""
                    $insideTryBlock=$false
                }

            }
            $enhancedCmdImplementation=@"
 
        function global:$name {
 
        $($enhancedProxyLines -join [System.Environment]::NewLine)
 
        }
 
"@

            Microsoft.PowerShell.Utility\Write-Debug "Implementation for $name"
            Microsoft.PowerShell.Utility\Write-Debug $enhancedCmdImplementation

            if($PSCmdlet.ShouldProcess("Microsoft.PowerShell.Utility\$name","Overwrite with enhanced version."))
            {
                $enhancedCmdImplementation|Invoke-Expression
            }
        }

        #endregion
    }

    end {

    }
}