Test-PSScriptFileInfo

  • Référence
Module:
Microsoft.PowerShell.PSResourceGet

Teste les métadonnées basées sur les commentaires dans un .ps1 fichier pour vérifier qu’elles sont valides pour la publication.

Syntaxe

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

Description

Cette applet de commande teste les métadonnées basées sur les commentaires dans un .ps1 fichier pour s’assurer qu’elles sont valides pour la publication dans un dépôt.

Exemples

Exemple 1 : Tester un script valide

Cet exemple crée un fichier de script, puis s’exécute Test-PSScriptFile pour valider les métadonnées dans le script.

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

Exemple 2 : Tester un script non valide (auteur manquant)

Cet exemple exécute l’applet de Test-PSScriptFile commande sur un fichier de script. Il manque au script les métadonnées d’auteur requises. L’applet de commande écrit un message d’avertissement et retourne $false. Get-Content est utilisé pour afficher le contenu du fichier 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

#>

Paramètres

-Path

Chemin d’accès au .ps1 fichier de script.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Sorties

Boolean

Notes

Les New-PSScriptFileInfo applets de commande et Update-PSScriptFileInfo placent les #requires instructions pour les modules requis entre les blocs d’aide basés sur les <#PSScriptInfo commentaires et du fichier d’aide. Le Get-PSScriptFileInfo s’attend à ce que les instructions soient placées #requires quelque part avant le bloc d’aide basé sur les commentaires. Toutes #requires les instructions placées après le bloc d’aide basé sur les commentaires sont ignorées par Get-PSScriptFileInfo et Publish-PSResource.