Início / coding / Perguntas / 76922402
Accepted
Pxtl
Asked: 2023-08-17 22:18:26 +0800 CST

Powershell 5.1: descrições de alias estão faltando no meu módulo

  • 772

Tenho um módulo PhriInfrastructureque codifica nossos procedimentos de DevOps em minha organização. Ele tem uma função Test-IsLocalhostpara a qual criei um alias Get-IsLocalhostpor motivos de compatibilidade com versões anteriores.

Eu tentei aplicar um descriptionao alias, assim:

New-Alias -Name Get-IsLocalhost -Value Test-IsLocalhost -Description "Get-IsLocalhost was renamed Test-IsLocalhost to better-match Powershell verb standards"

no entanto, quando tento extrair metadados sobre o alias na linha de comando

Import-Module .\PowerShellModules\src\PhriInfrastructure -Force
(Get-Alias Get-IsLocalhost) | Format-List -Property *
Get-Help Get-IsLocalhost

o Descriptioncampo está vazio no Get-Helpe no Get-Alias(o comando subjacente Test-IsLocalhosttem apenas uma extensão #.Synopsis.

Enquanto isso, se eu tentar criar o alias diretamente da linha de comando, ele aparecerá nos membros do alias (mas ainda não no get-help).

Existe uma maneira de expor a descrição do alias corretamente? Ou alguma maneira melhor de dizer "não use este alias, use o principal?" Isso é apenas um bug em como o Powershell 5.1 exporta aliases em módulos?

powershell

1 respostas

  1. Best Answer

    De fato, qualquer -Descriptionvalor que você especificar parece ser perdido quando um alias é exportado de um módulo (observado no Windows PowerShell e no PowerShell (Core) até pelo menos v7.3.6, atual até o momento em que este livro foi escrito).

    Isso é apenas um bug em como o PowerShell 5.1 exporta aliases em módulos?

    Eu diria que sim e encorajo você a criar um relatório de bug no repositório do GitHub .

    se eu tentar criar o alias diretamente da linha de comando, ele aparecerá nos membros do alias (mas ainda não emget-help ).

    Por design, os aliases não têm sua própria ajuda - Get-Helpsimplesmente resolve um alias para seu comando de destino e mostra sua ajuda, para que você nunca obtenha informações sobre o próprio alias dessa maneira.

    alguma maneira melhor de dizer "não use este alias, use o principal?"

    • Geralmente, a .Descriptionpropriedade das definições de alias raramente é usada (ela não é definida para nenhum dos aliases integrados ), o que também é sugerido pelo fato de que ela nem aparece na Get-Aliassaída for-display do 's, a menos que você pergunte explicitamente para isso (por exemplo, via Format-List *)

    • Você pode implementar Get-IsLocalhostcomo uma função que delega para Test-IsLocalHost, o que permite fornecer sua própria ajuda baseada em comentários, que pode ser tão simples quanto:

      function Get-IsLocalHost {
<#
.SYNOPSIS
Get-IsLocalhost was renamed Test-IsLocalhost to better-match PowerShell verb standards.
#>
  Test-IsLocalHost @args
}

      • Se você preferir um aviso de tempo de execução , poderá usar o System.ObsoleteAttributeatributo da seguinte maneira; observe que a ajuda baseada em comentários é usada para encaminhar automaticamente para Test-IsLocalHosta ajuda de aqui:

        function Get-IsLocalHost {
<#
.ForwardHelpTargetName TestIsLocalHost
.ForwardHelpCategory Function
#>
  [Obsolete("Get-IsLocalhost was renamed Test-IsLocalhost to better-match PowerShell verb standards.")]
  param()
  Test-IsLocalHost @args
}

      • Na chamada, um aviso é emitido incondicionalmente por meio do fluxo de saída Warning , que pode ser silenciado com 3>$null(se você também quiser oferecer suporte a -WarningAction SilentlyContinue, terá que tornar a função avançada , o que exigiria a duplicação das declarações de parâmetro da função de destino e invocando-o com Test-IsLocalHost @PSBoundParameters.)

    • 2

relate perguntas