Skip to content

Don't assume indentation increases for void elements #8840

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 3 commits into from
Jun 21, 2023
Merged

Don't assume indentation increases for void elements #8840

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d84f77b
Don't assume indentation increases for void elements
davidwengier Jun 18, 2023
94a8ed5
Merge remote-tracking branch 'upstream/main' into FormatVoidElements
davidwengier Jun 21, 2023
ffb687e
Prevent html tag formatting regression found by integration tests
davidwengier Jun 21, 2023
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
11 changes: 5 additions & 6 deletions src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Formatting/FormattingVisitor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ namespace Microsoft.AspNetCore.Razor.LanguageServer.Formatting;

internal class FormattingVisitor : SyntaxWalker
{
private const string HtmlTagName = "html";

private readonly List<FormattingSpan> _spans;
private FormattingBlockKind _currentBlockKind;
private SyntaxNode? _currentBlock;
Expand Down Expand Up @@ -127,8 +125,10 @@ public override void VisitMarkupElement(MarkupElementSyntax node)
{
Visit(node.StartTag);

// Temporary fix to not break the default Html formatting behavior. Remove after https://github.com/dotnet/aspnetcore/issues/25475.
if (!string.Equals(node.StartTag?.Name?.Content, HtmlTagName, StringComparison.OrdinalIgnoreCase))
// Void elements, like <meta> or <input> which don't need an end tag don't cause indentation
var causesIndentation = node.StartTag is null || !node.StartTag.IsVoidElement();

if (causesIndentation)
{
_currentHtmlIndentationLevel++;
}
Expand All @@ -138,8 +138,7 @@ public override void VisitMarkupElement(MarkupElementSyntax node)
Visit(child);
}

// Temporary fix to not break the default Html formatting behavior. Remove after https://github.com/dotnet/aspnetcore/issues/25475.
if (!string.Equals(node.StartTag?.Name?.Content, HtmlTagName, StringComparison.OrdinalIgnoreCase))
if (causesIndentation)
{
_currentHtmlIndentationLevel--;
}
Expand Down
45 changes: 44 additions & 1 deletion .../Microsoft.AspNetCore.Razor.LanguageServer.Test/Formatting/CodeDirectiveFormattingTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT license. See License.txt in the project root for license information.

using System.Collections.Generic;
using System.Collections.Immutable;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Razor.Language;
Expand Down Expand Up @@ -437,6 +436,50 @@ @section Scripts {
fileKind: FileKinds.Legacy);
}

[Fact]
public async Task Format_SectionDirectiveBlock6()
{
await RunFormattingTestAsync(
input: """
@functions {
public class Foo{
void Method() { }
}
}

@section Scripts {
<meta property="a" content="b">
<meta property="a" content="b"/>
<meta property="a" content="b">

@if(true)
{
<p>this is a paragraph</p>
}
}
""",
expected: """
@functions {
public class Foo
{
void Method() { }
}
}

@section Scripts {
<meta property="a" content="b">
<meta property="a" content="b" />
<meta property="a" content="b">

@if (true)
{
<p>this is a paragraph</p>
}
}
""",
fileKind: FileKinds.Legacy);
}

[Fact]
public async Task Formats_CodeBlockDirectiveWithRazorComments()
{
Expand Down