Test-PSScriptFileInfo

  • Riferimento
Modulo:
Microsoft.PowerShell.PSResourceGet

Verifica i metadati basati sui commenti in un .ps1 file per verificare che sia valido per la pubblicazione.

Sintassi

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

Descrizione

Questo cmdlet verifica i metadati basati su commenti in un .ps1 file per assicurarsi che sia valido per la pubblicazione in un repository.

Esempio

Esempio 1: Testare uno script valido

In questo esempio viene creato un nuovo file di script che viene quindi eseguito Test-PSScriptFile per convalidare i metadati nello script.

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

Esempio 2: Testare uno script non valido (autore mancante)

In questo esempio viene eseguito il Test-PSScriptFile cmdlet su un file di script. Lo script non contiene i metadati dell'autore necessari. Il cmdlet scrive un messaggio di avviso e restituisce $false. Get-Content viene utilizzato per visualizzare il contenuto del file di 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

#>

Parametri

-Path

Percorso del .ps1 file di script.

Tipo:String
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

None

Output

Boolean

Note

I New-PSScriptFileInfo cmdlet e Update-PSScriptFileInfo inserisce le #requires istruzioni per i moduli necessari tra i blocchi della <#PSScriptInfo Guida basata su commenti e del file della Guida. L'oggetto Get-PSScriptFileInfo prevede #requires che le istruzioni vengano inserite in un punto qualsiasi prima del blocco della Guida basato su commenti. Tutte #requires le istruzioni inserite dopo il blocco della Guida basata su commenti vengono ignorate da Get-PSScriptFileInfo e Publish-PSResource.