Include file path in AlignAssignmentStatement corrections (#2202)

* Fix #2201: Include file path in SuggestedCorrections from AlignAssignmentStatement

The CorrectionExtent constructor was being called with the rule message
as the 6th argument (file), when it should be the 7th (description).

* Fix #2201: Add test for AlignAssignmentStatement to check SuggestedCorrection format

Author: teanup

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 = '@{}'