feat(vscode, tests): ✨ Add new PowerShell debug configurations and enhance psake file

* Introduced two new launch configurations for debugging PowerShell scripts in VSCode.
* Updated `psakeFile.ps1` to correct property casing and added functionality to control documentation overwrite behavior.
* Enhanced tests to verify the documentation overwrite feature.

Author: HeyItsGilbert

.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": ""
         }
     ]
-}
+}

tests/TestModule/psakeFile.ps1

@@ -1,6 +1,6 @@
 Import-Module ../../Output/PowerShellBuild -Force
 
-properties {
+Properties {
     # Pester can build the module using both scenarios
     if (Test-Path -Path 'Variable:\PSBuildCompile') {
         $PSBPreference.Build.CompileModule = $global:PSBuildCompile
@@ -15,21 +15,26 @@ properties {
     $PSBPreference.Build.Exclude = ('excludeme.txt', 'excludemealso*', 'dontcopy')
 
     # If compiling, insert headers/footers for entire PSM1 and for each inserted function
-    $PSBPreference.Build.CompileHeader       = '# Module Header' + [Environment]::NewLine
-    $PSBPreference.Build.CompileFooter       = '# Module Footer'
+    $PSBPreference.Build.CompileHeader = '# Module Header' + [Environment]::NewLine
+    $PSBPreference.Build.CompileFooter = '# Module Footer'
     $PSBPreference.Build.CompileScriptHeader = '# Function header'
     $PSBPreference.Build.CompileScriptFooter = '# Function footer' + [Environment]::NewLine
 
     # So Pester InModuleScope works
-    $PSBPreference.Test.ImportModule           = $true
-    $PSBPreference.Test.CodeCoverage.Enabled   = $true
+    $PSBPreference.Test.ImportModule = $true
+    $PSBPreference.Test.CodeCoverage.Enabled = $true
     $PSBPreference.Test.CodeCoverage.Threshold = 0.0
     $PSBPreference.Test.CodeCoverage.OutputFile = 'cc.xml'
 
     # Override the default output directory
     $PSBPreference.Build.OutDir = 'Output'
+
+    # Don't overwrite the docs
+    $PSBPreference.Docs.Overwrite = $false
 }
 
-task default -depends Build
+Task default -depends Build
+
+Task Build -FromModule PowerShellBuild -minimumVersion 0.5.0
+
 
-task Build -FromModule PowerShellBuild -minimumVersion 0.5.0

tests/build.tests.ps1

@@ -19,7 +19,7 @@ Describe 'Build' {
             Write-Host "OutputPath: $script:testModuleOutputPath"
 
             # build is PS job so psake doesn't freak out because it's nested
-            Start-Job -ScriptBlock {
+            Start-Job -Scriptblock {
                 Set-Location $using:PSScriptRoot/TestModule
                 $global:PSBuildCompile = $true
                 ./build.ps1 -Task Build
@@ -66,12 +66,38 @@ Describe 'Build' {
         It 'Has MAML help XML' {
             "$script:testModuleOutputPath/en-US/TestModule-help.xml" | Should -Exist
         }
+
+        It 'Can Overwrite the Docs' {
+            # Replace with a different string to test the overwrite
+            $docPath = "$PSScriptRoot/TestModule/docs/en-US/Get-HelloWorld.md"
+            $original = Get-Content $docPath -Raw
+            $new = $original -replace 'Hello World', 'Hello Universe'
+            Set-Content $docPath -Value $new -Force
+            # Test that the file was updated
+            Get-Content $docPath -Raw | Should -BeExactly $new
+
+            # Update the psake file
+            $psakeFile = "$PSScriptRoot/TestModule/psakeFile.ps1"
+            $psakeFileContent = Get-Content $psakeFile -Raw
+            $psakeFileContent = $psakeFileContent -replace '\$PSBPreference.Docs.Overwrite = \$false', '$PSBPreference.Docs.Overwrite = $true'
+            Set-Content $psakeFile -Value $psakeFileContent -Force
+
+            # build is PS job so psake doesn't freak out because it's nested
+            Start-Job -ScriptBlock {
+                Set-Location $using:PSScriptRoot/TestModule
+                $global:PSBuildCompile = $true
+                ./build.ps1 -Task Build
+            } | Wait-Job
+
+            # Test that the file reset as expected
+            Get-Content $docPath -Raw | Should -BeExactly $original
+        }
     }
 
     Context 'Dot-sourced module' {
         BeforeAll {
             # build is PS job so psake doesn't freak out because it's nested
-            Start-Job -ScriptBlock {
+            Start-Job -Scriptblock {
                 Set-Location $using:PSScriptRoot/TestModule
                 $global:PSBuildCompile = $false
                 ./build.ps1 -Task Build