Delen via

Test-PSScriptFileInfo

Module:
Microsoft.PowerShell.PSResourceGet Module

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

Syntaxis

Default (Standaard) 

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

Description

Met deze cmdlet worden de metagegevens op basis van opmerkingen in een .ps1-bestand getest om ervoor te zorgen dat het geldig is voor publicatie naar een opslagplaats.

Voorbeelden

Voorbeeld 1: Een geldig script testen

In dit voorbeeld wordt een nieuw scriptbestand gemaakt en wordt Test-PSScriptFile uitgevoerd 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 cmdlet Test-PSScriptFile uitgevoerd op basis van een scriptbestand. Het script ontbreekt de vereiste metagegevens Author. 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 .ps1 scriptbestand.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:0
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

None

Uitvoerwaarden

Boolean

Notities

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