Public Source
This folder contains the public classes, enums, and functions used by this module as well as their unit tests.
During module composition, the code in this folder (except for the tests) is placed into the
generated Documentarian.MicrosoftDocs.psm1
file.
- [Classes]
- [Enums]
- [Functions]
- [Completion]
- [Configuration]
- [General]
Classes
This folder contains the public classes used by this module and their unit tests. During
composition, these classes are also included in the generated Init.ps1
file, which enables
automatic import of the public classes into the caller’s session for direct use.
The .LoadOrder.jsonc
file determines the order the classes should be
loaded during composition; this is critical to ensure nothing breaks.
Enums
This folder contains the public enums used by this module and their unit tests. During composition,
these enums are also included in the generated Init.ps1
file, which enables automatic import of
the public enums into the caller’s session for direct use.
The .LoadOrder.jsonc
file determines the order the classes should be
loaded during composition; this is critical to ensure nothing breaks.
Functions
This folder contains the public functions used by this module and their unit tests. The public
functions are broken down into a few groups: Completion
, Configuration
, and General
.
Completion
This folder contains functions for registering argument completers so users do not need to assemble
their own scriptblocks and call Register-ArgumentCompleter
.
Configuration
This folder contains functions for interacting with this module’s configuration state. Unless there
is a good reason, they should always come in a trio: Get
, Set
, and Remove
.
General
This folder contains functions which do not fit into another category. These functions are “normal” PowerShell functions you might find in any other module.