Include file path in AlignAssignmentStatement corrections

[peanut (teanup)]

• Fixes PSAlignAssignmentStatement returns SuggestedCorrections with wrong format #2201

PR Summary

This PR adds a missing argument for the CorrectionExtent constructor in the AlignAssignmentStatement rule definition.

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Change is not breaking
• Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
• Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

[Copilot]

Pull request overview

Fixes AlignAssignmentStatement suggested corrections so CorrectionExtent receives the correct file argument (and the rule message remains in the description argument), ensuring the file path is included properly in correction metadata.

Changes:

• Adds the missing lhsExtent.File argument to the CorrectionExtent constructor call in AlignAssignmentStatement.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Liam Peters (liamjpeters)]

👋 peanut (@teanup) - Thanks for finding and fixing this!

All of the current tests use -ScriptDefinition. It'd be great if you could add a test into Tests/Rules/AlignAssignmentStatement.tests.ps1 that uses path.

Something like the below, where a violation is emitted to a file and then analysed.

It 'sets correction file and description when analyzing a file' {
    $path = Join-Path $TestDrive 'unaligned.ps1'
    Set-Content -LiteralPath $path -Value '@{"Key"    = "Value"}'

    $violations = Invoke-ScriptAnalyzer -Path $path -Settings (New-AlignAssignmentSettings -CheckHashtable $true) |
        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'
}

[peanut (teanup)]

@microsoft-github-policy-service agree

[peanut (teanup)]

Thanks for the suggestion Liam Peters (@liamjpeters)! I've added a Pester test that validates the corrected behavior with file path inputs