microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
scripts/linting/Invoke-PSScriptAnalyzer.ps1
145lines Ā· modecode
| 1 | #!/usr/bin/env pwsh |
| 2 | # |
| 3 | # Invoke-PSScriptAnalyzer.ps1 |
| 4 | # |
| 5 | # Purpose: Wrapper for PSScriptAnalyzer with GitHub Actions integration |
| 6 | # Author: HVE Core Team |
| 7 | # Created: 2025-11-05 |
| 8 | |
| 9 | [CmdletBinding()] |
| 10 | param( |
| 11 | [Parameter(Mandatory = $false)] |
| 12 | [switch]$ChangedFilesOnly, |
| 13 | |
| 14 | [Parameter(Mandatory = $false)] |
| 15 | [string]$BaseBranch = "origin/main", |
| 16 | |
| 17 | [Parameter(Mandatory = $false)] |
| 18 | [string]$ConfigPath = (Join-Path $PSScriptRoot "PSScriptAnalyzer.psd1"), |
| 19 | |
| 20 | [Parameter(Mandatory = $false)] |
| 21 | [string]$OutputPath = "logs/psscriptanalyzer-results.json" |
| 22 | ) |
| 23 | |
| 24 | # Import shared helpers |
| 25 | Import-Module (Join-Path $PSScriptRoot "Modules/LintingHelpers.psm1") -Force |
| 26 | |
| 27 | Write-Host "š Running PSScriptAnalyzer..." -ForegroundColor Cyan |
| 28 | |
| 29 | # Ensure PSScriptAnalyzer is available |
| 30 | if (-not (Get-Module -ListAvailable -Name PSScriptAnalyzer)) { |
| 31 | Write-Host "Installing PSScriptAnalyzer module..." -ForegroundColor Yellow |
| 32 | Install-Module -Name PSScriptAnalyzer -Force -Scope CurrentUser -Repository PSGallery |
| 33 | } |
| 34 | |
| 35 | Import-Module PSScriptAnalyzer |
| 36 | |
| 37 | # Get files to analyze |
| 38 | $filesToAnalyze = @() |
| 39 | |
| 40 | if ($ChangedFilesOnly) { |
| 41 | Write-Host "Detecting changed PowerShell files..." -ForegroundColor Cyan |
| 42 | $filesToAnalyze = Get-ChangedFilesFromGit -BaseBranch $BaseBranch -FileExtensions @('*.ps1', '*.psm1', '*.psd1') |
| 43 | } |
| 44 | else { |
| 45 | Write-Host "Analyzing all PowerShell files..." -ForegroundColor Cyan |
| 46 | $gitignorePath = Join-Path (git rev-parse --show-toplevel 2>$null) ".gitignore" |
| 47 | $filesToAnalyze = Get-FilesRecursive -Path "." -Include @('*.ps1', '*.psm1', '*.psd1') -GitIgnorePath $gitignorePath |
| 48 | } |
| 49 | |
| 50 | if ($filesToAnalyze.Count -eq 0) { |
| 51 | Write-Host "ā
No PowerShell files to analyze" -ForegroundColor Green |
| 52 | Set-GitHubOutput -Name "count" -Value "0" |
| 53 | Set-GitHubOutput -Name "issues" -Value "0" |
| 54 | exit 0 |
| 55 | } |
| 56 | |
| 57 | Write-Host "Analyzing $($filesToAnalyze.Count) PowerShell files..." -ForegroundColor Cyan |
| 58 | Set-GitHubOutput -Name "count" -Value $filesToAnalyze.Count |
| 59 | |
| 60 | # Run PSScriptAnalyzer |
| 61 | $allResults = @() |
| 62 | $hasErrors = $false |
| 63 | |
| 64 | foreach ($file in $filesToAnalyze) { |
| 65 | $filePath = if ($file -is [System.IO.FileInfo]) { $file.FullName } else { $file } |
| 66 | Write-Host "`nš Analyzing: $filePath" -ForegroundColor Cyan |
| 67 | |
| 68 | $results = Invoke-ScriptAnalyzer -Path $filePath -Settings $ConfigPath |
| 69 | |
| 70 | if ($results) { |
| 71 | $allResults += $results |
| 72 | |
| 73 | foreach ($result in $results) { |
| 74 | # Create GitHub annotation |
| 75 | Write-GitHubAnnotation ` |
| 76 | -Type $result.Severity.ToString().ToLower() ` |
| 77 | -Message "$($result.RuleName): $($result.Message)" ` |
| 78 | -File $filePath ` |
| 79 | -Line $result.Line ` |
| 80 | -Column $result.Column |
| 81 | |
| 82 | $icon = switch ($result.Severity) { |
| 83 | 'Error' { 'ā'; $hasErrors = $true } |
| 84 | 'Warning' { 'ā ļø' } |
| 85 | default { 'ā¹ļø' } |
| 86 | } |
| 87 | |
| 88 | Write-Host " $icon [$($result.Severity)] $($result.RuleName): $($result.Message) (Line $($result.Line))" -ForegroundColor $( |
| 89 | if ($result.Severity -eq 'Error') { 'Red' } |
| 90 | elseif ($result.Severity -eq 'Warning') { 'Yellow' } |
| 91 | else { 'Cyan' } |
| 92 | ) |
| 93 | } |
| 94 | } |
| 95 | else { |
| 96 | Write-Host " ā
No issues found" -ForegroundColor Green |
| 97 | } |
| 98 | } |
| 99 | |
| 100 | # Export results |
| 101 | $summary = @{ |
| 102 | TotalFiles = $filesToAnalyze.Count |
| 103 | TotalIssues = $allResults.Count |
| 104 | Errors = ($allResults | Where-Object Severity -eq 'Error').Count |
| 105 | Warnings = ($allResults | Where-Object Severity -eq 'Warning').Count |
| 106 | Information = ($allResults | Where-Object Severity -eq 'Information').Count |
| 107 | HasErrors = $hasErrors |
| 108 | } |
| 109 | |
| 110 | $allResults | ConvertTo-Json -Depth 5 | Out-File $OutputPath |
| 111 | $summary | ConvertTo-Json | Out-File "logs/psscriptanalyzer-summary.json" |
| 112 | |
| 113 | # Set outputs |
| 114 | Set-GitHubOutput -Name "issues" -Value $summary.TotalIssues |
| 115 | Set-GitHubOutput -Name "errors" -Value $summary.Errors |
| 116 | Set-GitHubOutput -Name "warnings" -Value $summary.Warnings |
| 117 | |
| 118 | if ($hasErrors) { |
| 119 | Set-GitHubEnv -Name "PSSCRIPTANALYZER_FAILED" -Value "true" |
| 120 | } |
| 121 | |
| 122 | # Write summary |
| 123 | Write-GitHubStepSummary -Content "## PSScriptAnalyzer Results`n" |
| 124 | |
| 125 | if ($summary.TotalIssues -eq 0) { |
| 126 | Write-GitHubStepSummary -Content "ā
**Status**: Passed`n`nAll $($summary.TotalFiles) PowerShell files passed linting checks." |
| 127 | Write-Host "`nā
All PowerShell files passed PSScriptAnalyzer checks!" -ForegroundColor Green |
| 128 | exit 0 |
| 129 | } |
| 130 | else { |
| 131 | Write-GitHubStepSummary -Content @" |
| 132 | ā **Status**: Failed |
| 133 | |
| 134 | | Metric | Count | |
| 135 | |--------|-------| |
| 136 | | Files Analyzed | $($summary.TotalFiles) | |
| 137 | | Total Issues | $($summary.TotalIssues) | |
| 138 | | Errors | $($summary.Errors) | |
| 139 | | Warnings | $($summary.Warnings) | |
| 140 | | Information | $($summary.Information) | |
| 141 | "@ |
| 142 | |
| 143 | Write-Host "`nā PSScriptAnalyzer found $($summary.TotalIssues) issue(s)" -ForegroundColor Red |
| 144 | exit 1 |
| 145 | } |
| 146 | |