Test-ScriptFileInfo
Valida um bloco de comentários para um script.
Syntax
Test-ScriptFileInfo
[-Path] <String>
[<CommonParameters>]
Test-ScriptFileInfo
-LiteralPath <String>
[<CommonParameters>]
Description
O Test-ScriptFileInfo
cmdlet valida o bloco de comentários no início de um script que será publicado com o cmdlet Publish-Script. Se o bloco de comentários tiver um erro, este cmdlet devolve informações sobre onde o erro está localizado ou como corrigi-lo.
Este é um cmdlet proxy para o Test-PSScriptFileInfo
cmdlet no Microsoft.PowerShell.PSResourceGet. Para obter mais informações, veja Test-PSScriptFileInfo.
Exemplos
Exemplo 1: Testar um ficheiro de script
Test-ScriptFileInfo -Path "C:\temp\temp_scripts\New-ScriptFile.ps1"
Este comando testa o ficheiro de script New-ScriptFile.ps1 e apresenta os resultados. O ficheiro de script inclui metadados válidos.
Exemplo 2: Testar um ficheiro de script que tenha valores para todas as propriedades de metadados
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 testa o ficheiro de script Test-Runbook.ps1 e utiliza o operador de pipeline para transmitir os resultados ao cmdlet Format-List para formatar os resultados.
Exemplo 3: testar um ficheiro de script sem metadados
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 testa o ficheiro de script Hello-World.ps1, que não tem metadados associados ao mesmo.
Parâmetros
-LiteralPath
Especifica um caminho para uma ou mais localizações. Ao contrário do parâmetro Path , o valor do parâmetro LiteralPath é utilizado exatamente como é introduzido. Não são interpretados carateres universais. Se o caminho incluir carateres de escape, coloque-os entre plicas. As aspas únicas indicam ao PowerShell para não interpretar os carateres como sequências de escape.
O parâmetro é mapeado para o parâmetro Path de Test-PSScriptFileInfo
.
Type: | String |
Aliases: | PSPath |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Especifica um caminho para uma ou mais localizações. São permitidos carateres universais. A localização predefinida é o diretório atual (.
).
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |