Test-ScriptFileInfo
Weryfikuje blok komentarzy dla skryptu.
Składnia
Test-ScriptFileInfo
[-Path] <String>
[<CommonParameters>]
Test-ScriptFileInfo
-LiteralPath <String>
[<CommonParameters>]
Opis
Polecenie Test-ScriptFileInfo
cmdlet weryfikuje blok komentarza na początku skryptu, który zostanie opublikowany za pomocą polecenia cmdlet Publish-Script. Jeśli blok komentarza zawiera błąd, to polecenie cmdlet zwraca informacje o tym, gdzie znajduje się błąd lub jak go poprawić.
Przykłady
Przykład 1. Testowanie pliku skryptu
Test-ScriptFileInfo -Path "C:\temp\temp_scripts\New-ScriptFile.ps1"
To polecenie sprawdza plik skryptu New-ScriptFile.ps1 i wyświetla wyniki. Plik skryptu zawiera prawidłowe metadane.
Przykład 2: Testowanie pliku skryptu zawierającego wartości dla wszystkich właściwości metadanych
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
To polecenie sprawdza plik skryptu Test-Runbook.ps1 i używa operatora potoku do przekazania wyników do polecenia cmdlet Format-List w celu sformatowania wyników.
Przykład 3. Testowanie pliku skryptu bez metadanych
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
To polecenie sprawdza Hello-World.ps1 pliku skryptu, który nie ma skojarzonych z nim metadanych.
Parametry
-LiteralPath
Określa ścieżkę do co najmniej jednej lokalizacji. W przeciwieństwie do parametru Path wartość parametru LiteralPath jest używana dokładnie tak, jak została wprowadzona. Znaki nie są interpretowane jako symbole wieloznaczne. Jeśli ścieżka zawiera znaki ucieczki, należy je ująć w znaki pojedynczego cudzysłowu. Znaki pojedynczego cudzysłowu informują program PowerShell, aby nie interpretował żadnych znaków jako sekwencji ucieczki.
Type: | String |
Aliases: | PSPath |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Określa ścieżkę do co najmniej jednej lokalizacji. Dozwolone są symbole wieloznaczne. Domyślną lokalizacją jest bieżący katalog (.
).
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |