Skip to content

Add support of comment after content in .editorconfig #114

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
FrediKats merged 1 commit into from
May 17, 2024
Merged

Add support of comment after content in .editorconfig #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 28 additions & 3 deletions Sources/Kysect.Configuin.EditorConfig/DocumentModel/EditorConfigDocumentParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,18 @@ public EditorConfigDocument Parse(string[] lines)
bool isCategory = trimmedLine.StartsWith("[");
if (isCategory)
{
var categoryName = line.Substring(1, line.Length - 2);
context.AddCategory(categoryName);
(string? lineWithoutComment, string? comment) = ExtractComment(trimmedLine);
lineWithoutComment = lineWithoutComment.Trim();
if (!lineWithoutComment.EndsWith("]"))
throw new ArgumentException($"Line is not valid category definition: {lineWithoutComment}");

string categoryName = lineWithoutComment.Substring(1, lineWithoutComment.Length - 2);

EditorConfigCategoryNode categoryNode = comment is not null
? new EditorConfigCategoryNode(categoryName) { TrailingTrivia = comment }
: new EditorConfigCategoryNode(categoryName);

context.AddCategory(categoryNode);
continue;
}

Expand All @@ -49,11 +59,17 @@ public EditorConfigDocument Parse(string[] lines)
bool isProperty = trimmedLine.Contains('=');
if (isProperty)
{
string[] parts = line.Split('=');
(string? lineWithoutComment, string? comment) = ExtractComment(trimmedLine);
lineWithoutComment = lineWithoutComment.Trim();

string[] parts = lineWithoutComment.Split('=');
if (parts.Length != 2)
throw new ArgumentException($"Line {line} contains unexpected count of '='");

var propertyNode = new EditorConfigPropertyNode(EditorConfigStringNode.Create(parts[0]), EditorConfigStringNode.Create(parts[1]));
if (comment is not null)
propertyNode = propertyNode with { TrailingTrivia = comment };

context.AddProperty(propertyNode);
continue;
}
Expand All @@ -63,4 +79,13 @@ public EditorConfigDocument Parse(string[] lines)

return context.Build();
}

private (string lineWithoutComment, string? comment) ExtractComment(string originalString)
{
if (!originalString.Contains('#'))
return (originalString, null);

string[] parts = originalString.Split('#');
return (parts[0], parts[1]);
}
}
6 changes: 4 additions & 2 deletions Sources/Kysect.Configuin.EditorConfig/DocumentModel/EditorConfigDocumentParsingContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ public EditorConfigDocumentParsingContext()
_currentTrivia = new List<string>();
}

public void AddCategory(string categoryName)
public void AddCategory(EditorConfigCategoryNode categoryNode)
{
categoryNode.ThrowIfNull();

DumpSection();
DumpCategory();
_currentCategory = new EditorConfigCategoryNode(categoryName) { LeadingTrivia = _currentTrivia.ToImmutableList() };
_currentCategory = categoryNode with { LeadingTrivia = _currentTrivia.ToImmutableList() };
_currentTrivia = new List<string>();
}

Expand Down
22 changes: 22 additions & 0 deletions Sources/Kysect.Configuin.Tests/EditorConfig/EditorConfigDocumentParserTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,17 @@ public void Parse_Category_ReturnDocumentWithCategoryNode()
ParseAndCompare(content, expected);
}

[Fact]
public void Parse_CategoryWithComment_ReturnDocumentWithCategoryNode()
{
const string content = """
[*.cs] # comment
""";
EditorConfigDocument expected = new EditorConfigDocument([new EditorConfigCategoryNode("*.cs") { TrailingTrivia = " comment" }]);

ParseAndCompare(content, expected);
}

[Fact]
public void Parse_Group_ReturnDocumentWithGroupNode()
{
Expand All @@ -63,6 +74,17 @@ public void Parse_Property_ReturnDocumentWithPropertyNode()
ParseAndCompare(content, expected);
}

[Fact]
public void Parse_PropertyWithComment_ReturnDocumentWithPropertyNode()
{
const string content = """
key=value # comment
""";
EditorConfigDocument expected = new EditorConfigDocument([new EditorConfigPropertyNode("key", "value") { TrailingTrivia = " comment" }]);

ParseAndCompare(content, expected);
}

[Fact]
public void Parse_CategoryWithProperty_ReturnCorrectDocument()
{
Expand Down