0.7.1: Fix Build-PSBuildMarkdown + Lint Fixes

.vscode/launch.json

@@ -4,11 +4,35 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
+        {
+            "name": "Run Build and Debug (Temp Console)",
+            "type": "PowerShell",
+            "request": "launch",
+            "script": "${cwd}/build.ps1",
+            "args": [
+                "-Task Test",
+                "-Verbose"
+            ],
+            "cwd": "${workspaceFolder}",
+            "createTemporaryIntegratedConsole": true
+        },
+        {
+            "name": "Run Build and Debug",
+            "type": "PowerShell",
+            "request": "launch",
+            "script": "${cwd}/build.ps1",
+            "args": [
+                "-Task Test",
+                "-Verbose"
+            ],
+            "cwd": "${workspaceFolder}",
+            "createTemporaryIntegratedConsole": true
+        },
         {
             "name": "PowerShell: Interactive Session",
             "type": "PowerShell",
             "request": "launch",
             "cwd": ""
         }
     ]
-}
+}

.vscode/settings.json

@@ -6,5 +6,6 @@
     "powershell.codeFormatting.addWhitespaceAroundPipe": true,
     "powershell.codeFormatting.useCorrectCasing": true,
     "powershell.codeFormatting.newLineAfterOpenBrace": true,
-    "powershell.codeFormatting.alignPropertyValuePairs": true
+    "powershell.codeFormatting.alignPropertyValuePairs": true,
+    "powershell.scriptAnalysis.settingsPath": "tests/ScriptAnalyzerSettings.psd1"
 }

.vscode/tasks.json

@@ -2,33 +2,42 @@
     // See https://go.microsoft.com/fwlink/?LinkId=733558
     // for the documentation about the tasks.json format
     "version": "2.0.0",
-
     // Start PowerShell (pwsh on *nix)
     "windows": {
         "options": {
             "shell": {
-                "executable": "powershell.exe",
-                "args": [ "-NoProfile", "-ExecutionPolicy", "Bypass", "-Command" ]
+                "executable": "pwsh.exe",
+                "args": [
+                    "-NoProfile",
+                    "-ExecutionPolicy",
+                    "Bypass",
+                    "-Command"
+                ]
             }
         }
     },
     "linux": {
         "options": {
             "shell": {
                 "executable": "/usr/bin/pwsh",
-                "args": [ "-NoProfile", "-Command" ]
+                "args": [
+                    "-NoProfile",
+                    "-Command"
+                ]
             }
         }
     },
     "osx": {
         "options": {
             "shell": {
                 "executable": "/usr/local/bin/pwsh",
-                "args": [ "-NoProfile", "-Command" ]
+                "args": [
+                    "-NoProfile",
+                    "-Command"
+                ]
             }
         }
     },
-
     "tasks": [
         {
             "label": "Clean",

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.7.1] 2025-03-31 Bugfix
+
+### Fixed
+
+- Remove extra item from `New-MarkdownHelp` splat that would result in a failure
+  when using `$PSBPreference.Docs.Overwrite = $true`
+- Clean up some failing Script Analyzer settings, including moving the file.
+
 ## [0.7.0] 2025-03-31
 
 ### Changed

PowerShellBuild/PowerShellBuild.psd1

@@ -1,6 +1,6 @@
 @{
     RootModule        = 'PowerShellBuild.psm1'
-    ModuleVersion     = '0.7.0'
+    ModuleVersion     = '0.7.1'
     GUID              = '15431eb8-be2d-4154-b8ad-4cb68a488e3d'
     Author            = 'Brandon Olin'
     CompanyName       = 'Community'

PowerShellBuild/Public/Build-PSBuildMarkdown.ps1

@@ -19,7 +19,7 @@ function Build-PSBuildMarkdown {
 
         Analysis the comment-based help of the MyModule module and create markdown documents under ./docs/en-US.
     #>
-    [cmdletbinding()]
+    [CmdletBinding()]
     param(
         [parameter(Mandatory)]
         [string]$ModulePath,
@@ -57,12 +57,11 @@ function Build-PSBuildMarkdown {
 
         # ErrorAction set to SilentlyContinue so this command will not overwrite an existing MD file.
         $newMDParams = @{
-            Module = $ModuleName
-            Locale = $Locale
+            Module       = $ModuleName
+            Locale       = $Locale
             OutputFolder = [IO.Path]::Combine($DocsPath, $Locale)
-            ErrorAction = 'SilentlyContinue'
-            Verbose = $VerbosePreference
-            Force = $Overwrite
+            ErrorAction  = 'SilentlyContinue'
+            Verbose      = $VerbosePreference
         }
         if ($Overwrite) {
             $newMDParams.Add('Force', $true)

PowerShellBuild/Public/Publish-PSBuildModule.ps1

@@ -27,18 +27,23 @@ function Publish-PSBuildModule {
 
         Publish version 0.1.0 of the module at path .\Output\0.1.0\MyModule to the PSGallery repository using an API key and a PowerShell credential.
     #>
-    [cmdletbinding(DefaultParameterSetName = 'ApiKey')]
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSReviewUnusedParameter',
+        '',
+        Justification = 'Both Credential and NuGetApiKey are used just not via explicit variable call.'
+    )]
+    [CmdletBinding(DefaultParameterSetName = 'ApiKey')]
     param(
         [parameter(Mandatory)]
         [ValidateScript({
-            if (-not (Test-Path -Path $_ )) {
-                throw 'Folder does not exist'
-            }
-            if (-not (Test-Path -Path $_ -PathType Container)) {
-                throw 'The Path argument must be a folder. File paths are not allowed.'
-            }
-            $true
-        })]
+                if (-not (Test-Path -Path $_ )) {
+                    throw 'Folder does not exist'
+                }
+                if (-not (Test-Path -Path $_ -PathType Container)) {
+                    throw 'The Path argument must be a folder. File paths are not allowed.'
+                }
+                $true
+            })]
         [System.IO.FileInfo]$Path,
 
         [parameter(Mandatory)]

PowerShellBuild/Public/Test-PSBuildPester.ps1

@@ -27,11 +27,16 @@ function Test-PSBuildPester {
     .PARAMETER ImportModule
         Import module from OutDir prior to running Pester tests.
     .EXAMPLE
-        PS> Test-PSBuildPester -Path ./tests -ModuleName Mymodule -OutputPath ./out/testResults.xml
+        PS> Test-PSBuildPester -Path ./tests -ModuleName MyModule -OutputPath ./out/testResults.xml
 
         Run Pester tests in ./tests and save results to ./out/testResults.xml
     #>
-    [cmdletbinding()]
+    [CmdletBinding()]
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSReviewUnusedParameter',
+        'CodeCoverageThreshold',
+        Justification = 'Used inside a foreach method call.'
+    )]
     param(
         [parameter(Mandatory)]
         [string]$Path,
@@ -76,18 +81,18 @@ function Test-PSBuildPester {
 
         Import-Module Pester -MinimumVersion 5.0.0
         $configuration = [PesterConfiguration]::Default
-        $configuration.Output.Verbosity        = 'Detailed'
-        $configuration.Run.PassThru            = $true
-        $configuration.TestResult.Enabled      = -not [string]::IsNullOrEmpty($OutputPath)
-        $configuration.TestResult.OutputPath   = $OutputPath
+        $configuration.Output.Verbosity = 'Detailed'
+        $configuration.Run.PassThru = $true
+        $configuration.TestResult.Enabled = -not [string]::IsNullOrEmpty($OutputPath)
+        $configuration.TestResult.OutputPath = $OutputPath
         $configuration.TestResult.OutputFormat = $OutputFormat
 
         if ($CodeCoverage.IsPresent) {
             $configuration.CodeCoverage.Enabled = $true
             if ($CodeCoverageFiles.Count -gt 0) {
                 $configuration.CodeCoverage.Path = $CodeCoverageFiles
             }
-            $configuration.CodeCoverage.OutputPath   = $CodeCoverageOutputFile
+            $configuration.CodeCoverage.OutputPath = $CodeCoverageOutputFile
             $configuration.CodeCoverage.OutputFormat = $CodeCoverageOutputFileFormat
         }
 
@@ -103,25 +108,25 @@ function Test-PSBuildPester {
                 $textInfo = (Get-Culture).TextInfo
                 [xml]$testCoverage = Get-Content $CodeCoverageOutputFile
                 $ccReport = $testCoverage.report.counter.ForEach({
-                    $total = [int]$_.missed + [int]$_.covered
-                    $perc  = [Math]::Truncate([int]$_.covered / $total)
-                    [pscustomobject]@{
-                        name    = $textInfo.ToTitleCase($_.Type.ToLower())
-                        percent = $perc
-                    }
-                })
+                        $total = [int]$_.missed + [int]$_.covered
+                        $percent = [Math]::Truncate([int]$_.covered / $total)
+                        [PSCustomObject]@{
+                            name    = $textInfo.ToTitleCase($_.Type.ToLower())
+                            percent = $percent
+                        }
+                    })
 
                 $ccFailMsgs = @()
                 $ccReport.ForEach({
-                    'Type: [{0}]: {1:p}' -f $_.name, $_.percent
-                    if ($_.percent -lt $CodeCoverageThreshold) {
-                        $ccFailMsgs += ('Code coverage: [{0}] is [{1:p}], which is less than the threshold of [{2:p}]' -f $_.name, $_.percent, $CodeCoverageThreshold)
-                    }
-                })
+                        'Type: [{0}]: {1:p}' -f $_.name, $_.percent
+                        if ($_.percent -lt $CodeCoverageThreshold) {
+                            $ccFailMsgs += ('Code coverage: [{0}] is [{1:p}], which is less than the threshold of [{2:p}]' -f $_.name, $_.percent, $CodeCoverageThreshold)
+                        }
+                    })
                 Write-Host "`n"
                 $ccFailMsgs.Foreach({
-                    Write-Error $_
-                })
+                        Write-Error $_
+                    })
             } else {
                 Write-Error "Code coverage file [$CodeCoverageOutputFile] not found."
             }

README.md

@@ -25,9 +25,11 @@ Install-Module -Name psake -RequiredVersion 4.8.0 -Repository PSGallery
 > [how to dot source tasks using PowerShell aliases](https://github.com/nightroman/Invoke-Build/blob/master/Tasks/Import/README.md#example-2-import-from-a-module-with-tasks)
 > example.
 
+<!-- markdownlint-disable no-inline-html -->
 <p align="center">
     <img src="media/psaketaskmodule-256x256.png" alt="Logo">
 </p>
+<!-- markdownlint-enable no-inline-html -->
 
 ## Status - Work in progress
 
@@ -195,3 +197,5 @@ $PSBPreference.Test.CodeCoverage.Enabled  = $false
 [psgallery]: https://www.powershellgallery.com/packages/PowerShellBuild
 [license-badge]: https://img.shields.io/github/license/psake/PowerShellBuild.svg
 [license]: https://raw.githubusercontent.com/psake/PowerShellBuild/main/LICENSE
+
+<!-- spell-checker:ignore PSGALLERY psaketaskmodule -->

cspell.json

@@ -11,7 +11,9 @@
     ],
     "words": [],
     "ignoreWords": [
+        "BHPS",
         "psake",
+        "pscredential",
         "MAML"
     ],
     "import": []

psakeFile.ps1

@@ -1,24 +1,24 @@
-properties {
+Properties {
     $settings = . ([IO.Path]::Combine($PSScriptRoot, 'build.settings.ps1'))
     if ($galleryApiKey) {
         $settings.PSGalleryApiKey = $galleryApiKey.GetNetworkCredential().password
     }
 }
 
-task default -depends Test
+Task default -depends Test
 
-task Init {
+Task Init {
     "STATUS: Testing with PowerShell $($settings.PSVersion)"
     'Build System Details:'
     Get-Item ENV:BH*
 } -description 'Initialize build environment'
 
-task Test -Depends Init, Analyze, Pester -description 'Run test suite'
+Task Test -depends Init, Analyze, Pester -description 'Run test suite'
 
-task Analyze -depends Build {
-    $analysis = Invoke-ScriptAnalyzer -Path $settings.ModuleOutDir -Recurse -Verbose:$false -Settings ([IO.Path]::Combine($env:BHModulePath, 'ScriptAnalyzerSettings.psd1'))
-    $errors   = $analysis | Where-Object {$_.Severity -eq 'Error'}
-    $warnings = $analysis | Where-Object {$_.Severity -eq 'Warning'}
+Task Analyze -depends Build {
+    $analysis = Invoke-ScriptAnalyzer -Path $settings.ModuleOutDir -Recurse -Verbose:$false -Settings './tests/ScriptAnalyzerSettings.psd1'
+    $errors = $analysis | Where-Object { $_.Severity -eq 'Error' }
+    $warnings = $analysis | Where-Object { $_.Severity -eq 'Warning' }
     if (@($errors).Count -gt 0) {
         Write-Error -Message 'One or more Script Analyzer errors were found. Build cannot continue!'
         $errors | Format-Table -AutoSize
@@ -30,25 +30,25 @@ task Analyze -depends Build {
     }
 } -description 'Run PSScriptAnalyzer'
 
-task Pester -depends Build {
+Task Pester -depends Build {
     Remove-Module $settings.ProjectName -ErrorAction SilentlyContinue -Verbose:$false
 
     $testResultsXml = [IO.Path]::Combine($settings.OutputDir, 'testResults.xml')
-    $testResults    = Invoke-Pester -Path $settings.Tests -Output Detailed -PassThru
+    $testResults = Invoke-Pester -Path $settings.Tests -Output Detailed -PassThru
 
     if ($testResults.FailedCount -gt 0) {
         $testResults | Format-List
         Write-Error -Message 'One or more Pester tests failed. Build cannot continue!'
     }
 } -description 'Run Pester tests'
 
-task Clean -depends Init {
+Task Clean -depends Init {
     if (Test-Path -Path $settings.ModuleOutDir) {
         Remove-Item -Path $settings.ModuleOutDir -Recurse -Force -Verbose:$false
     }
 }
 
-task Build -depends Init, Clean {
+Task Build -depends Init, Clean {
     New-Item -Path $settings.ModuleOutDir -ItemType Directory -Force > $null
     Copy-Item -Path "$($settings.SUT)/*" -Destination $settings.ModuleOutDir -Recurse
 
@@ -59,7 +59,7 @@ task Build -depends Init, Clean {
     # & .\Build\Convert-PSAke.ps1 $psakePath | Out-File -Encoding UTF8 $ibPath
 }
 
-task Publish -depends Test {
+Task Publish -depends Test {
     "    Publishing version [$($settings.Manifest.ModuleVersion)] to PSGallery..."
     if ($settings.PSGalleryApiKey) {
         Publish-Module -Path $settings.ModuleOutDir -NuGetApiKey $settings.PSGalleryApiKey

requirements.psd1

@@ -4,7 +4,7 @@
     }
     BuildHelpers     = '2.0.16'
     Pester           = @{
-        MinimumVersion = '5.6.1'
+        MinimumVersion = '5.7.1'
         Parameters     = @{
             SkipPublisherCheck = $true
         }