Test-PSScriptFileInfo

  • Referenz
Modul:
Microsoft.PowerShell.PSResourceGet

Testet die kommentarbasierten Metadaten in einer .ps1 Datei, um sicherzustellen, dass sie für die Veröffentlichung gültig sind.

Syntax

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

Beschreibung

Dieses Cmdlet testet die kommentarbasierten Metadaten in einer .ps1 Datei, um sicherzustellen, dass sie für die Veröffentlichung in einem Repository gültig sind.

Beispiele

Beispiel 1: Testen eines gültigen Skripts

In diesem Beispiel wird eine neue Skriptdatei erstellt und dann ausgeführt Test-PSScriptFile , um die Metadaten im Skript zu überprüfen.

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

Beispiel 2: Testen eines ungültigen Skripts (fehlender Autor)

In diesem Beispiel wird das Test-PSScriptFile Cmdlet für eine Skriptdatei ausgeführt. Dem Skript fehlen die erforderlichen Author-Metadaten . Das Cmdlet schreibt eine Warnmeldung und gibt zurück $false. Get-Content wird verwendet, um den Inhalt der Skriptdatei anzuzeigen.

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

#>

Parameter

-Path

Der Pfad zur .ps1 Skriptdatei.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Ausgaben

Boolean

Hinweise

Die New-PSScriptFileInfo Cmdlets und Update-PSScriptFileInfo platzieren die #requires Anweisungen für erforderliche Module zwischen den <#PSScriptInfo kommentarbasierten Hilfeblöcken und der Hilfedatei. Erwartet Get-PSScriptFileInfo , #requires dass Anweisungen an einer beliebigen Stelle vor dem kommentarbasierten Hilfeblock platziert werden. Alle #requires Anweisungen, die nach dem kommentarbasierten Hilfeblock platziert werden, werden von Get-PSScriptFileInfo und Publish-PSResourceignoriert.