周五乐趣：使用 PowerShell 倒计时活动

我们刚刚成功举办了一场非常成功的 PowerShell+DevOps 全球峰会虚拟版。我们因疫情而错过了 2020 年活动，但幸运的是，DevOps Collective 的人们能够举办一场精彩的虚拟活动。虚拟与会者的数量与我们通常参加现场活动的人数一样多。当然，我们都期待着明年我们能够再次相聚。明年的活动将于 2022 年 4 月 25 日至 28 日在华盛顿州贝尔维尤举行。

今年 11 月还将在纳什维尔举办自动化 + DevOps 峰会。所以有一些事情值得期待。鉴于此，我认为有一个 PowerShell 工具来帮助我倒计时会很方便。也许还能教一些东西。让我们玩得开心吧。

时间跨度

创建两个日期之间的时间跨度并不那么困难。

New-TimeSpan -Start (Get-Date) -End ([datetime]"1/1/2022")

结果是一个时间跨度对象。运行代码亲自看看。顺便说一句，您也可以简单地减去日期。

([datetime]"1/1/2022") - (Get-Date)

了解距离下一次 PowerShell 峰会还有多久并不难。

创建工具

这是一个好的开始，但如果能使其更易于使用就更好了。因此，我构建了一个名为 Get-EventCountdown 的小型 PowerShell 函数。当然，它需要一个日期时间值。

  Param(
        [Parameter(Position=0,Mandatory,ValueFromPipeline,ValueFromPipelineByPropertyName,HelpMessage = "Enter the event date and time.")]
        [ValidateNotNullOrEmpty()]
        [ValidateScript({
            if ($_ -ge (Get-Date)) {
                $True
            }
            else {
                Write-Warning "The specified events date has already occurred."
                Throw "You must specify a future datetime."
                $false
            }
        })]
        [alias("Date")]
        [datetime]$EventDate,

我希望能够接受管道输入。我的计划是保留即将发生的事件的 CSV 文件，我可以将其导入并通过管道传输到该函数。另请注意自定义 [ValidateScript()] 属性。这是我在今年的 PowerShell 峰会上的演讲中谈到的内容。

脚本块必须产生 True 或 False 值。如果 $EventDate 值大于或等于现在，换句话说它已经发生，那么 PowerShell 将写入一条警告消息并抛出一条自定义异常消息。如果我想要一些不那么“嘈杂”的东西，我也可以在函数中完成此验证。

创建时间跨度非常简单。

$ts = New-Timespan -Start (Get-Date) -End $EventDate

现在，我可以返回这个值并称之为良好。但为什么要错过向管道写入丰富对象的机会呢？我的函数还采用事件名称参数并构建自定义对象。

[PSCustomObject]@{
    PSTypename = "PSCountdown"
    EventName = $EventName.Trim()
    EventDate = $EventDate
    Countdown = $ts
}

函数参数具有别名，以使命令更容易在控制台上使用。如果传入对象具有名为“Date”而不是“EventDate”的属性，它们也将起作用。这给了我灵活性。

CSV 文件标题为“日期”和“名称”。

利用对象

我本可以就此打住，但如果你了解我，你就知道这不会发生。因为我正在向管道写入丰富的对象，所以我想利用它。为此，您需要确保输出是具有唯一名称的类型化对象，而不是通用 pscustomobject。这就是为什么我的哈希表有一个 TypeName 条目。这成为我的类型名称。

这个特定的对象没有很多属性，我不介意显示所有属性。在其他情况下，我可能会向管道写入非常丰富的对象。这就是自定义类型和格式扩展的用武之地。我也将在这里这样做。

我使用 PSScriptTools 模块中的 New-PSFormatXML 命令创建了一个自定义格式文件，默认显示表中的所有属性。在脚本文件中，我添加它来加载文件。

Update-Formatdata $PSScriptRoot\pscountdown.format.ps1xml

自定义格式

现在是有趣的部分。 Timespan 对象包含毫秒部分。 PowerShell 自动将 Timeppan 对象转换为字符串以将其显示在屏幕上。但我不需要看到毫秒。在自定义格式文件中，我可以创建一个脚本块来格式化 Countdown 属性。

$cd = $_.Countdown.ToString("dd\.hh\:mm\:ss")

脚本块可以显示该值。事实上，上面的屏幕截图就是使用这种格式。但为什么要停在那里呢？这样的东西难道没有用吗？

如果事件即将发生，则将其显示为红色。如果它接近，我会将其显示为黄色。我的格式文件使用脚本块和 ANSI 转义序列，假设您在控制台主机中运行。着色不在 VSCode 或 PowerShell ISE 中运行。

最初，格式文件具有硬编码逻辑。我将 countdown.totaldays 值与 7 和 14 进行比较。但是您可能对即将发生的事情和待处理的事情有不同的想法。也许您想使用值 30 和 45。在函数文件中，我添加了 2 个变量。

#events almost here
$PSCountdownCritical = 7
#events getting closer
$PSCountdownPending = 14

当您获取脚本文件时，这些变量将在您的 PowerShell 会话中设置。您可以在文件中或事后修改值。我的格式文件有这样的代码来使用这些变量。

If ($host.name -match "console") {
    if ($_.countdown.totaldays -le $PSCountdownCritical) {
         "$([char]27)[91m$($_.EventDate)$([char]27)[0m"
    }
    elseif ($_.countdown.totaldays -lt $PSCountdownPending) {
          "$([char]27)[93m$($_.EventDate)$([char]27)[0m"
    }
    else {
      $_.EventDate
    }
  }
  else {
   $_.EventDate
  }

我不想强迫人们必须编辑 XML 文件。

您可以将这个想法扩展到 ANSI 序列。

无论如何，我现在拥有丰富的 PowerShell 工具，可以以有意义的方式提供有用的信息。

想尝试吗？

想亲自尝试一下吗？必要的文件可以在 https://gist.github.com/jdhitsolutions/17bc013f3ae43c88fd7b14c0f840ad4c 找到。将两个文件放在同一文件夹中，并点源 ps1 文件。您可以通过参数或管道输入值。

我正在倒计时明年的 PowerShell 峰会，现在您可以倒计时了。周末愉快。