fix(Publish-PSBuildModule, Test-PSBuildPester): ✨ Improve parameter handling and suppress warnings

* Added suppression attributes for unused parameters in `Publish-PSBuildModule` and `Test-PSBuildPester`.
* Enhanced `CmdletBinding` attribute casing for consistency.
* Refined parameter validation logic for better clarity and maintainability.

Author: HeyItsGilbert

PowerShellBuild/Public/Publish-PSBuildModule.ps1

@@ -1,4 +1,9 @@
 function Publish-PSBuildModule {
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSReviewUnusedParameter',
+        '',
+        Justification = 'Both Credential and NuGetApiKey are used just not via explicit variable call.'
+    )]
     <#
     .SYNOPSIS
         Publishes a module to the defined PowerShell repository.
@@ -27,18 +32,18 @@ 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')]
+    [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

@@ -1,4 +1,9 @@
 function Test-PSBuildPester {
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSReviewUnusedParameter',
+        'CodeCoverageThreshold',
+        Justification = 'Used inside a foreach method call.'
+    )]
     <#
     .SYNOPSIS
         Execute Pester tests for module.
@@ -27,11 +32,11 @@ 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()]
     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 -->