Test-PSScriptFileInfo
Prueba los metadatos basados en comentarios en un archivo de .ps1 para asegurarse de que es válido para la publicación.
Sintaxis
Default (valor predeterminado)
Test-PSScriptFileInfo
[-Path] <String>
[<CommonParameters>]
Description
Este cmdlet prueba los metadatos basados en comentarios en un archivo de .ps1 para asegurarse de que es válido para la publicación en un repositorio.
Ejemplos
Ejemplo 1: Probar 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 autor)
En este ejemplo se ejecuta el cmdlet Test-PSScriptFile en un archivo de script. Falta el script necesario metadatos de author. 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 archivo de script de .ps1.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | 0 |
| Obligatorio: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.
Entradas
None
Salidas
Boolean
Notas
Los cmdlets New-PSScriptFileInfo y Update-PSScriptFileInfo colocan las instrucciones #requires para los módulos necesarios entre los bloques de ayuda <#PSScriptInfo y basados en comentarios del archivo de ayuda.
El Get-PSScriptFileInfo espera que las instrucciones #requires se coloquen en algún lugar antes del bloque de ayuda basado en comentarios. Las instrucciones de #requires colocadas después del bloque de ayuda basado en comentarios se omiten Get-PSScriptFileInfo y Publish-PSResource.
