Write-LogMessage

Write-LogMessage.ps1

function Write-LogMessage{
    [CmdletBinding()]
    param (
        [Parameter()]
        [string] $Message,

        [Parameter()]
        [string] $LogType = 'Info'
    )

    # use the built-in variable MyInvocation to get information about the calling script and the line number where it is called
    $thisInvocation = (Get-Variable -Name 'MyInvocation' -Scope 1).Value
    $callingScript = Split-Path -Leaf $thisInvocation.ScriptName
    $scriptLineNumber = $thisInvocation.ScriptLineNumber

    # Getting the PowerShell call stack to determine the "nearest" caller
    # Use skipStackLevels to offset the first levels if used in a main function of module
    $skipStackLevels = 2
    $thisCallStack = (Get-PSCallStack)
    $nearestCaller = $thisCallStack[(0+$skipStackLevels)]

    # if the nearest caller and the calling script is the same, there is no need to write it twice
    if ($nearestCaller.Command -eq $callingScript) {
        $logMessage = "[$($callingScript):$($scriptLineNumber)] $($LogType.ToUpper()) $Message"
    } else {
        # here we are including the "actual" script line number for where the function was called in the script
        $actualScriptLineNumber = $nearestCaller.InvocationInfo.ScriptLineNumber
        $logMessage = "[$($callingScript):$($actualScriptLineNumber) > $($nearestCaller.FunctionName):$($scriptLineNumber)] $($LogType.ToUpper()) $Message"
    }

    Write-Output $logMessage

}