chore: ✨ Update script analysis settings and improve task definitions

* Migrate `ScriptAnalyzerSettings.psd1` to `tests` directory and update paths.
* Enhance task definitions in `psakeFile.ps1` for better readability and consistency.
* Add new exclusion rule for `PSUseApprovedVerbs` in the script analysis settings.

Author: HeyItsGilbert

.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"
 }

PowerShellBuild/ScriptAnalyzerSettings.psd1

@@ -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 ([IO.Path]::Combine('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

psakeFile.ps1

@@ -1,3 +1,15 @@
 @{
-
+    ExcludeRules = @(
+        'PSAvoidUsingWriteHost',
+        'PSUseToExportFieldsInManifest',
+        'PSUseDeclaredVarsMoreThanAssignments',
+        # This throws a warning on Build verb, which is valid as of PSv6
+        'PSUseApprovedVerbs'
+    )
+    Rules        = @{
+        # Don't trip on the task alias. It's by design
+        PSAvoidUsingCmdletAliases = @{
+            Whitelist = @('task')
+        }
+    }
 }