Tool/Tool.ps1

#region Copyright & License

# Copyright © 2019 - 2022 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',

      [Parameter(Mandatory = $false)]
      [switch]
      $Force
   )
   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 -Option ReadOnly -Name $_ -Value $toolPath `
         -Scope $(if ($Scope -eq 'Local') { 1 } else { $Scope }) `
         -Force:$Force `
         -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
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU9VfIYS5L4lRWjE1J2tColegQ
# I6ygggVMMIIFSDCCAzCgAwIBAgIJAJkr3mJdTBkUMA0GCSqGSIb3DQEBCwUAMEEx
# 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
# DAYKKwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQUhILznYzJWV11GUTCaYC94KJ7
# FikwDQYJKoZIhvcNAQEBBQAEggIAqC143wC/aot+XhR0vwXi99seWqHkLTIZuQF+
# jWERm7OwKS9fUbdSZrf6Tu9jYaEl3DoUZqMbDE2OFjBxoraGHYlq1yfYKaGg7LG9
# vDnDeRpxH/cbIu7yfLzx7IsyWu8bB9F/53+1XwampKMBUXe2qFziNN8mQWzbj/pT
# Z8HQ6BIhoIy7PRJDj0UhCYOJuyIGQfMTRboZKdbCHd3kqeWL4X2/jJYXRK07a5tN
# twLMLnkHEdELgrgopQov37ryz6YW/7aafRaQuBwSl3h0GUiqLw491OkgmuoSZQZf
# S6MNy1IXhQzWp7FFI2oYgtn6uNE9OWyldq8Y+wfLhchvRfgh0t5mP/s2gizeyG0D
# nBljhjP6jYd2z8uzGWboHWKpk4FWagSMNziXn7MiFFfoPmLXWIpTyq2lGATzOakj
# W4/YECJX+ZrB3z4obQoOUy5bBHlkhV7ne0wDVYNkowmDAv7q6G6y5L63JRK1zov4
# x7++WQfoxmDK+WDBelgtsHNXpoyFv366+mL9ames3mgauiOKhTEHBrzsy1oxW22D
# aVwFOn9snKmgpZLT9CeBAs1rVt5RymDvrIEnHMgZNOQbEl4RPOqtGtFv52IKBt/C
# MWk1ya5v+VCZnPgL3qXL2WOD2cRgMZHhH62qfy+RqHmGlSCMFWBwSkJ4PA/OZahh
# ywdx84k=
# SIG # End signature block