[Feature Request] Detailed logging to include line number and code violation details about format HOT 5 CLOSED

@feliwir - I'm not working on this, got a newborn 👶 !

from format.

These details now get logged during --dry-runs. You can try this out with the latest build from MyGet.

dotnet tool install -g dotnet-format --version 3.1.36303 --add-source https://dotnet.myget.org/F/format/api/v3/index.json

from format.

Naive bunch of code from CodeFormatter.cs after a document is formatted:

//get the differences between the formatted document, and the original
var diffs = await formattedDocument.GetTextChangesAsync(document, cancellationToken);
foreach (var item in diffs)
{
    var sourceText = await document.GetTextAsync(cancellationToken);
    var fixedText = await document.GetTextAsync(cancellationToken);

    var linePositionSpan = sourceText.Lines.GetLinePositionSpan(item.Span);

    var sourceLine = sourceText.Lines[linePositionSpan.Start.Line];
    var destinationLine = fixedText.Lines[linePositionSpan.Start.Line];

    logger.Log("log details above");
}

I imagine in practice there is a bunch more considerations to take into account. For instance certain TextChanges can likely apply to multiple lines?

I've also no idea on the correct API's to use here, I was just digging about in intellisense.

Sample output (in this case, the displayed line was indented 4 spaces too many):

Formatting code files in project 'dotnet-format'.
  CodeFormatter.cs 192 "                        var diffs = await formattedDocument.GetTextChangesAsync(document, cancellationToken);". New Text: "                    var diffs = await formattedDocument.GetTextChangesAsync(document, cancellationToken);"

from format.

Well happily accept a PR for this

from format.

Any work being done on this already?

from format.