Compartir a través de


Test-ScriptFileInfo

Valida un bloque de comentarios para un script.

Sintaxis

PathParameterSet (valor predeterminado)

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

LiteralPathParameterSet

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

Description

El Test-ScriptFileInfo cmdlet valida el bloque de comentarios al principio de un script que se publicará con el cmdlet Publish-Script. Si el bloque de comentarios tiene un error, este cmdlet devuelve información sobre dónde se encuentra el error o cómo corregirlo.

Ejemplos

Ejemplo 1: Prueba de un archivo de script

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

Este comando prueba el archivo de script New-ScriptFile.ps1 y muestra los resultados. El archivo de script incluye metadatos válidos.

Ejemplo 2: Prueba de un archivo de script que tiene valores para todas las propiedades de metadatos

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

Este comando prueba el archivo de script Test-Runbook.ps1 y usa el operador de canalización para pasar los resultados al cmdlet Format-List para dar formato a los resultados.

Ejemplo 3: Probar un archivo de script que no tiene metadatos

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

Este comando prueba el archivo de script Hello-World.ps1, que no tiene metadatos asociados.

Parámetros

-LiteralPath

Especifica una ruta de acceso a una o varias ubicaciones. A diferencia del parámetro Path , el valor del parámetro LiteralPath se usa exactamente como se especifica. Ninguno de los caracteres se interpreta como caracteres comodín. Si la ruta de acceso incluye caracteres de escape, escríbalos entre comillas simples. Las comillas simples indican a PowerShell que no interprete ningún carácter como secuencias de escape.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:PSPath

Conjuntos de parámetros

LiteralPathParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Path

Especifica una ruta de acceso a una o varias ubicaciones. Se permiten los caracteres comodín. La ubicación predeterminada es el directorio actual (.).

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:True
DontShow:False

Conjuntos de parámetros

PathParameterSet
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

String

Salidas

Object