Skip to content
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

Support wrapping comment lines #1355

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support wrapping comment lines #1355

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
18 changes: 18 additions & 0 deletions Src/CSharpier.Tests/CodeFormatterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,24 @@ public void Format_Should_Use_Width()
result.Code.Should().Be("var someVariable =\n someValue;\n");
}

[Test]
public void Format_Should_Use_Width_For_Single_Line_Comment()
{
var code = "// Test very long line comment. \n // Second line of long comment. \n var someVariable = someValue;";
var result = CodeFormatter.Format(code, new CodeFormatterOptions { Width = 10 });
result.Code.Should().Be("// Test\n// very long\n// line\n// comment.\n// Second\n// line of\n// long\n// comment.\nvar someVariable =\n someValue;\n");
}

[Test]
public void Format_Should_Use_Width_For_Multi_Line_Comments()
{
var code =
"/* Test very long line comment.\n Second line of long comment.\n Third line of long comment. */\n var someVariable = someValue;";
var result = CodeFormatter.Format(code, new CodeFormatterOptions { Width = 10 });

result.Code.Should().Be("/* Test\nvery long\nline\ncomment.\nSecond\nline of\nlong\ncomment.\nThird line\nof long\ncomment.\n*/\nvar someVariable =\n someValue;\n");
}

[Test]
public void Format_Should_Measure_Regular_Characters()
{
Expand Down
118 changes: 96 additions & 22 deletions Src/CSharpier/DocPrinter/DocPrinter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
using CSharpier.DocTypes;
using System;
using System.Collections;
using System.Runtime.CompilerServices;
using System.Text;
using System.Xml.Linq;

namespace CSharpier.DocPrinter;

Expand Down Expand Up @@ -67,6 +72,8 @@ private void EnsureOutputEndsWithSingleNewLine()
this.Output.Append(this.EndOfLine);
}



private void ProcessNextCommand()
{
var (indent, mode, doc) = this.RemainingCommands.Pop();
Expand Down Expand Up @@ -186,6 +193,47 @@ private void ProcessNextCommand()
}
}

private List<string> BreakCommentLine(string comment)
{
List<string> result = new List<string>();
if (comment.Length > this.PrinterOptions.Width)
{
string[] comments = comment.Split(' ');
StringBuilder singleLine = new StringBuilder();
bool firstLine = true;
foreach (var word in comments)
{
if (singleLine.Length + word.Length >= this.PrinterOptions.Width)
{
result.Add(singleLine.ToString());
singleLine.Clear();
if (firstLine)
{
firstLine = false;
}
}

if (singleLine.Length > 0)
{
singleLine.Append(' ');
}

singleLine.Append(word);
}

if (singleLine.Length > 0)
{
result.Add(singleLine.ToString());
}
}
else
{
result.Add(comment);
}

return result;
}

private void AppendComment(LeadingComment leadingComment, Indent indent)
{
int CalculateIndentLength(string line) =>
Expand All @@ -206,42 +254,68 @@ int CalculateIndentLength(string line) =>

while (line != null)
{
if (leadingComment.Type == CommentType.SingleLine)
{
this.Output.Append(indent.Value);
}
else
string entireLine = line;
List<string> lines = BreakCommentLine(line.Trim());

var nextLine = stringReader.ReadLine();

int total = lines.Count;
int lineNumber = 0;
foreach (var singleLine in lines)
{
var spacesToAppend = CalculateIndentLength(line) + numberOfSpacesToAddOrRemove;
if (this.PrinterOptions.UseTabs)
if (leadingComment.Type == CommentType.SingleLine)
{
var indentLength = CalculateIndentLength(indent.Value);
if (spacesToAppend >= indentLength)
this.Output.Append(indent.Value);
}
else
{
var spacesToAppend = CalculateIndentLength(singleLine) + numberOfSpacesToAddOrRemove;
if (this.PrinterOptions.UseTabs)
{
this.Output.Append(indent.Value);
spacesToAppend -= indentLength;
}
var indentLength = CalculateIndentLength(indent.Value);
if (spacesToAppend >= indentLength)
{
this.Output.Append(indent.Value);
spacesToAppend -= indentLength;
}

while (spacesToAppend > 0 && spacesToAppend >= this.PrinterOptions.IndentSize)
while (spacesToAppend > 0 && spacesToAppend >= this.PrinterOptions.IndentSize)
{
this.Output.Append('\t');
spacesToAppend -= this.PrinterOptions.IndentSize;
}
}
if (spacesToAppend > 0)
{
this.Output.Append('\t');
spacesToAppend -= this.PrinterOptions.IndentSize;
this.Output.Append(' ', spacesToAppend);
}
}
if (spacesToAppend > 0)

if (leadingComment.Type == CommentType.SingleLine && lineNumber > 0)
{
this.Output.Append("// ");
}

this.Output.Append(singleLine.Trim());

// Printer will generate a new line for the next line after the comment.
if (nextLine != null || lineNumber < total - 1)
{
this.Output.Append(' ', spacesToAppend);
this.Output.Append(this.EndOfLine);
}

++lineNumber;
}

this.Output.Append(line.Trim());
line = stringReader.ReadLine();
if (line == null)

if (nextLine == null)
{
return;
}

this.Output.Append(this.EndOfLine);
else
{
line = nextLine;
}
}
}

Expand Down
Loading