Compartir a través de

Test-PSScriptFileInfo

  • Referencia
Módulo:
Microsoft.PowerShell.PSResourceGet

Comprueba los metadatos basados en comentarios de un .ps1 archivo para asegurarse de que es válido para la publicación.

Syntax

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

Description

Este cmdlet prueba los metadatos basados en comentarios de un .ps1 archivo para asegurarse de que es válido para su publicación en un repositorio.

Ejemplos

Ejemplo 1: Prueba de un script válido

En este ejemplo se crea un nuevo archivo de script y, a continuación, se ejecuta Test-PSScriptFile para validar los metadatos del script.

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

Ejemplo 2: Probar un script no válido (falta el autor)

En este ejemplo se ejecuta el Test-PSScriptFile cmdlet en un archivo de script. Falta el script los metadatos de autor necesarios. El cmdlet escribe un mensaje de advertencia y devuelve $false. Get-Content se usa para ver el contenido del archivo de script.

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

#>

Parámetros

-Path

Ruta de acceso al .ps1 archivo de script.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Entradas

None

Salidas

Boolean

Notas

Los New-PSScriptFileInfo cmdlets y Update-PSScriptFileInfo colocan las instrucciones para los #requires módulos necesarios entre los <#PSScriptInfo bloques de ayuda basados en comentarios y del archivo de ayuda. Espera #requires que las Get-PSScriptFileInfo instrucciones se coloquen en algún lugar antes del bloque de ayuda basado en comentarios. Las #requires instrucciones colocadas después del bloque de ayuda basado en comentarios se omiten mediante Get-PSScriptFileInfo y Publish-PSResource.