Dela via

Test-PSScriptFileInfo

Modul:
Microsoft.PowerShell.PSResourceGet Module

Testar kommentarsbaserade metadata i en .ps1-fil för att säkerställa att den är giltig för publicering.

Syntax

Default (Standard) 

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

Description

Den här cmdleten testar kommentarsbaserade metadata i en .ps1-fil för att säkerställa att den är giltig för publicering till en lagringsplats.

Exempel

Exempel 1: Testa ett giltigt skript

Det här exemplet skapar en ny skriptfil och kör sedan Test-PSScriptFile för att verifiera metadata i skriptet.

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

Exempel 2: Testa ett ogiltigt skript (författare saknas)

Det här exemplet kör cmdleten Test-PSScriptFile mot en skriptfil. Skriptet saknar nödvändiga Author metadata. Cmdleten skriver ett varningsmeddelande och returnerar $false. Get-Content används för att visa innehållet i skriptfilen.

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

#>

Parametrar

-Path

Sökvägen till .ps1 skriptfil.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:0
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

None

Utdata

Boolean

Kommentarer

Cmdletarna New-PSScriptFileInfo och Update-PSScriptFileInfo placerar #requires-instruktionerna för nödvändiga moduler mellan de <#PSScriptInfo- och kommentarsbaserade hjälpblocken i hjälpfilen. Get-PSScriptFileInfo förväntar sig att #requires-instruktioner placeras någonstans före det kommentarsbaserade hjälpblocket. Alla #requires-instruktioner som placeras efter det kommentarsbaserade hjälpblocket ignoreras av Get-PSScriptFileInfo och Publish-PSResource.