Compendium.PowerShell 1.0.0

PowerShell Module

This dotnet template will create a new PowerShell module with boilerplate setup for the module and data files. Please make sure to fill in the data file fields and attributes for Author, Description, Tags, and any other relevant fields. Additionally, stubs for a class, public, and private functions as well as Pester tests have been created to get you up and running quickly.

Getting Started

The following guide will get you started using the template, how to run Pester tests, and how to add classes and functions.

dotnet new

To set up a new PowerShell module using the dotnet template run the following command

dotnet new powershell --moduleName <name>

Quickstart

example:

dotnet new powershell --moduleName Book
Import-Module -Name 'Pester' # Make sure you are using the latest version of Pester (eg >= 5.7), see: https://pester.dev/docs/introduction/installation
Invoke-Pester -Path './Book'
Import-Module -Name './Book'
$books = @(
    [Book]::new('Book 1', @{ powershell = 'module' })
    [Book]::new('Book 2', @{ powershell = 'module' })
)
$books[1].Name
$books | Find-Book -Name 'Book 1'

Adding Classes

Add new classes in the Classes folder. Once a new class has been added and you want it to be available when a user imports the module make sure to add it to the $ExportableTypes variable in the module file.

Adding Functions

Public functions should be added in the Public folder. New functions also need to be added to the FunctionsToExport field in the data file. Private functions should be added in the Private folder and will only be accessible from within the module itself.

Testing

This template comes with boilerplate tests using Pester for the built in files which tests both a function and a method of the class. Make sure you are using the latest version of Pester (>= 5.7) - Pester comes pre-installed on Windows 10/Windows Server 2016 with an older version by default and newer versions can be installed side-by-side, see https://pester.dev/docs/introduction/installation for installation details.

Template

The template contains the following folder structure:

.
├── <module-name>/<module-name>.psd1
├── <module-name>/<module-name>.psm1
├── <module-name>/README.md
├── <module-name>/Classes/
│   ├── <module-name>.ps1
├── <module-name>/Private/
│   ├── Test-<module-name>.ps1
├── <module-name>/Public/
│   ├── Find-<module-name>.ps1
├── <module-name>/Test/
│   ├── <module-name>.GetTag.Tests.ps1
│   ├── Find-<module-name>.Tests.ps1