Test-PSScriptFileInfo
Teste les métadonnées basées sur les commentaires dans un fichier .ps1 pour vérifier qu’elles sont valides pour la publication.
Syntaxe
Default (Par défaut)
Test-PSScriptFileInfo
[-Path] <String>
[<CommonParameters>]
Description
Cette applet de commande teste les métadonnées basées sur des commentaires dans un fichier .ps1 pour s’assurer qu’elle est valide pour la publication dans un référentiel.
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 commande Test-PSScriptFile sur un fichier de script. Le script ne contient pas les métadonnées Author 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 fichier de script .ps1.
Propriétés des paramètres
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Entrées
None
Sorties
Boolean
Notes
Les applets de commande New-PSScriptFileInfo et Update-PSScriptFileInfo placent les instructions #requires pour les modules requis entre les blocs d’aide <#PSScriptInfo et basés sur des commentaires du fichier d’aide.
La Get-PSScriptFileInfo s’attend à ce que les instructions #requires soient placées quelque part avant le bloc d’aide basé sur les commentaires. Toutes les instructions #requires placées après le bloc d’aide basé sur les commentaires sont ignorées par Get-PSScriptFileInfo et Publish-PSResource.
