Delen via

Test-PSScriptFileInfo

  • Referentie
Module:
Microsoft.PowerShell.PSResourceGet

Test de metagegevens op basis van opmerkingen in een .ps1 bestand om te controleren of het geldig is voor publicatie.

Syntaxis

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

Description

Deze cmdlet test de metagegevens op basis van opmerkingen in een .ps1 bestand om te controleren of het geldig is voor publicatie naar een opslagplaats.

Voorbeelden

Voorbeeld 1: Een geldig script testen

In dit voorbeeld wordt een nieuw scriptbestand gemaakt en vervolgens uitgevoerd Test-PSScriptFile om de metagegevens in het script te valideren.

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

Voorbeeld 2: Een ongeldig script testen (ontbrekende auteur)

In dit voorbeeld wordt de Test-PSScriptFile cmdlet uitgevoerd op basis van een scriptbestand. In het script ontbreken de vereiste metagegevens van de auteur . De cmdlet schrijft een waarschuwingsbericht en retourneert $false. Get-Content wordt gebruikt om de inhoud van het scriptbestand weer te geven.

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

#>

Parameters

-Path

Het pad naar het .ps1 scriptbestand.

Type:String
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

None

Uitvoerwaarden

Boolean

Notities

De New-PSScriptFileInfo cmdlets en Update-PSScriptFileInfo plaatsen de instructies voor de #requires vereiste modules tussen de <#PSScriptInfo helpblokken en op opmerkingen gebaseerde helpblokken van het Help-bestand. De Get-PSScriptFileInfo verwacht dat #requires instructies ergens vóór het op opmerkingen gebaseerde Help-blok worden geplaatst. Alle #requires instructies die worden geplaatst na het helpblok op basis van opmerkingen, worden genegeerd door Get-PSScriptFileInfo en Publish-PSResource.