Update psscriptanalyzer-plus-sarif.yml

Signed-off-by: LUIZ HAMILTON ROBERTO DA SILVA <[email protected]>

Author: brazilianscriptguy

.github/workflows/psscriptanalyzer-plus-sarif.yml

@@ -7,18 +7,16 @@ on:
       - "**/*.ps1"
       - "**/*.psm1"
       - "**/*.psd1"
-      - ".psscriptanalyzer"
-      - ".psscriptanalyzer.json"
       - ".psscriptanalyzer.psd1"
+      - ".psscriptanalyzer.json" # optional: keep only if you still maintain it for humans/tools
   pull_request:
     branches: [main, develop]
     paths:
       - "**/*.ps1"
       - "**/*.psm1"
       - "**/*.psd1"
-      - ".psscriptanalyzer"
-      - ".psscriptanalyzer.json"
       - ".psscriptanalyzer.psd1"
+      - ".psscriptanalyzer.json" # optional
   workflow_dispatch:
 
 concurrency:
@@ -84,7 +82,8 @@ jobs:
         run: |
           $ErrorActionPreference = 'Stop'
           $required  = [version]'${{ env.PSA_VERSION }}'
-          $installed = Get-Module -ListAvailable -Name PSScriptAnalyzer | Sort-Object Version -Descending | Select-Object -First 1
+          $installed = Get-Module -ListAvailable -Name PSScriptAnalyzer |
+            Sort-Object Version -Descending | Select-Object -First 1
 
           if (-not $installed -or $installed.Version -ne $required) {
             Set-PSRepository -Name PSGallery -InstallationPolicy Trusted | Out-Null
@@ -114,6 +113,17 @@ jobs:
           cd "$GITHUB_WORKSPACE"
           printf '%s' '{"$schema":"http://json.schemastore.org/sarif-2.1.0","version":"2.1.0","runs":[{"tool":{"driver":{"name":"PSScriptAnalyzer","version":"0"}},"results":[]}]}' > "${{ env.SARIF_FILE }}"
 
+      - name: ✅ Assert .psscriptanalyzer.psd1 Exists
+        if: steps.check_ps.outputs.count != '0'
+        shell: pwsh
+        run: |
+          $ErrorActionPreference = 'Stop'
+          $settings = Join-Path $env:GITHUB_WORKSPACE ".psscriptanalyzer.psd1"
+          if (-not (Test-Path $settings)) {
+            throw "Missing required PSScriptAnalyzer settings file: $settings"
+          }
+          Write-Host "Using PSScriptAnalyzer settings: $settings"
+
       # ----------------------------
       # SAFE AUTO-FIX (FORMAT FIRST)
       # ----------------------------
@@ -124,7 +134,6 @@ jobs:
           $ErrorActionPreference = 'Stop'
           $root = $env:GITHUB_WORKSPACE
 
-          # Format only script/module/data files
           $files = Get-ChildItem -Path $root -Recurse -File -Include *.ps1,*.psm1,*.psd1 |
             Where-Object {
               $_.FullName -notmatch '[\\/]\.git[\\/]' -and
@@ -134,7 +143,6 @@ jobs:
           foreach ($f in $files) {
             try {
               $formatted = Invoke-Formatter -Path $f.FullName
-              # Keep UTF-8 (no BOM). GitHub runners default to utf8 here.
               $formatted | Set-Content -Path $f.FullName -Encoding utf8
             } catch {
               Write-Warning "Invoke-Formatter failed for: $($f.FullName) :: $($_.Exception.Message)"
@@ -147,44 +155,19 @@ jobs:
         run: |
           $ErrorActionPreference = 'Stop'
 
-          # Prefer repo settings file if present
-          $settingsPath = @(
-            Join-Path $env:GITHUB_WORKSPACE ".psscriptanalyzer.psd1"
-            Join-Path $env:GITHUB_WORKSPACE ".psscriptanalyzer.json"
-            Join-Path $env:GITHUB_WORKSPACE ".psscriptanalyzer"
-          ) | Where-Object { Test-Path $_ } | Select-Object -First 1
+          $settingsPath = Join-Path $env:GITHUB_WORKSPACE ".psscriptanalyzer.psd1"
+          if (-not (Test-Path $settingsPath)) {
+            throw "Missing required settings file: $settingsPath"
+          }
 
-          $include = @("${{ env.FIX_RULES }}".Split(" ",[System.StringSplitOptions]::RemoveEmptyEntries))
+          $include = @("${{ env.FIX_RULES }}".Split(" ", [System.StringSplitOptions]::RemoveEmptyEntries))
 
           $htFix = @{
             Path        = '.'
             Recurse     = $true
             Fix         = $true
             IncludeRule = $include
-          }
-
-          if ($settingsPath) {
-            Write-Host "Using settings: $settingsPath"
-            $htFix.Settings = $settingsPath
-          } else {
-            # Deterministic defaults if you don't have a settings file
-            $htFix.Settings = @{
-              Rules = @{
-                PSUseConsistentIndentation = @{
-                  Enable              = $true
-                  IndentationSize     = 4
-                  PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
-                }
-                PSUseConsistentWhitespace = @{
-                  Enable          = $true
-                  CheckInnerBrace = $true
-                  CheckOpenBrace  = $true
-                  CheckOpenParen  = $true
-                  CheckOperator   = $true
-                  CheckSeparator  = $true
-                }
-              }
-            }
+            Settings    = $settingsPath
           }
 
           Invoke-ScriptAnalyzer @htFix | Out-Null
@@ -276,49 +259,18 @@ jobs:
           $sarifPath = Join-Path $root '${{ env.SARIF_FILE }}'
           $jsonPath  = Join-Path $root '${{ env.JSON_FILE }}'
 
-          $settingsPath = @(
-            Join-Path $root ".psscriptanalyzer.psd1"
-            Join-Path $root ".psscriptanalyzer.json"
-            Join-Path $root ".psscriptanalyzer"
-          ) | Where-Object { Test-Path $_ } | Select-Object -First 1
+          $settingsPath = Join-Path $root ".psscriptanalyzer.psd1"
+          if (-not (Test-Path $settingsPath)) {
+            throw "Missing required settings file: $settingsPath"
+          }
 
           $psaVersion = (Get-Module -ListAvailable PSScriptAnalyzer | Sort-Object Version -Descending | Select-Object -First 1).Version.ToString()
 
           $htPSA = @{
             Path     = $root
             Recurse  = $true
             Severity = @('Error','Warning')
-          }
-
-          if ($settingsPath) {
-            Write-Host "Using settings: $settingsPath"
-            $htPSA.Settings = $settingsPath
-          } else {
-            # Minimal defaults if no settings file
-            $htPSA.IncludeRule = @(
-              'PSAvoidUsingCmdletAliases',
-              'PSUseShouldProcessForStateChangingFunctions',
-              'PSAvoidUsingWriteHost',
-              'PSUseConsistentIndentation',
-              'PSUseConsistentWhitespace'
-            )
-            $htPSA.Settings = @{
-              Rules = @{
-                PSUseConsistentIndentation = @{
-                  Enable              = $true
-                  IndentationSize     = 4
-                  PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
-                }
-                PSUseConsistentWhitespace = @{
-                  Enable          = $true
-                  CheckInnerBrace = $true
-                  CheckOpenBrace  = $true
-                  CheckOpenParen  = $true
-                  CheckOperator   = $true
-                  CheckSeparator  = $true
-                }
-              }
-            }
+            Settings = $settingsPath
           }
 
           $results = Invoke-ScriptAnalyzer @htPSA
@@ -415,15 +367,13 @@ jobs:
               $lines.Add("**Detected $($items.Count) issue(s)**")
               $lines.Add("")
 
-              # Counts by rule
               $lines.Add("**Counts by rule (top 15):**")
               $topRules = $items | Group-Object RuleName | Sort-Object Count -Descending | Select-Object -First 15
               foreach ($r in $topRules) {
                 $lines.Add("- `$($r.Name)`: $($r.Count)")
               }
               $lines.Add("")
 
-              # Show first 20 findings with deep links
               $lines.Add("**First 20 findings:**")
               foreach ($i in ($items | Select-Object -First 20)) {
                 $file = ($i.ScriptPath -replace [regex]::Escape($env:GITHUB_WORKSPACE + [IO.Path]::DirectorySeparatorChar), '').Replace('\','/')