Compartilhar via

Test-PSScriptFileInfo

  • Referência
Módulo:
Microsoft.PowerShell.PSResourceGet

Testa os metadados baseados em comentário em um .ps1 arquivo para garantir que ele seja válido para publicação.

Syntax

Test-PSScriptFileInfo
    [-Path] <String>
    [<CommonParameters>]

Description

Esse cmdlet testa os metadados baseados em comentário em um .ps1 arquivo para garantir que ele seja válido para publicação em um repositório.

Exemplos

Exemplo 1: Testar um script válido

Este exemplo cria um novo arquivo de script e, em seguida, é executado Test-PSScriptFile para validar os metadados no script.

New-PSScriptFileInfo -Path "C:\MyScripts\test_script.ps1" -Description "this is a test script"
Test-PSScriptFileInfo -Path "C:\MyScripts\test_script.ps1"
True

Exemplo 2: Testar um script inválido (autor ausente)

Este exemplo executa o Test-PSScriptFile cmdlet em um arquivo de script. O script não tem os metadados do Autor necessários. O cmdlet grava uma mensagem de aviso e retorna $false. Get-Content é usado para exibir o conteúdo do arquivo de script.

Test-PSScriptFileInfo -Path "C:\MyScripts\invalid_test_script.ps1"
Get-Content "C:\MyScripts\invalid_test_script.ps1"

WARNING: The .ps1 script file passed in wasn't valid due to: PSScript file is missing the required
Author property
False
<#PSScriptInfo

.VERSION 1.0.0.0

.GUID 7ec4832e-a4e1-562b-8a8c-241e535ad7d7

.AUTHOR

.COMPANYNAME

.COPYRIGHT

.TAGS

.LICENSEURI

.PROJECTURI

.ICONURI

.EXTERNALMODULEDEPENDENCIES

.REQUIREDSCRIPTS

.EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES

.PRIVATEDATA

#>

<#

.DESCRIPTION
this is a test script

#>

Parâmetros

-Path

O caminho para o .ps1 arquivo de script.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Entradas

None

Saídas

Boolean

Observações

Os New-PSScriptFileInfo cmdlets e Update-PSScriptFileInfo colocam as #requires instruções para os módulos necessários entre os <#PSScriptInfo blocos de ajuda baseados em comentários e do arquivo de ajuda. A Get-PSScriptFileInfo espera que as instruções sejam colocadas #requires em algum lugar antes do bloco de ajuda baseado em comentários. Todas as #requires instruções colocadas após o bloco de ajuda baseado em comentário são ignoradas por Get-PSScriptFileInfo e Publish-PSResource.