Skip to content

[Utilities] Enabled no-param blocks #2134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexanderSehr merged 4 commits into from
Sep 27, 2022
Merged

[Utilities] Enabled no-param blocks #2134

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2550c90
Enabled no-param blocks
AlexanderSehr Sep 26, 2022
9be0c89
Update to latest
AlexanderSehr Sep 26, 2022
ee130bf
regenerated readmes
eriqua Sep 27, 2022
2096b39
Small fix
AlexanderSehr Sep 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions utilities/tools/Set-ModuleReadMe.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ function Set-ParametersSection {
# 2. Create header including optional columns
$newSectionContent += @(
('**{0} parameters**' -f $category),
(''),
'',
('| Parameter Name | Type | {0}{1}Description |' -f ($hasDefault ? 'Default Value | ' : ''), ($hasAllowed ? 'Allowed Values | ' : '')),
('| :-- | :-- | {0}{1}:-- |' -f ($hasDefault ? ':-- | ' : ''), ($hasAllowed ? ':-- | ' : ''))
)
Expand Down Expand Up @@ -650,6 +650,11 @@ function ConvertTo-FormattedJSONParameterObject {
[string] $BicepParamBlock
)

if ([String]::IsNullOrEmpty($BicepParamBlock)) {
# Case: No mandatory parameters
return @{}
}

# [1/4] Detect top level params for later processing
$bicepParamBlockArray = $BicepParamBlock -split '\n'
$topLevelParamIndent = ([regex]::Match($bicepParamBlockArray[0], '^(\s+).*')).Captures.Groups[1].Value.Length
Expand Down Expand Up @@ -966,8 +971,14 @@ function Set-DeploymentExamplesSection {
$rawBicepExampleArray = $rawBicepExample -split '\n'
$moduleDeploymentPropertyIndent = ([regex]::Match($rawBicepExampleArray[1], '^(\s+).*')).Captures.Groups[1].Value.Length
$paramsStartIndex = ($rawBicepExampleArray | Select-String ("^[\s]{$moduleDeploymentPropertyIndent}params:[\s]*\{") | ForEach-Object { $_.LineNumber - 1 })[0] + 1
$paramsEndIndex = ($rawBicepExampleArray[($paramsStartIndex + 1)..($rawBicepExampleArray.Count)] | Select-String "^[\s]{$moduleDeploymentPropertyIndent}\}" | ForEach-Object { $_.LineNumber - 1 })[0] + $paramsStartIndex
$paramBlock = ($rawBicepExampleArray[$paramsStartIndex..$paramsEndIndex] | Out-String).TrimEnd()
if ($rawBicepExampleArray[$paramsStartIndex].Trim() -ne '}') {
# Handle case where param block is empty
$paramsEndIndex = ($rawBicepExampleArray[($paramsStartIndex + 1)..($rawBicepExampleArray.Count)] | Select-String "^[\s]{$moduleDeploymentPropertyIndent}\}" | ForEach-Object { $_.LineNumber - 1 })[0] + $paramsStartIndex
$paramBlock = ($rawBicepExampleArray[$paramsStartIndex..$paramsEndIndex] | Out-String).TrimEnd()
} else {
$paramBlock = ''
$paramsEndIndex = $paramsStartIndex
}

# [5/6] Convert Bicep parameter block to JSON parameter block to enable processing
$conversionInputObject = @{
Expand All @@ -987,7 +998,12 @@ function Set-DeploymentExamplesSection {
# --------------------- #
if ($addBicep) {

$formattedBicepExample = $rawBicepExample[0..($paramsStartIndex - 1)] + ($bicepExample -split '\n') + $rawBicepExample[($paramsEndIndex + 1)..($rawBicepExample.Count)]
if ([String]::IsNullOrEmpty($paramBlock)) {
# Handle case where param block is empty
$formattedBicepExample = $rawBicepExample[0..($paramsStartIndex - 1)] + $rawBicepExample[($paramsEndIndex)..($rawBicepExample.Count)]
} else {
$formattedBicepExample = $rawBicepExample[0..($paramsStartIndex - 1)] + ($bicepExample -split '\n') + $rawBicepExample[($paramsEndIndex + 1)..($rawBicepExample.Count)]
}

$SectionContent += @(
'',
Expand Down