Skip to content

Fix formatting regression in 1.18.0 whereby single-line pipeline reduces indentation level incorrectly #1191

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 4 commits into from
Mar 28, 2019
Merged

Fix formatting regression in 1.18.0 whereby single-line pipeline reduces indentation level incorrectly #1191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c921ea4
Fix issue whereby single-line pipeline reduces indentation level inco…
Mar 24, 2019
c72345c
Apply suggestions from code review
rjmholt Mar 25, 2019
5ea0fba
Merge branch 'development' of https://github.com/PowerShell/PSScriptA…
bergmeister Mar 27, 2019
78e91f2
Fix tests by replacing break with continue (forgot I was inside for l…
bergmeister Mar 27, 2019
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
27 changes: 18 additions & 9 deletions Rules/UseConsistentIndentation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,16 +220,25 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
// Check if the current token matches the end of a PipelineAst
var matchingPipeLineAstEnd = pipelineAsts.FirstOrDefault(pipelineAst =>
PositionIsEqual(pipelineAst.Extent.EndScriptPosition, token.Extent.EndScriptPosition)) as PipelineAst;
if (matchingPipeLineAstEnd != null)

if (matchingPipeLineAstEnd == null)
{
if (pipelineIndentationStyle == PipelineIndentationStyle.IncreaseIndentationForFirstPipeline)
{
indentationLevel = ClipNegative(indentationLevel - 1);
}
else if (pipelineIndentationStyle == PipelineIndentationStyle.IncreaseIndentationAfterEveryPipeline)
{
indentationLevel = ClipNegative(indentationLevel - (matchingPipeLineAstEnd.PipelineElements.Count - 1));
}
continue;
}

bool pipelineSpansOnlyOneLine = matchingPipeLineAstEnd.Extent.StartLineNumber == matchingPipeLineAstEnd.Extent.EndLineNumber;
if (pipelineSpansOnlyOneLine)
{
continue;
}

if (pipelineIndentationStyle == PipelineIndentationStyle.IncreaseIndentationForFirstPipeline)
{
indentationLevel = ClipNegative(indentationLevel - 1);
}
else if (pipelineIndentationStyle == PipelineIndentationStyle.IncreaseIndentationAfterEveryPipeline)
{
indentationLevel = ClipNegative(indentationLevel - (matchingPipeLineAstEnd.PipelineElements.Count - 1));
}
}

Expand Down
17 changes: 17 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 @@ -174,6 +174,23 @@ baz
Test-CorrectionExtentFromContent @params
}

It "Should preserve script when using PipelineIndentation <PipelineIndentation>" -TestCases @(
@{ PipelineIndentation = 'IncreaseIndentationForFirstPipeline' }
@{ PipelineIndentation = 'IncreaseIndentationAfterEveryPipeline' }
@{ PipelineIndentation = 'NoIndentation' }
) {
param ($PipelineIndentation)
$idempotentScriptDefinition = @'
function hello {
if ($true) {
"hello" | Out-Host
}
}
'@
$settings.Rules.PSUseConsistentIndentation.PipelineIndentation = $PipelineIndentation
Invoke-Formatter -ScriptDefinition $idempotentScriptDefinition -Settings $settings | Should -Be $idempotentScriptDefinition
}

It "Should indent pipelines correctly using NoIndentation option" {
$def = @'
foo |
Expand Down