Making Your Module Posh

[StartAutomating]

Do you write a PowerShell module?

Posh is pretty easy to integrate with and can improve your module's user experience.

Posh extends module information with a number of properties and methods.

Broadly speaking, there are two ways to do this:

1. Adding information to your module manifest
2. Adding special file types within your module

Let's walk thru each type of integration your module can do:

Demos

Any *.demo.ps1 file within a module will be available in a given module's .Demo(s) property

Demo files can be played using ShowDemo

Screenshots

A list of screenshots can be added to any module.

These screenshots will be available in any given module's .Screenshot(s) property.

For an example of this, look at the Posh module manifest.

Videos

A list of videos can be added to any module.

These videos will be available in any given module's .Videos(s) property

Recommendations

A list of recommended modules or URLs can be provided in a module's manifest. This list is often a series of module names.

Each module name will create a link to the gallery.

Tests

All *.tests.ps1 files within a module's directory will be available in any given module's .Test(s) property.

.test.ps1 files can be run using Pester