en-US/PSScriptModule/PSScriptModule-Help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh"> <command:command> <command:details> <command:name>Get-ModuleMetadata</command:name> <maml:description> <maml:para>Retrieves metadata information from PowerShell module manifest files</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>ModuleMetadata</command:noun> </command:details> <maml:description> <maml:para>Reads and extracts metadata from PowerShell module manifest (.psd1) files, including version, author, description, and exported functions. Supports pipeline input for processing multiple modules.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ModuleMetadata</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSize</maml:name> <maml:description> <maml:para>Include the file size of the module in the output</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the module manifest file (.psd1) or directory containing a manifest. Accepts wildcards for batch processing.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSize</maml:name> <maml:description> <maml:para>Include the file size of the module in the output</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the module manifest file (.psd1) or directory containing a manifest. Accepts wildcards for batch processing.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>System.IO.FileInfo {{ Fill in the Description }}</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>PSCustomObject</dev:name> </dev:type> <maml:description> <maml:para>Returns objects with module metadata properties {{ Fill in the Description }}</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <dev:name>System.Management.Automation.PSObject</dev:name> </dev:type> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Validates manifest files before processing to ensure data integrity. Uses fail-fast approach for invalid inputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>Get-ModuleMetadata -Path ./MyModule/MyModule.psd1</maml:para> <maml:para>€</maml:para> <maml:para>Retrieves metadata from the specified module manifest file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>Get-ChildItem -Path ./modules -Filter *.psd1 -Recurse | Get-ModuleMetadata</maml:para> <maml:para>€</maml:para> <maml:para>Processes multiple module manifests through the pipeline.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>Get-ModuleMetadata -Path ./MyModule -IncludeSize</maml:para> <maml:para>€</maml:para> <maml:para>Retrieves metadata and includes formatted file size information.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri>https://github.com/YourUsername/PSScriptModule</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText /> <command:uri>https://github.com/YourUsername/PSScriptModule</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |