Skip to content

Fix parsing .editorconfig EOL #10740

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 2 commits into from
Oct 3, 2024
Merged

Fix parsing .editorconfig EOL #10740

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ff7f21
fix parsing .editorconfig line endings, add a unit test
JanProvaznik Oct 1, 2024
0346115
bump version
JanProvaznik Oct 1, 2024
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
2 changes: 1 addition & 1 deletion src/Build/BuildCheck/Infrastructure/EditorConfig/EditorConfigFile.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ internal static EditorConfigFile Parse(string text)
// dictionary, but we also use a case-insensitive key comparer when doing lookups
var activeSectionProperties = ImmutableDictionary.CreateBuilder<string, string>(StringComparer.OrdinalIgnoreCase);
string activeSectionName = "";
var lines = string.IsNullOrEmpty(text) ? Array.Empty<string>() : text.Split(new string[] { Environment.NewLine }, StringSplitOptions.None);
var lines = string.IsNullOrEmpty(text) ? Array.Empty<string>() : text.Split(new string[] { "\r\n", "\n" }, StringSplitOptions.None);

foreach(var line in lines)
{
Expand Down
29 changes: 28 additions & 1 deletion src/BuildCheck.UnitTests/EditorConfigParser_Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public void EditorconfigFileDiscovery_RootTrue()
""");

var parser = new EditorConfigParser();
var listOfEditorConfigFile = parser.DiscoverEditorConfigFiles(Path.Combine(workFolder1.Path, "subfolder", "projectfile.proj") ).ToList();
var listOfEditorConfigFile = parser.DiscoverEditorConfigFiles(Path.Combine(workFolder1.Path, "subfolder", "projectfile.proj")).ToList();
// should be one because root=true so we do not need to go further
listOfEditorConfigFile.Count.ShouldBe(1);
listOfEditorConfigFile[0].IsRoot.ShouldBeTrue();
Expand Down Expand Up @@ -116,4 +116,31 @@ public void EditorconfigFileDiscovery_RootFalse()
listOfEditorConfigFile[0].IsRoot.ShouldBeFalse();
listOfEditorConfigFile[0].NamedSections[0].Name.ShouldBe("*.csproj");
}

[Fact]
public void Parse_HandlesDifferentLineEndings()
{
var mixedEndingsText = "root = true\r\n" +
"[*.cs]\n" +
"indent_style = space\r\n" +
"indent_size = 4\n" +
"[*.md]\r\n" +
"trim_trailing_whitespace = true";

var result = EditorConfigFile.Parse(mixedEndingsText);

result.IsRoot.ShouldBeTrue("Root property should be true");
result.NamedSections.Length.ShouldBe(2);

var csSection = result.NamedSections.FirstOrDefault(s => s.Name == "*.cs");
csSection.ShouldNotBeNull();
csSection.Properties.Count.ShouldBe(2);
csSection.Properties["indent_style"].ShouldBe("space");
csSection.Properties["indent_size"].ShouldBe("4");

var mdSection = result.NamedSections.FirstOrDefault(s => s.Name == "*.md");
mdSection.ShouldNotBeNull();
mdSection.Properties.Count.ShouldBe(1);
mdSection.Properties["trim_trailing_whitespace"].ShouldBe("true");
}
}
Loading