Partager via

Test-ScriptFileInfo

  • Référence
Module:
PowerShellGet

Valide un bloc de commentaires pour un script.

Syntax

Test-ScriptFileInfo
    [-Path] <String>
    [<CommonParameters>]
Test-ScriptFileInfo
    -LiteralPath <String>
    [<CommonParameters>]

Description

L’applet Test-ScriptFileInfo de commande valide le bloc de commentaires au début d’un script qui sera publié avec l’applet de commande Publish-Script. Si le bloc de commentaires contient une erreur, cette applet de commande retourne des informations sur l’emplacement de l’erreur ou sur la façon de la corriger.

Il s’agit d’une applet de commande proxy pour l’applet Test-PSScriptFileInfode commande dans Microsoft.PowerShell.PSResourceGet. Pour plus d’informations, consultez Test-PSScriptFileInfo.

Exemples

Exemple 1 : Tester un fichier de script

Test-ScriptFileInfo -Path "C:\temp\temp_scripts\New-ScriptFile.ps1"

Cette commande teste le fichier de script New-ScriptFile.ps1 et affiche les résultats. Le fichier de script inclut des métadonnées valides.

Exemple 2 : Tester un fichier de script qui a des valeurs pour toutes les propriétés de métadonnées

Test-ScriptFileInfo -Path "D:\code\Test-Runbook.ps1" | Format-List *

Name                       : Test-Runbook
Path                       : D:\code\Test-Runbook.ps1
ScriptBase                 : D:\code
ReleaseNotes               : {contoso script now supports following features, Feature 1, Feature 2, Feature 3...}
Version                    : 1.0
Guid                       : eb246b19-17da-4392-8c89-7c280f69ad0e
Author                     : pattif
CompanyName                : Microsoft Corporation
Copyright                  : 2015 Microsoft Corporation. All rights reserved.
Tags                       : {Tag1, Tag2, Tag3}
LicenseUri                 : https://contoso.com/License
ProjectUri                 : https://contoso.com/
IconUri                    : https://contoso.com/MyScriptIcon
ExternalModuleDependencies : ExternalModule1
RequiredScripts            : {Start-WFContosoServer, Stop-ContosoServerScript}
ExternalScriptDependencies : Stop-ContosoServerScript
Description                : Contoso Script example
RequiredModules            : {RequiredModule1, @{ ModuleName = 'RequiredModule2'; ModuleVersion = '1.0' }, @{ ModuleName = 'RequiredModule3'; RequiredVersion = '2.0' }, ExternalModule1}
ExportedCommands           : {Test-WebUri, ValidateAndAdd-PSScriptInfoEntry, Get-PSScriptInfo, My-Workflow...}
ExportedFunctions          : {Test-WebUri, ValidateAndAdd-PSScriptInfoEntry, Get-PSScriptInfo, My-AdvPSCmdlet}
ExportedWorkflows          : My-Workflow

Cette commande teste le fichier de script Test-Runbook.ps1 et utilise l’opérateur de pipeline pour passer les résultats à l’applet de commande Format-List afin de mettre en forme les résultats.

Exemple 3 : Tester un fichier de script qui n’a pas de métadonnées

Test-ScriptFileInfo -Path "D:\code\Hello-World.ps1"

Test-ScriptFileInfo : Script 'D:\code\Hello-World.ps1' is missing required metadata properties. Verify that the script file has Version, Description
and Author properties. You can use the Update-ScriptFileInfo or New-ScriptFileInfo cmdlet to add or update the PSScriptInfo to the script file.
At line:1 char:1
+ Test-ScriptFileInfo D:\code\Hello-World.ps1
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : InvalidArgument: (D:\code\Hello-World.ps1:String) [Test-ScriptFileInfo], ArgumentException

+ FullyQualifiedErrorId : MissingRequiredPSScriptInfoProperties,Test-ScriptFile

Cette commande teste le fichier de script Hello-World.ps1, qui n’a aucune métadonnées associée.

Paramètres

-LiteralPath

Spécifie un chemin d’accès à un ou plusieurs emplacements. Contrairement au paramètre Path , la valeur du paramètre LiteralPath est utilisée exactement au fur et à mesure de son entrée. Aucun caractère n’est interprété en tant que caractère générique. Si le chemin d’accès inclut des caractères d’échappement, placez-les entre guillemets simples. Les guillemets simples indiquent à PowerShell de ne pas interpréter de caractères comme des séquences d’échappement.

Le paramètre est mappé au paramètre Path de Test-PSScriptFileInfo.

Type:String
Aliases:PSPath
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

Spécifie un chemin d’accès à un ou plusieurs emplacements. Les caractères génériques sont autorisés. L’emplacement par défaut est le répertoire actif (.).

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

Entrées

String

Sorties

Object