Skip to content

Commit a6cbb4f

Browse files
authored
Merge pull request #10 from schittli/master
task UpdateCBH: Bug fixed in updating Comment Based Help in functions to point to external help
2 parents 545dc66 + e4e5214 commit a6cbb4f

3 files changed

Lines changed: 17 additions & 14 deletions

File tree

ModuleBuild.build.ps1

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ param (
1010
)
1111

1212
Function Write-Description {
13-
# Basic indented descriptive build output.
14-
param (
13+
# Basic indented descriptive build output. $Description can contain Newlines.
14+
Param (
1515
[string]$color = 'White',
1616
[string]$Description = '',
1717
[int]$Level = 0,
@@ -22,11 +22,12 @@ Function Write-Description {
2222
)
2323

2424
$thisindent = (' ' * $indent) * $level
25-
if ($accent) {
25+
If ($accent) {
2626
$accentleft = $AccentL
2727
$accentright = $AccentR
2828
}
29-
Write-Build $color "$accentleft$thisindent$Description$accentright"
29+
30+
$Description -split '\r\n|\n' | ForEach-Object { Write-Build $color "$accentleft$thisindent$($_)$accentright" }
3031
}
3132

3233
if (Test-Path $BuildFile) {
@@ -445,14 +446,14 @@ task UpdateCBH {
445446
"@
446447

447448
$ScratchPath = Join-Path $BuildRoot $Script:BuildEnv.ScratchFolder
448-
$CBHPattern = "(?ms)(\<#.*\.SYNOPSIS.*?#>)"
449+
[Regex]$CBHPattern = '(?ms)\<\#(\#(?!\>)|[^#])*\#\>'
449450
Get-ChildItem -Path "$($ScratchPath)\$($Script:BuildEnv.PublicFunctionSource)\*.ps1" -File | ForEach-Object {
450451
$FormattedOutFile = $_.FullName
451452
$FileName = $_.Name
452453
Write-Description White "Replacing CBH in file: $($FileName)" -level 2
453454
$FunctionName = $FileName -replace '.ps1', ''
454455
$NewExternalHelp = $ExternalHelp -replace '{{LINK}}', ($Script:BuildEnv.ModuleWebsite + "/tree/master/$($Script:BuildEnv.BaseReleaseFolder)/$($Script:BuildEnv.ModuleVersion)/docs/Functions/$($FunctionName).md")
455-
$UpdatedFile = (get-content $FormattedOutFile -raw) -replace $CBHPattern, $NewExternalHelp
456+
$UpdatedFile = $CBHPattern.Replace( (Get-Content $FormattedOutFile -raw), $NewExternalHelp, 1)
456457
$UpdatedFile | Out-File -FilePath $FormattedOutFile -force -Encoding $Script:BuildEnv.Encoding
457458
}
458459
}

plaster/ModuleBuild/scaffold/modulename.build.template

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
[switch]$Force
1010
)
1111

12-
# Basic indented descriptive build output.
1312
Function Write-Description {
14-
param (
13+
# Basic indented descriptive build output. $Description can contain Newlines.
14+
Param (
1515
[string]$color = 'White',
1616
[string]$Description = '',
1717
[int]$Level = 0,
@@ -22,11 +22,12 @@ Function Write-Description {
2222
)
2323

2424
$thisindent = (' ' * $indent) * $level
25-
if ($accent) {
25+
If ($accent) {
2626
$accentleft = $AccentL
2727
$accentright = $AccentR
2828
}
29-
Write-Build $color "$accentleft$thisindent$Description$accentright"
29+
30+
$Description -split '\r\n|\n' | ForEach-Object { Write-Build $color "$accentleft$thisindent$($_)$accentright" }
3031
}
3132

3233
if (Test-Path $BuildFile) {

release/ModuleBuild/plaster/ModuleBuild/scaffold/modulename.build.template

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
[switch]$Force
1010
)
1111

12-
# Basic indented descriptive build output.
1312
Function Write-Description {
14-
param (
13+
# Basic indented descriptive build output. $Description can contain Newlines.
14+
Param (
1515
[string]$color = 'White',
1616
[string]$Description = '',
1717
[int]$Level = 0,
@@ -22,11 +22,12 @@ Function Write-Description {
2222
)
2323

2424
$thisindent = (' ' * $indent) * $level
25-
if ($accent) {
25+
If ($accent) {
2626
$accentleft = $AccentL
2727
$accentright = $AccentR
2828
}
29-
Write-Build $color "$accentleft$thisindent$Description$accentright"
29+
30+
$Description -split '\r\n|\n' | ForEach-Object { Write-Build $color "$accentleft$thisindent$($_)$accentright" }
3031
}
3132

3233
if (Test-Path $BuildFile) {

0 commit comments

Comments
 (0)