Share via

Test-PSScriptFileInfo

  • Odwołanie
Moduł:
Microsoft.PowerShell.PSResourceGet

Testuje metadane oparte na komentarzach w pliku, .ps1 aby upewnić się, że jest on prawidłowy dla publikacji.

Składnia

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

Opis

To polecenie cmdlet testuje metadane oparte na komentarzach w pliku, .ps1 aby upewnić się, że publikacja w repozytorium jest prawidłowa.

Przykłady

Przykład 1. Testowanie prawidłowego skryptu

W tym przykładzie tworzony jest nowy plik skryptu, a następnie uruchamiany Test-PSScriptFile w celu zweryfikowania metadanych w skryfcie.

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

Przykład 2: Testowanie nieprawidłowego skryptu (brak autora)

W tym przykładzie Test-PSScriptFile polecenie cmdlet jest uruchamiane względem pliku skryptu. W skrycie brakuje wymaganych metadanych autora . Polecenie cmdlet zapisuje komunikat ostrzegawczy i zwraca wartość $false. Get-Content służy do wyświetlania zawartości pliku skryptu.

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

#>

Parametry

-Path

Ścieżka do .ps1 pliku skryptu.

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

Dane wejściowe

None

Dane wyjściowe

Boolean

Uwagi

Polecenia New-PSScriptFileInfo cmdlet i Update-PSScriptFileInfo umieszczają #requires instrukcje dla wymaganych modułów między blokami <#PSScriptInfo pomocy opartymi na komentarzach i pliku pomocy. Oczekuje Get-PSScriptFileInfo , że instrukcje #requires zostaną umieszczone gdzieś przed blokiem pomocy opartej na komentarzach. Wszystkie #requires instrukcje umieszczone po bloku pomocy opartej na komentarzach są ignorowane przez Get-PSScriptFileInfo i Publish-PSResource.