Summary
Three exported public functions have zero comment-based help. Two of them have non-obvious side effects (auto-creating directories and persisting configuration) that must be documented.
Functions
Get-FeatureFlagFolder and Get-PropertySetFolder
Both functions read the configured folder path and, if none is set, create the directory and save the path to configuration automatically. This is a surprising write side effect on a Get- function. The help must document:
- What the function returns
- The first-run behavior (auto-create + persist)
- That
Export-GatekeeperConfig is the preferred way to set paths intentionally
Import-GatekeeperConfig
- Synopsis: loads module configuration with multi-level precedence
- The
-ForceReload switch bypasses the module-scope cache
- Results are cached — subsequent calls are cheap
- Logging scripts are parsed and stored in
$script:GatekeeperLogging
Template
<#
.SYNOPSIS
Returns the configured directory where feature flag JSON files are stored.
.DESCRIPTION
Retrieves the feature flag folder path from the active Gatekeeper configuration.
If no path has been configured, a default location is created under the machine-wide
configuration path and saved automatically.
.OUTPUTS
System.String
.EXAMPLE
$folder = Get-FeatureFlagFolder
Get-ChildItem -Path $folder -Filter '*.json'
.NOTES
This function may write to configuration on first run. Use Export-GatekeeperConfig
to set paths explicitly.
#>
Notes
Summary
Three exported public functions have zero comment-based help. Two of them have non-obvious side effects (auto-creating directories and persisting configuration) that must be documented.
Functions
Get-FeatureFlagFolderandGet-PropertySetFolderBoth functions read the configured folder path and, if none is set, create the directory and save the path to configuration automatically. This is a surprising write side effect on a
Get-function. The help must document:Export-GatekeeperConfigis the preferred way to set paths intentionallyImport-GatekeeperConfig-ForceReloadswitch bypasses the module-scope cache$script:GatekeeperLoggingTemplate
Notes