Merge branch 'main' into sdw-w600137-refactor-script

Author: bergmeister

ADOPTERS.md

@@ -10,6 +10,8 @@ Example entry:
 
 This is a list of adopters of using PowerShell Script Analyzer in production or in their products (in alphabetical order):
 
+* [MegaLinter](https://megalinter.io/), an open-source linter aggregator for CI, runs PSScriptAnalyzer out of the box to lint the PowerShell files of the repositories it analyzes
+  (see the [PSScriptAnalyzer page](https://megalinter.io/latest/descriptors/powershell_powershell/) in its documentation).
 * Microsoft Windows Build: PSScriptAnalyzer is automatically run against PowerShell scripts when performing a build for Windows to maintain and improve the quality of code as it gets checked in.
 * [PowerShellEditorServices](https://github.com/powershell/powershelleditorservices) uses PowerShell Script Analyzer to provide real-time
   linting of PowerShell scripts for editors such as [VSCode](https://code.visualstudio.com/), [Neovim](https://neovim.io/), [IntelliJ](https://www.jetbrains.com/idea/), and others.

README.md

@@ -3,7 +3,6 @@
 <img src="logo.png" width="180">
 
 [![Build Status](https://dev.azure.com/powershell/psscriptanalyzer/_apis/build/status/psscriptanalyzer-ci?branchName=master)](https://dev.azure.com/powershell/psscriptanalyzer/_build/latest?definitionId=80&branchName=master)
-[![Join the chat at https://gitter.im/PowerShell/PSScriptAnalyzer](https://badges.gitter.im/PowerShell/PSScriptAnalyzer.svg)](https://gitter.im/PowerShell/PSScriptAnalyzer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ## Table of Contents
 

Rules/AlignAssignmentStatement.cs

@@ -650,6 +650,7 @@ int targetColumn
                     lhsExtent.EndColumnNumber,
                     equalsExtent.StartColumnNumber,
                     new string(' ', targetColumn - lhsExtent.EndColumnNumber),
+                    lhsExtent.File,
                     string.Format(CultureInfo.CurrentCulture, Strings.AlignAssignmentStatementError)
                 )
             };

Tests/Rules/AlignAssignmentStatement.tests.ps1

@@ -126,6 +126,21 @@ Configuration C1 {
 
     Context 'When Hashtable checking is enabled' {
 
+        It 'Should set correction file and description when analyzing a file' {
+            $path = Join-Path -Path $TestDrive -ChildPath 'unaligned.ps1'
+            Set-Content -LiteralPath $path -Value '@{"Key"    = "Value"}'
+
+            $settings = New-AlignAssignmentSettings -CheckHashtable $true
+
+            $violations = Invoke-ScriptAnalyzer -Path $path -Settings $settings |
+                Get-NonParseDiagnostics
+
+            $violations | Should -HaveCount 1
+            $correction = $violations[0].SuggestedCorrections[0]
+            $correction.File | Should -Be ([IO.Path]::GetFullPath($path))
+            $correction.Description | Should -Be 'Assignment statements are not aligned'
+        }
+
         It 'Should not find violations in empty single-line hashtable' {
             $def = '@{}'