Test-ScriptFileInfo

  • Referentie
Module:
PowerShellGet

Valideert een opmerkingenblok voor een script.

Syntax

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

Description

De Test-ScriptFileInfo cmdlet valideert het opmerkingenblok aan het begin van een script dat wordt gepubliceerd met de cmdlet Publish-Script. Als het opmerkingenblok een fout bevat, retourneert deze cmdlet informatie over waar de fout zich bevindt of hoe deze kan worden gecorrigeerd.

Voorbeelden

Voorbeeld 1: Een scriptbestand testen

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

Met deze opdracht wordt het New-ScriptFile.ps1 scriptbestand getest en worden de resultaten weergegeven. Het scriptbestand bevat geldige metagegevens.

Voorbeeld 2: Een scriptbestand testen met waarden voor alle eigenschappen van metagegevens

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

Met deze opdracht wordt het scriptbestand Test-Runbook.ps1 getest en wordt de pijplijnoperator gebruikt om de resultaten door te geven aan de cmdlet Format-List om de resultaten op te maken.

Voorbeeld 3: Een scriptbestand testen dat geen metagegevens bevat

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

Met deze opdracht wordt het scriptbestand getest Hello-World.ps1, waaraan geen metagegevens zijn gekoppeld.

Parameters

-LiteralPath

Hiermee geeft u een pad naar een of meer locaties. In tegenstelling tot de path-parameter wordt de waarde van de parameter LiteralPath exact gebruikt zoals deze is ingevoerd. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escapetekens bevat, plaatst u deze tussen enkele aanhalingstekens. Enkele aanhalingstekens vertellen PowerShell dat geen tekens als escape-reeksen worden geïnterpreteerd.

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

-Path

Hiermee geeft u een pad naar een of meer locaties. Jokertekens zijn toegestaan. De standaardlocatie is de huidige map (.).

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

Invoerwaarden

String

Uitvoerwaarden

Object