Tool/Tool.ps1

#region Copyright & License

# Copyright © 2019 - 2021 François Chabot
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#endregion

Set-StrictMode -Version Latest

# inspired by https://github.com/nightroman/Invoke-Build/blob/2ebb4c4ca5c9d15cd11e48f640763007d7a3b7f1/Invoke-Build.ps1#L272
function Add-ToolAlias {
    [CmdletBinding()]
    [OutputType([void])]
    param (
        [Parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string]
        $Path,

        [Parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string[]]
        $Tool,

        [Parameter(Mandatory = $false)]
        [ValidateSet('Global', 'Local')]
        [string]
        $Scope = 'Local'
    )
    Resolve-ActionPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState
    $expandedPath = switch -regex ($Path) {
        ^Framework { "$env:windir\Microsoft.NET\$_" }
        default { $PSCmdlet.GetUnresolvedProviderPathFromPSPath($_) }
    }
    if (-not(Test-Path -LiteralPath $expandedPath -PathType Container)) { throw "Cannot resolve '$Path'." }
    $Tool | ForEach-Object -Process {
        $toolPath = Join-Path -Path $expandedPath -ChildPath "$_.exe" -Resolve
        # add alias in parent scope only, i.e. caller's scope, https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_scopes?view=powershell-7#managing-scope
        Set-Alias -Name $_ -Value $toolPath `
            -Scope $(if ($Scope -eq 'Local') { 1 } else { $Scope }) `
            -Verbose:($PSBoundParameters['Verbose'] -eq $true)
    }
}

function Invoke-Tool {
    [CmdletBinding()]
    [OutputType([void])]
    param (
        [Parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [scriptblock]
        $Command,

        [Parameter(Mandatory = $false)]
        [ValidateNotNullOrEmpty()]
        [scriptblock]
        $ThrowUnless = $null
    )
    Resolve-ActionPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState
    & $Command | Tee-Object -Variable output
    if ($LASTEXITCODE -ne 0 -and ($ThrowUnless -eq $null -or ($output | Where-Object -FilterScript $ThrowUnless | Test-None))) {
        throw "Command {$Command} failed with exit code $LASTEXITCODE."
    }
}

# SIG # Begin signature block
# MIII0QYJKoZIhvcNAQcCoIIIwjCCCL4CAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQULRMj7nRj50KOvmq1aDmHnqSw
# LDOgggVMMIIFSDCCAzCgAwIBAgIJAJkr3mJdTBkUMA0GCSqGSIb3DQEBCwUAMEEx
# PzA9BgNVBAMeNgBpAGMAcgBhAGYAdABzAG8AZgB0AHcAYQByAGUAQABzAHQAYQB0
# AGUAbABlAHMAcwAuAGIAZTAeFw0yMTA2MjUxNDEyMjNaFw00MTA2MjAxNDEyMjNa
# MEExPzA9BgNVBAMeNgBpAGMAcgBhAGYAdABzAG8AZgB0AHcAYQByAGUAQABzAHQA
# YQB0AGUAbABlAHMAcwAuAGIAZTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoC
# ggIBAOeqdUHBv7sxSeX3aj6yPKj7PAvs8izpVXjyEBl5aR8mQneVcXuF53AH7EW1
# 6E5p4+Az5pJPGUD5c3tXhiGMF7vgLhQjO6hlaVBRIqiIYHikNLwMNy6YBMc/QQYM
# rPhqHEFsZ53dkBIIj3M8e3kFcTFA09n25yDtTPDab4nd9yUhc9Qc8+nfpIzfYsoP
# 1pZ3nCzhw6hN2/44v1dkQrG3dRYwt+px65p6NPNZWEJpt4VCJjIFh+lBYJdxm9d4
# X/rAnlHIkbv7liOavWDzgHVabS3hdAWtcDmynm+7+FcZDFqPWNCl3e4SS7xe4s/R
# CKFKA0IsfKkSk9YJlLgeSQIEXUOOWXJAGaLqnRD8xWLZsc4Oi9GZg7XV1mv/S88c
# oztXnwtAN3OOlRKBh2QbomMgxeMO0GvsLE/cq5Q/YKAoz+KGr/7LcZq9jzQ8IPus
# ZvWLeDXmxPiwJjpZc1koLgfGIEX2NStQTT3QmacWr9thrWcKvI+4uBmI4exS9B4a
# R3nV91w5EY+2RoYsHqej9LWwNamO96+jMX9pxprTX+EkLUuMAikw/po8sBC9MUUn
# 5pMWmUv7DCtQOLGGBDDMMMkn4ZcjpCEEdPGHRKfqNnD27ssGtDjiNzfQrsm67toU
# bBwUF+gyJq/YckWquYJhA9ZOFWEADuIwGnsOzsoRvuQyY+p9AgMBAAGjQzBBMA4G
# A1UdDwEB/wQEAwIHgDAWBgNVHSUBAf8EDDAKBggrBgEFBQcDAzAXBgNVHREEEDAO
# ggxzdGF0ZWxlc3MuYmUwDQYJKoZIhvcNAQELBQADggIBACithYM3qckZRc9+Xbfu
# a6gWr3HwjrW+FHKgjfrcOm8ZnLVapb9xFqsqrRQqd3RXWQDINEGrtI2rSfrzyfoK
# UiTgldIfQNP1ZcGY229d++90t3hdo2mlt05hjYlbMENloJHpsEP0vQZmwOcEimCT
# ex1pymYM+P9pj3j8UD1PT1eIZot6or8fBRl63UybyDSrM7L4UOkkAOniKxWy5pW6
# 6duS8SR+SZpr3Bv44NyXPj0Nv+MIpLmsLrd7XPBFmnGxzY01ZO9vzi9KEhM2wT5i
# jPqHDNOvfPiADtAa+EyUBzdJiqy9heCz/TMZQgMWGwtfqJNxWZmsHcha2anW4Qt+
# mzrLO4GojWoVog9uVSAq+l0a+YQsd1u1kUmm4vgZCFyUA+lEp4LkI7ca2VBHkLPD
# w+u2DoDMRiqFPZjO7BCKjGc0jj9B/qGR3JVt+tqDdB621xXf2YGF2oFvxZQ/keGt
# 0ujfJ+JwN3nCulDAA4773q6KUnfykyrvAgITNbRJL6TngeRKtw9VIJBPxzqMzLpV
# 5ggXNituwLaD1CCBJ1oo9DZHpL9gplXp1wGrelJOTiJhh+pdNsPtRH7CrranWa5h
# LFLuigqin0eewQ5giJ1VaiBVEseOmiZog+27UpFIv40aDzgGL3YxB/Mu0ojwrQtp
# WLmqJCmWnR5qxOm0yK+zNWe0MYIC7zCCAusCAQEwTjBBMT8wPQYDVQQDHjYAaQBj
# AHIAYQBmAHQAcwBvAGYAdAB3AGEAcgBlAEAAcwB0AGEAdABlAGwAZQBzAHMALgBi
# AGUCCQCZK95iXUwZFDAJBgUrDgMCGgUAoHgwGAYKKwYBBAGCNwIBDDEKMAigAoAA
# oQKAADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgorBgEEAYI3AgELMQ4w
# DAYKKwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQUqSReXBsw4AACtCsz15ub71Oj
# SBQwDQYJKoZIhvcNAQEBBQAEggIAIGnLl5/lnFxqbgItAJgV4boR0Dl7Vw7FR4oc
# HtY3pT4/QcMzywj94VFsyP0kZc5a01UjgFqkkO19ZHwb1THLWM6x7FbzakFsqcJa
# SV/iOi/tR7dwifsl+CGB5tM54LrTkvbSndHxNbeFIcYf30/5oI+FYtzmOkeJ1gqN
# 5Nngjv57Nvvwc3uhe/E31nWEDKjkkxvRruAA/iy7J04CbalBAC5gxojDFYCUzX0Z
# FBgLlkCPXnkXF1hLoL+xYUiNEhQbjcUfjO6xbuj7ivxoBkOq1iU3kHU/MJGBBcDU
# Y2TwdlTtEOntzwrt5Wz4znnR5Lr6LU5w0/ZujkQvir2R9i4kq3bHkjZuZHEVnPGs
# MLaeuAgdNUjM0YSJkwqYX8Gigb6mu/7ho3zi35CuAGjAwIZsWfnSTt9yfB/2NCCm
# Rg5wgZPMfN05CdMf5Y27mi+a+2cAQKgVvXLrcyxJDBX8d22tvefZ2QCS1vDznZz8
# KGqOzjltMK4Zw6cCaVyPU1/MtZeziZ4U3x1MhPNEQ0XWt66JvEZHefktS/1/LMMn
# 6o+YN2mjfxmTZv1TEndllwvLla8APoOzYaKVU/SgIPUPboAQjCSL4iNkA8r8r+Fe
# HgW1j5bKDB+28YLt/P+uDk4ZmrwVDSGAoQrPWFlvTT4wXJnczxld6GwPmnZJA/y7
# c6dDFIw=
# SIG # End signature block