Test-ScriptFileInfo

  • Referenz
Modul:
PowerShellGet

Überprüft einen Kommentarblock für ein Skript.

Syntax

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

Beschreibung

Das Test-ScriptFileInfo Cmdlet überprüft den Kommentarblock am Anfang eines Skripts, das mit dem Cmdlet Publish-Script veröffentlicht wird. Wenn der Kommentarblock einen Fehler aufweist, gibt dieses Cmdlet Informationen darüber zurück, wo sich der Fehler befindet oder wie er korrigiert werden kann.

Dies ist ein Proxy-Cmdlet für das Test-PSScriptFileInfo Cmdlet in Microsoft.PowerShell.PSResourceGet. Weitere Informationen finden Sie unter Test-PSScriptFileInfo.

Beispiele

Beispiel 1: Testen einer Skriptdatei

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

Dieser Befehl testet die New-ScriptFile.ps1 Skriptdatei und zeigt die Ergebnisse an. Die Skriptdatei enthält gültige Metadaten.

Beispiel 2: Testen einer Skriptdatei mit Werten für alle Metadateneigenschaften

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

Dieser Befehl testet die Skriptdatei Test-Runbook.ps1 und verwendet den Pipelineoperator, um die Ergebnisse an das Cmdlet Format-List zu übergeben, um die Ergebnisse zu formatieren.

Beispiel 3: Testen einer Skriptdatei ohne Metadaten

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

Dieser Befehl testet die Skriptdatei Hello-World.ps1, der keine Metadaten zugeordnet sind.

Parameter

-LiteralPath

Gibt einen Pfad zu einem oder mehreren Speicherorten an. Im Gegensatz zum Path-Parameter wird der Wert des LiteralPath-Parameters genau so verwendet, wie er eingegeben wird. Es werden keine Zeichen als Platzhalter interpretiert. Wenn der Pfad Escapezeichen enthält, schließen Sie sie in einfache Anführungszeichen ein. Einfache Anführungszeichen weisen PowerShell an, keine Zeichen als Escapesequenzen zu interpretieren.

Der Parameter wird dem Path-Parameter von Test-PSScriptFileInfozugeordnet.

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

-Path

Gibt einen Pfad zu einem oder mehreren Speicherorten an. Platzhalter sind zulässig. Der Standardspeicherort ist das aktuelle Verzeichnis (.).

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

Eingaben

String

Ausgaben

Object