By: errwic

errwic — Sat, 30 Dec 2023 04:16:01 +0000

In reply to jim. thank you so much, ive searched sooo many post trying to figure out why my module wouldnt load

By: Nathan Bartell

Nathan Bartell — Tue, 27 Jun 2023 22:54:48 +0000

Great article! Did you ever write an article about module manifests? We have many (many) scripts and we’re trying to come up with the best way to organize them so we can use them in Runbooks. I have a software development background so I’m trying to merge that with the powershell world. Thanks!

By: jim

jim — Thu, 22 Jun 2023 13:42:26 +0000

Grouping all the functions into a single .psm1 file is probably the worst advice that can be given to someone starting out with modules. It is not difficult to understand a best practice approach to creating modules with public, private and tests folders.
Module Folder
module.psd1 – Manifest, can use New-ModuleManifest to create
module.psm1 – Contains functions to import all .ps1 files into memory and export public functions
public – Contains functions that are exported
private – Contains internal module functions
tests – Contains Pester unit tests for module

To load all the .ps1 files from the module.psm1 file use:
Get-ChildItem -Path $PSScriptRoot\private, $PSScriptRoot\public -Filter *.ps1 | ForEach-Object { . $_ }
To export the public functions from the module.psm1 file use:
Get-ChildItem -Path $PSScriptRoot\public\*.ps1 | ForEach-Object { Export-ModuleMember -Function $_.Basename }

Then you just add new .ps1 files to the public or private folders to create new private or public functions.
Yes your post was “basic”, but not providing the best practice approach is doing a disservice.

Comments on: A Best Practice Guide To Creating A Powershell Module

By: errwic

By: Nathan Bartell

By: jim