Share via

Test-ScriptFileInfo

  • Ссылка
Модуль:
PowerShellGet

Проверяет блок комментариев для скрипта.

Синтаксис

Test-ScriptFileInfo
    [-Path] <String>
    [<CommonParameters>]
Test-ScriptFileInfo
    -LiteralPath <String>
    [<CommonParameters>]

Описание

Командлет Test-ScriptFileInfo проверяет блок комментариев в начале сценария, который будет опубликован с помощью командлета Publish-Script. Если блок комментариев содержит ошибку, этот командлет возвращает сведения о расположении ошибки и способах ее исправления.

Это прокси-командлет для командлета Test-PSScriptFileInfo в Microsoft.PowerShell.PSResourceGet. Дополнительные сведения см. в разделе Test-PSScriptFileInfo.

Примеры

Пример 1. Тестирование файла скрипта

Test-ScriptFileInfo -Path "C:\temp\temp_scripts\New-ScriptFile.ps1"

Эта команда проверяет файл скрипта New-ScriptFile.ps1 и отображает результаты. Файл скрипта содержит допустимые метаданные.

Пример 2. Тестирование файла скрипта со значениями для всех свойств метаданных

Test-ScriptFileInfo -Path "D:\code\Test-Runbook.ps1" | Format-List *

Name                       : Test-Runbook
Path                       : D:\code\Test-Runbook.ps1
ScriptBase                 : D:\code
ReleaseNotes               : {contoso script now supports following features, Feature 1, Feature 2, Feature 3...}
Version                    : 1.0
Guid                       : eb246b19-17da-4392-8c89-7c280f69ad0e
Author                     : pattif
CompanyName                : Microsoft Corporation
Copyright                  : 2015 Microsoft Corporation. All rights reserved.
Tags                       : {Tag1, Tag2, Tag3}
LicenseUri                 : https://contoso.com/License
ProjectUri                 : https://contoso.com/
IconUri                    : https://contoso.com/MyScriptIcon
ExternalModuleDependencies : ExternalModule1
RequiredScripts            : {Start-WFContosoServer, Stop-ContosoServerScript}
ExternalScriptDependencies : Stop-ContosoServerScript
Description                : Contoso Script example
RequiredModules            : {RequiredModule1, @{ ModuleName = 'RequiredModule2'; ModuleVersion = '1.0' }, @{ ModuleName = 'RequiredModule3'; RequiredVersion = '2.0' }, ExternalModule1}
ExportedCommands           : {Test-WebUri, ValidateAndAdd-PSScriptInfoEntry, Get-PSScriptInfo, My-Workflow...}
ExportedFunctions          : {Test-WebUri, ValidateAndAdd-PSScriptInfoEntry, Get-PSScriptInfo, My-AdvPSCmdlet}
ExportedWorkflows          : My-Workflow

Эта команда проверяет файл скрипта Test-Runbook.ps1 и использует оператор конвейера для передачи результатов командлету Format-List для форматирования результатов.

Пример 3. Тестирование файла скрипта без метаданных

Test-ScriptFileInfo -Path "D:\code\Hello-World.ps1"

Test-ScriptFileInfo : Script 'D:\code\Hello-World.ps1' is missing required metadata properties. Verify that the script file has Version, Description
and Author properties. You can use the Update-ScriptFileInfo or New-ScriptFileInfo cmdlet to add or update the PSScriptInfo to the script file.
At line:1 char:1
+ Test-ScriptFileInfo D:\code\Hello-World.ps1
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : InvalidArgument: (D:\code\Hello-World.ps1:String) [Test-ScriptFileInfo], ArgumentException

+ FullyQualifiedErrorId : MissingRequiredPSScriptInfoProperties,Test-ScriptFile

Эта команда проверяет файл скрипта Hello-World.ps1, с которым не связаны метаданные.

Параметры

-LiteralPath

Указывает путь к одному или нескольким расположениям. В отличие от параметра Path , значение параметра LiteralPath используется точно так, как оно введено. Никакие символы не интерпретируются как знаки подстановки. Если путь содержит escape-символы, заключите их в одинарные кавычки. Одинарные кавычки предписывают PowerShell не интерпретировать какие-либо символы как escape-последовательности.

Параметр сопоставляется с параметром Path объекта Test-PSScriptFileInfo.

Type:String
Aliases:PSPath
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

Указывает путь к одному или нескольким расположениям. Разрешено использовать подстановочные знаки. Расположением по умолчанию является текущий каталог (.).

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

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

String

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

Object