Skip to content

UseConsistentIndentation: When non-default options are used, cater for the case of a comment between pipe and newline #1463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 28, 2020
Merged

UseConsistentIndentation: When non-default options are used, cater for the case of a comment between pipe and newline #1463

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
295c534
UseConsistentIndentation: When non-default options are used, cater fo…
Apr 26, 2020
4398031
Update Rules/UseConsistentIndentation.cs
bergmeister Apr 27, 2020
65da164
re-trigger ci
Apr 27, 2020
0d3350c
Merge branch 'master' of https://github.com/powershell/psscriptanalyz…
Apr 27, 2020
93c9450
Merge branch 'UseConsistentIndentation-CommentBetweenPipeAndNewline' …
Apr 27, 2020
226259d
try split test template
Apr 27, 2020
15c3435
Revert "try split test template"
Apr 27, 2020
1769764
fix syntax due to missing brace (also: GitHub suggestions did not cor…
Apr 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions Rules/UseConsistentIndentation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,8 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file

case TokenKind.Pipe:
if (pipelineIndentationStyle == PipelineIndentationStyle.None) { break; }
bool pipelineIsFollowedByNewlineOrLineContinuation = tokenIndex < tokens.Length - 1 && tokenIndex > 0 &&
(tokens[tokenIndex + 1].Kind == TokenKind.NewLine || tokens[tokenIndex + 1].Kind == TokenKind.LineContinuation);
bool pipelineIsFollowedByNewlineOrLineContinuation =
PipelineIsFollowedByNewlineOrLineContinuation(tokens, tokenIndex);
if (!pipelineIsFollowedByNewlineOrLineContinuation)
{
break;
Expand Down Expand Up @@ -254,6 +254,21 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
return diagnosticRecords;
}

private static bool PipelineIsFollowedByNewlineOrLineContinuation(Token[] tokens, int tokenIndex)
{
if (tokenIndex == tokens.Length - 1)
{
return false;
}
var nextToken = tokens[tokenIndex + 1];
if (nextToken.Kind == TokenKind.Comment && tokenIndex < tokens.Length - 2)
{
nextToken = tokens[tokenIndex + 2];
}
return nextToken.Kind == TokenKind.NewLine ||
nextToken.Kind == TokenKind.LineContinuation;
}

private static bool LineHasPipelineBeforeToken(Token[] tokens, int tokenIndex, Token token)
{
int searchIndex = tokenIndex;
Expand Down
12 changes: 12 additions & 0 deletions Tests/Rules/UseConsistentIndentation.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,18 @@ foo |
Invoke-FormatterAssertion $scriptDefinition $expected 3 $settings
}

It "When a comment is after a pipeline and before the newline " {
$scriptDefinition = @'
foo | # comment
bar
'@
$expected = @'
foo | # comment
bar
'@
Invoke-FormatterAssertion $scriptDefinition $expected 1 $settings
}

It "Should find a violation if a pipleline element is not indented correctly" {
$def = @'
get-process |
Expand Down