Udostępnij za pośrednictwem

Test-PSScriptFileInfo

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

Sprawdza 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 jest on prawidłowy do opublikowania w repozytorium.

Przykłady

Przykład 1. Testowanie prawidłowego skryptu

W tym przykładzie zostanie utworzony nowy plik skryptu, a następnie zostanie uruchomiony Test-PSScriptFile w celu zweryfikowania metadanych w skry 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 uruchomiono polecenie cmdlet Test-PSScriptFile względem pliku skryptu. W skrycie brakuje wymaganych metadanych Author. Polecenie cmdlet zapisuje komunikat ostrzegawczy i zwraca $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 pliku skryptu .ps1.

Typ:String
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

None

Dane wyjściowe

Uwagi

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