Test-ScriptFileInfo

  • Referensi
Modul:
PowerShellGet

Memvalidasi blok komentar untuk skrip.

Sintaks

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

Deskripsi

Test-ScriptFileInfo Cmdlet memvalidasi blok komentar di awal skrip yang akan diterbitkan dengan cmdlet Publish-Script. Jika blok komentar memiliki kesalahan, cmdlet ini mengembalikan informasi tentang di mana kesalahan berada atau cara memperbaikinya.

Ini adalah cmdlet proksi untuk Test-PSScriptFileInfo cmdlet di Microsoft.PowerShell.PSResourceGet. Untuk informasi selengkapnya, lihat Test-PSScriptFileInfo.

Contoh

Contoh 1: Menguji file skrip

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

Perintah ini menguji file skrip New-ScriptFile.ps1 dan menampilkan hasilnya. File skrip menyertakan metadata yang valid.

Contoh 2: Menguji file skrip yang memiliki nilai untuk semua properti metadata

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

Perintah ini menguji file skrip Test-Runbook.ps1 dan menggunakan operator alur untuk meneruskan hasilnya ke cmdlet Format-List untuk memformat hasilnya.

Contoh 3: Menguji file skrip yang tidak memiliki metadata

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

Perintah ini menguji file skrip Hello-World.ps1, yang tidak memiliki metadata yang terkait dengannya.

Parameter

-LiteralPath

Menentukan jalur ke satu atau beberapa lokasi. Tidak seperti parameter Path , nilai parameter LiteralPath digunakan persis seperti yang dimasukkan. Tidak ada karakter yang ditafsirkan sebagai kartubebas. Jika jalur menyertakan karakter escape, sertakan karakter tersebut dalam tanda kutip tunggal. Tanda kutip tunggal memberi tahu PowerShell untuk tidak menafsirkan karakter apa pun sebagai urutan escape.

Parameter dipetakan ke parameter Jalur dari Test-PSScriptFileInfo.

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

-Path

Menentukan jalur ke satu atau beberapa lokasi. Kartubebas diizinkan. Lokasi default adalah direktori saat ini (.).

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

Input

String

Output

Object