Skip to content

Files

Latest commit

 

History

History
45 lines (32 loc) · 1.25 KB

MissingModuleManifestField.md

File metadata and controls

45 lines (32 loc) · 1.25 KB

Pattern: Missing module manifest field

Issue: -

Description

A module manifest is a .psd1 file that contains a hash table. The keys and values in the hash table describe the contents and attributes of the module, define the prerequisites, and determine how the components are processed.

Module manifests must contain the following keys (and a corresponding value) to be considered valid:

  • ModuleVersion

All other keys are optional. The order of the entries is not important.

How

Please consider adding the missing fields to the manifest.

Example of incorrect code:

@{
    Author              = 'PowerShell Author'
    NestedModules       = @('.\mymodule.psm1')
    FunctionsToExport   = '*'
    CmdletsToExport     = '*'
    VariablesToExport   = '*'
}

Example of correct code:

@{
    ModuleVersion       = '1.0'
    Author              = 'PowerShell Author'
    NestedModules       = @('.\mymodule.psm1')
    FunctionsToExport   = '*'
    CmdletsToExport     = '*'
    VariablesToExport   = '*'
}

Further Reading