PSUseConsistentWhitespace: Handle redirect operators which are not in stream order #2001
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
When
CheckParameter
is$true
for the rulePSUseConsistentWhitespace
, it checks whitespace between parameters by inspecting the AST. It gets all direct children of eachCommandAst
and checks, in order, that each's extent is separated by exactly 1 character.This relies on the implicit assumption that the AST returns the children in something resembling token order.
In the case of redirect operators, this is not always the case (they anecdotally appear to be returned in the order of the stream they're redirecting). See the issue here for more detailed breakdown.
This PR adds sorting of the children before subsequently performing the same checks on the tokens extents.
Running the below across PS5.1 and PS7.4 with and without the PR change applied shows the performance impact of the change to be minimal.
Invoke-Formatter
Invoke-ScriptAnalyzer
Fixes #2000
PR Checklist
.cs
,.ps1
and.psm1
files have the correct copyright headerWIP:
to the beginning of the title and remove the prefix when the PR is ready.