ModuleAssembler

ModuleAssembler configuration file

Type object
File match **/.moduleassembler/moduleproject.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/moduleassembler/latest.json
Source https://raw.githubusercontent.com/ModuleAssembler/ModuleAssembler-Schema/refs/tags/v1.0.0/schema/moduleassembler.schema.json

Versions

1.0.0

Validate with Lintel

npx @lintel/lintel check
Type: object

ModuleAssembler data utilized when building a module.

Properties

ProjectName string required

Name of the module project.

Description string required

Description of the functionality provided by this module.

Version string required

Version number of this module, use Semantic Versioning.

Manifest object required

PowerShell Module Manifest Configuration Items.

9 nested properties
Author string required

Author of this module.

PowerShellVersion string required

Minimum version of the PowerShell engine required by this module.

GUID string required

ID used to uniquely identify this module.

CompanyName string

Company or vendor of this module.

Tags string[]

Tags applied to this module. These help with module discovery in online galleries.

ProjectUri string

A URL to the main website for this project.

LicenseUri string

A URL to the license for this project.

IconUri string

A URL to an icon representing this module.

RequiredModules object[]

Modules that must be imported into the global environment.

CopyResourcesToModuleRoot boolean

Specifies if resource files will be placed in the built module's root directory, instead of in a resources subfolder.

Default: false
Pester object

Pester Configuration Items.

3 nested properties
CodeCoverage object

Code Coverage Configuration.

3 nested properties
Enabled boolean required

Enable Code Coverage.

Default: false
OutputFormat string

Format to use for code coverage report. Valid options are JaCoCo, CoverageGutters, Cobertura.

Default: "JaCoCo"
pattern=^(JaCoCo|CoverageGutters|Cobertura)$
CoveragePercentTarget number

Target percent of code coverage that you want to achieve.

Default: 75
min=0max=100
TestResult object

Test Result Configuration.

2 nested properties
Enabled boolean required

Enable Test Results.

Default: true
OutputFormat string

Format to use for test result report. Valid values NUnitXml, NUnit2.5, NUnit3 or JUnitXml.

Default: "JUnitXml"
pattern=^(NUnitXml|NUnit2\.5|NUnit3|JUnitXml)$
Output object

Output Configuration.

1 nested properties
Verbosity string required

The verbosity of output. Valid options are None, Normal, Detailed or Diagnostic.

Default: "Detailed"
pattern=^(None|Normal|Detailed|Diagnostic)$