Поделиться через

Test-PSScriptFileInfo

  • Ссылка
Модуль:
Microsoft.PowerShell.PSResourceGet

Проверяет метаданные на основе комментариев в .ps1 файле, чтобы убедиться, что они допустимы для публикации.

Синтаксис

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

Описание

Этот командлет проверяет метаданные на основе комментариев в файле, чтобы убедиться, что они допустимы для публикации в .ps1 репозитории.

Примеры

Пример 1. Проверка допустимого скрипта

В этом примере создается новый файл скрипта, а затем выполняется Test-PSScriptFile для проверки метаданных в скрипте.

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

Пример 2. Тестирование недопустимого скрипта (отсутствует автор)

В этом примере выполняется Test-PSScriptFile командлет для файла скрипта. В скрипте отсутствуют необходимые метаданные Автора . Командлет записывает предупреждающее сообщение и возвращает .$false Get-Content используется для просмотра содержимого файла скрипта.

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

#>

Параметры

-Path

Путь к файлу .ps1 скрипта.

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

Входные данные

None

Выходные данные

Boolean

Примечания

Командлеты New-PSScriptFileInfo и Update-PSScriptFileInfo помещает инструкции #requires для необходимых модулей между блоками справки <#PSScriptInfo на основе комментариев и файла справки. Ожидает Get-PSScriptFileInfo , что операторы #requires будут размещены где-то перед блоком справки на основе комментариев. Все #requires инструкции, помещенные после блока справки на основе комментариев, Get-PSScriptFileInfo игнорируются и Publish-PSResource.