Test-PSScriptFileInfo

Modul:
Microsoft.PowerShell.PSResourceGet Module

Otestuje metadata založená na komentářích v souboru .ps1, aby byla zajištěna jeho platnost pro publikování.

Syntax

Default (Výchozí) 

Test-PSScriptFileInfo
    [-Path] <string>
    [<CommonParameters>]

Description

Tato rutina testuje metadata založená na komentářích v souboru .ps1, aby se zajistilo, že je platná pro publikování do úložiště.

Příklady

Příklad 1: Testování platného skriptu

Tento příklad vytvoří nový soubor skriptu a potom spustí Test-PSScriptFile k ověření metadat ve skriptu.

New-PSScriptFileInfo -Path "C:\MyScripts\test_script.ps1" -Description "this is a test script"
Test-PSScriptFileInfo -Path "C:\MyScripts\test_script.ps1"
True

Příklad 2: Test neplatného skriptu (chybí autor)

Tento příklad spustí rutinu Test-PSScriptFile pro soubor skriptu. Ve skriptu chybí požadovaná metadata Author. Rutina zapíše zprávu s upozorněním a vrátí $false. Get-Content slouží k zobrazení obsahu souboru skriptu.

Test-PSScriptFileInfo -Path "C:\MyScripts\invalid_test_script.ps1"
Get-Content "C:\MyScripts\invalid_test_script.ps1"

WARNING: The .ps1 script file passed in wasn't valid due to: PSScript file is missing the required
Author property
False
<#PSScriptInfo

.VERSION 1.0.0.0

.GUID 7ec4832e-a4e1-562b-8a8c-241e535ad7d7

.AUTHOR

.COMPANYNAME

.COPYRIGHT

.TAGS

.LICENSEURI

.PROJECTURI

.ICONURI

.EXTERNALMODULEDEPENDENCIES

.REQUIREDSCRIPTS

.EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES

.PRIVATEDATA

#>

<#

.DESCRIPTION
this is a test script

#>

Parametry

-Path

Cesta k .ps1 souboru skriptu.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Výstupy

Boolean

Poznámky

Rutiny New-PSScriptFileInfo a Update-PSScriptFileInfo umístí příkazy #requires pro požadované moduly mezi bloky nápovědy <#PSScriptInfo a bloky nápovědy založené na komentářích. Get-PSScriptFileInfo očekává, že se #requires příkazy umístí někam před blok nápovědy založený na komentáři. Všechny příkazy #requires umístěné po bloku nápovědy založené na komentářích se ignorují Get-PSScriptFileInfo a Publish-PSResource.