Test-ScriptFileInfo

  • Referens
Modul:
PowerShellGet

Validerar ett kommentarsblock för ett skript.

Syntax

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

Description

Cmdleten Test-ScriptFileInfo verifierar kommentarsblocket i början av ett skript som ska publiceras med cmdleten Publish-Script. Om kommentarsblocket innehåller ett fel returnerar den här cmdleten information om var felet finns eller hur det korrigeras.

Det här är en proxy-cmdlet för Test-PSScriptFileInfo cmdleten i Microsoft.PowerShell.PSResourceGet. Mer information finns i Test-PSScriptFileInfo.

Exempel

Exempel 1: Testa en skriptfil

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

Det här kommandot testar New-ScriptFile.ps1-skriptfilen och visar resultatet. Skriptfilen innehåller giltiga metadata.

Exempel 2: Testa en skriptfil som har värden för alla metadataegenskaper

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

Det här kommandot testar skriptfilen Test-Runbook.ps1 och använder pipelineoperatorn för att skicka resultatet till cmdleten Format-List för att formatera resultatet.

Exempel 3: Testa en skriptfil som inte har några metadata

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

Det här kommandot testar skriptfilen Hello-World.ps1, som inte har några associerade metadata.

Parametrar

-LiteralPath

Anger en sökväg till en eller flera platser. Till skillnad från parametern Path används värdet för parametern LiteralPath exakt som det anges. Inga tecken tolkas som jokertecken. Om sökvägen innehåller escape-tecken omger du dem med enkla citattecken. Enkla citattecken talar om för PowerShell att inga tecken ska tolkas som escape-sekvenser.

Parametern mappas till parametern Path för Test-PSScriptFileInfo.

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

-Path

Anger en sökväg till en eller flera platser. Jokertecken tillåts. Standardplatsen är den aktuella katalogen (.).

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

Indata

String

Utdata

Object