-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generate PesterConfiguration section on Configuration page
- Loading branch information
Showing
2 changed files
with
217 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| <# | ||
| .SYNOPSIS | ||
| Updates the Configuration page with latest PesterConfiguration Sections and Options | ||
| #> | ||
| [CmdletBinding()] | ||
| param ( | ||
| [Parameter(Mandatory = $False)][string] | ||
| $PesterVersion, | ||
| [ValidateScript({ Test-Path -Path $_ -PathType Leaf })] | ||
| $ConfigurationPagePath = "$PSScriptRoot/docs/usage/configuration.mdx" | ||
| ) | ||
|
|
||
| #region helpers | ||
| function Format-NicelyMini ($value) { | ||
| if ($value -is [bool]) { | ||
| if ($value) { | ||
| '$true' | ||
| } else { | ||
| '$false' | ||
| } | ||
| } | ||
|
|
||
| if ($value -is [int] -or $value -is [decimal]) { | ||
| return $value | ||
| } | ||
|
|
||
| if ($value -is [string]) { | ||
| if ([String]::IsNullOrEmpty($value)) { | ||
| return '$null' | ||
| } else { | ||
| return "'$value'" | ||
| } | ||
| } | ||
|
|
||
| # does not work with [object[]] when building for some reason | ||
| if ($value -is [System.Collections.IEnumerable]) { | ||
| if (0 -eq $value.Count) { | ||
| return '@()' | ||
| } | ||
| $v = foreach ($i in $value) { | ||
| Format-NicelyMini $i | ||
| } | ||
| return "@($($v -join ', '))" | ||
| } | ||
| } | ||
| #endregion | ||
|
|
||
| $startComment = 'GENERATED_PESTER_CONFIGURATION_DOCS_START' | ||
| $endComment = 'GENERATED_PESTER_CONFIGURATION_DOCS_END' | ||
|
|
||
| if ($PSBoundParameters.ContainsKey('PesterVersion')) { | ||
| Import-Module Pester -RequiredVersion $PesterVersion | ||
| } else { | ||
| Import-Module Pester | ||
| } | ||
|
|
||
| # generate help for config object and insert it | ||
| $configObject = New-PesterConfiguration | ||
| $eol = "`n" | ||
| $encoding = 'UTF8' | ||
|
|
||
| $generatedConfigDocs = foreach ($configSection in $configObject.PSObject.Properties) { | ||
| $sectionName = $configSection.Name | ||
| $sectionDescription = $configSection.Value | ||
| $section = $configObject.($sectionName) | ||
|
|
||
| $options = foreach ($optionName in $section.PSObject.Properties.Name) { | ||
| $option = $section.$optionName | ||
| $default = Format-NicelyMini $option.Default | ||
| "| ${optionName} | $($option.Description) | ``$($default)`` |" | ||
| } | ||
|
|
||
|
|
||
| @" | ||
| ### ${sectionName} | ||
| $sectionDescription | ||
| | Option | Description | Default | | ||
| |--------|-------------|--------:| | ||
| $($options -join $eol) | ||
| "@ | ||
| } | ||
|
|
||
| $pageContent = Get-Content $ConfigurationPagePath -Encoding $encoding | ||
| $sbf = [System.Text.StringBuilder]'' | ||
| $sectionFound = $false | ||
|
|
||
| foreach ($line in $pageContent) { | ||
| if (-not $sectionFound -and $line -match $startComment) { | ||
| $null = $sbf.AppendLine("$line$eol") | ||
| $sectionFound = $true | ||
| $null = $sbf.AppendJoin($eol, $generatedConfigDocs) | ||
| } elseif ($sectionFound -and ($line -match $endComment)) { | ||
| $sectionFound = $false | ||
| } | ||
| if (-not $sectionFound) { | ||
| $null = $sbf.AppendLine($line) | ||
| } | ||
| } | ||
|
|
||
| Set-Content -Encoding $encoding -Value $sbf.ToString().TrimEnd() -Path $ConfigurationPagePath |