首页 > 解决方案 > 使用格式运算符的 Powershell 颜色格式

问题描述

我在带有以下示例的脚本中使用格式运算符:

$current = 1
$total   = 1250
$userCN  = "contoso.com/CONTOSO/Users/Adam Smith"

"{0, -35}: {1}" -f "SUCCESS: Updated user $current/$total", $userCN

这预计会显示以下输出:

SUCCESS: Updated user 1/1250 : contoso.com/CONTOSO/Users/Adam Smith

格式运算符用于将目标输出文本保留在适当的位置,当前/总运行数在 1-99999 之间变化。如果没有格式运算符,我可以像这样突出显示成功线:

Write-Host -BackgroundColor Black -ForegroundColor Green "SUCCESS: Updated user $current/$total: $userCN"

但问题是如何将高亮颜色与格式运算符结合使用?只有-f参数,它不允许使用颜色参数,因为它与一开始就不一样Write-Host了。

标签: powershellsyntaxparameter-passing

解决方案


与其他 shell 不同,PowerShell 允许您将命令和表达式作为命令参数传递,只需将它们括在括号中(...),即使用分组运算符

调用PowerShell命令(cmdlet、脚本、函数)时,输出按原样作为参数传递,作为其原始输出类型。

因此,Theo的评论解决方案是正确的:

Write-Host -BackgroundColor Black -ForegroundColor Green `
           ("{0, -35}: {1}" -f "SUCCESS: Updated user $current/$total", $userCN) 

也就是说,-f内部的表达式(...)被执行,它的输出——在这种情况下是一个字符串——作为位置参数传递给Write-Host(隐式绑定到-Object参数)。


请注意,在这种情况下您不需要$(...)表达式运算符:

(...)足以包含表达式或命令。

事实上,在某些情况下$(...)可能会无意中修改你的论点,因为它的行为就像管道;也就是说,它将数组表达式枚举并重建为常规 PowerShell 数组(可能会丢失强类型)并解包单元素数组

# Pass a single-element array to a script block (which acts like a function).
# (...) preserves the array as-is.
PS> & { param($array) $array.GetType().Name } -array ([array] 1)
Object[]  # OK - single-element array was passed as-is

# $(...) unwraps it.
PS> & { param($array) $array.GetType().Name } -array $([array] 1)
Int32  # !! Single-element array was unwrapped.

# Strongly-typed array example:
PS> & { param($array) $array.GetType().Name } ([int[]] (1..10))
Int32[] # OK - strongly typed array was passed as-is.

# Strongly-typed array example:
PS> & { param($array) $array.GetType().Name } $([int[]] (1..10))
Object[] # !! Array was *enumerated and *rebuilt* as regular PowerShell array.

主要用途$(...)是:

  • 扩展可扩展字符串的表达式或命令的输出 (字符串插值)

  • 在预先收集输出之后(也可以),直接通过管道发送复合语句(例如and或多个语句)的输出;但是,您也可以包装这些语句(或直接在调用者的作用域而不是子作用域中执行),以便在管道中获得通常的流式传输行为(输出的逐个传递)。foreach (...) { ... }if (...) { ... }(...)& { ... }. { ... }

    • 退后一步:鉴于您已经可以在变量赋值中使用复合语句作为表达式- 例如$evenNums = foreach ($num in 1..3) { $num * 2 }- 并且表达式通常被接受为管道的第一段 - 例如'hi' | Write-Host -Fore Yellow- 令人惊讶的是,目前这不适用于复合陈述;这个 GitHub 问题询问是否可以取消此限制。

在将参数传递给命令的上下文中:

  • 仅当$(...) 您想将多个命令或(一个或多个)复合语句的输出作为参数传递时,才使用表达式运算符和/或,如果输出恰好是单个对象,您希望该对象用作- is 或者,如果它恰好是一个单元素数组(可枚举),你希望它被解包(传递元素本身,而不是数组。

    • 当然,如果您正在构建一个字符串参数,$(...)则可以在该 string 内部用于字符串插值 - 例如,Write-Host "1 + 1 = $(1 + 1)"
  • 仅当@(...) 您想将多个命令的输出作为参数传递和/或您想确保输出变成一个数组时,才使用数组子表达式运算符;也就是说,输出作为(常规 PowerShell)数组返回,类型为[object[]],即使它恰好只包含一个对象。从某种意义上说,它与' 在单对象输出情况下的行为相反$(...):它确保单对象输出也变成一个数组。


推荐阅读