Test-PSScriptFileInfo

Referência

Módulo:: Microsoft.PowerShell.PSResourceGet

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

Sintaxe

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

Description

Esse cmdlet testa os metadados baseados em comentário em um arquivo .ps1 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, executa 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 cmdlet Test-PSScriptFile em um arquivo de script. O script não tem os metadados necessários Author. 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 .ps1 arquivo de script.

Tipo:	String
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

Entradas

None

Saídas

Boolean

Observações

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