Sdílet prostřednictvím

Test-PSScriptFileInfo

  • Reference
Modul:
Microsoft.PowerShell.PSResourceGet

Otestuje metadata založená .ps1 na komentářích v souboru, aby se ujistila, že jsou platná pro publikování.

Syntaxe

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

Description

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

Příklady

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

Tento příklad vytvoří nový soubor skriptu a pak spustí Test-PSScriptFile 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: Otestování neplatného skriptu (chybí autor)

Tento příklad spustí rutinu Test-PSScriptFile se souborem skriptu. Ve skriptu chybí požadovaná metadata autora . Rutina zapíše zprávu upozornění 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.

Typ:String
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

None

Výstupy

Boolean

Poznámky

Rutiny New-PSScriptFileInfo a Update-PSScriptFileInfo umisťují #requires příkazy pro požadované moduly mezi <#PSScriptInfo bloky nápovědy založené na komentářích a v souboru nápovědy. Očekává Get-PSScriptFileInfo , že příkazy budou umístěny někam před blok nápovědy #requires založený na komentářích. Všechny #requires příkazy umístěné za blokem nápovědy založeném na komentářích jsou ignorovány a Get-PSScriptFileInfoPublish-PSResource.