Test-ScriptFileInfo
Hiermee valideert u een opmerkingenblok voor een script.
Syntaxis
PathParameterSet (Standaard)
Test-ScriptFileInfo
[-Path] <String>
[<CommonParameters>]
LiteralPathParameterSet
Test-ScriptFileInfo
-LiteralPath <String>
[<CommonParameters>]
Description
De Test-ScriptFileInfo cmdlet valideert het opmerkingenblok aan het begin van een script dat wordt gepubliceerd met de Publish-Script-cmdlet. Als het opmerkingenblok een fout bevat, retourneert deze cmdlet informatie over waar de fout zich bevindt of hoe deze kan worden gecorrigeerd.
Dit is een proxy-cmdlet voor de Test-PSScriptFileInfo cmdlet in microsoft.PowerShell.PSResourceGet. Zie Test-PSScriptFileInfo voor meer informatie.
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 metagegevenseigenschappen
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 Format-List-cmdlet om de resultaten op te maken.
Voorbeeld 3: Een scriptbestand testen met geen metagegevens
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
Specificeert een pad naar een of meer locaties. In tegenstelling tot de parameter Path wordt de waarde van de Parameter LiteralPath precies gebruikt zoals deze wordt ingevoerd. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escapetekens bevat, plaatst u deze tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.
De parameter wordt toegewezen aan de padparameter van Test-PSScriptFileInfo.
Parametereigenschappen
| Type: | String |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | PSPath |
Parametersets
LiteralPathParameterSet
| Position: | Named |
| Verplicht: | True |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
-Path
Specificeert een pad naar een of meer locaties. Wildcards zijn toegestaan. De standaardlocatie is de huidige map (.).
Parametereigenschappen
| Type: | String |
| Default value: | None |
| Ondersteunt jokertekens: | True |
| DontShow: | False |
Parametersets
PathParameterSet
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.