feat: enable jumping to "not formatted" files from VisualStudio error…

… list

- adds --msbuild-format parameter to format error message according to standard error/warning format of MSBuild.
See https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-diagnostic-format-for-tasks?view=vs-2022

Src/CSharpier.Cli/CommandLineFormatter.cs

@@ -60,7 +60,8 @@ CancellationToken cancellationToken
                 {
                     var fileIssueLogger = new FileIssueLogger(
                         commandLineOptions.OriginalDirectoryOrFilePaths[0],
-                        logger
+                        logger,
+                        commandLineOptions.MsBuildFormat
                     );
 
                     var printerOptions = optionsProvider.GetPrinterOptionsFor(filePath);
@@ -231,7 +232,11 @@ await FormatPhysicalFile(
                 }
                 else if (warnForUnsupported)
                 {
-                    var fileIssueLogger = new FileIssueLogger(originalFilePath, logger);
+                    var fileIssueLogger = new FileIssueLogger(
+                        originalFilePath,
+                        logger,
+                        isMsBuildFormat: false
+                    );
                     fileIssueLogger.WriteWarning("Is an unsupported file type.");
                 }
             }
@@ -307,7 +312,11 @@ CancellationToken cancellationToken
             cancellationToken
         );
 
-        var fileIssueLogger = new FileIssueLogger(originalFilePath, logger);
+        var fileIssueLogger = new FileIssueLogger(
+            originalFilePath,
+            logger,
+            commandLineOptions.MsBuildFormat
+        );
 
         logger.LogDebug(
             commandLineOptions.Check

Src/CSharpier.Cli/CommandLineOptions.cs

@@ -7,6 +7,7 @@ internal class CommandLineOptions
 {
     public string[] DirectoryOrFilePaths { get; init; } = [];
     public bool Check { get; init; }
+    public bool MsBuildFormat { get; init; }
     public bool Fast { get; init; }
     public bool SkipWrite { get; init; }
     public bool WriteStdout { get; init; }
@@ -21,6 +22,7 @@ internal class CommandLineOptions
     internal delegate Task<int> Handler(
         string[] directoryOrFile,
         bool check,
+        bool msBuildFormat,
         bool fast,
         bool skipWrite,
         bool writeStdout,
@@ -52,6 +54,10 @@ public static RootCommand Create()
                 () => LogLevel.Information.ToString(),
                 "Specify the log level - Debug, Information (default), Warning, Error, None"
             ),
+            new Option(
+                ["--msbuild-format"],
+                "Formats messages in standard error/warning format for MSBuild."
+            ),
             new Option(
                 ["--no-cache"],
                 "Bypass the cache to determine if a file needs to be formatted."

Src/CSharpier.Cli/ConsoleLogger.cs

@@ -2,7 +2,7 @@
 
 namespace CSharpier.Cli;
 
-internal class ConsoleLogger(IConsole console, LogLevel loggingLevel) : ILogger
+internal class ConsoleLogger(IConsole console, LogLevel loggingLevel, bool isMsBuildFormat) : ILogger
 {
     private static readonly object ConsoleLock = new();
 
@@ -52,7 +52,7 @@ void WriteLine(string? value = null)
         {
             var message = formatter(state, exception!);
 
-            if (logLevel >= LogLevel.Warning)
+            if (!isMsBuildFormat && logLevel >= LogLevel.Warning)
             {
                 console.ForegroundColor = GetColorLevel(logLevel);
                 Write($"{logLevel} ");

Src/CSharpier.Cli/FileIssueLogger.cs

@@ -2,11 +2,29 @@
 
 namespace CSharpier.Cli;
 
-internal class FileIssueLogger(string filePath, ILogger logger)
+internal class FileIssueLogger(string filePath, ILogger logger, bool isMsBuildFormat)
 {
+    static string FormatMsBuildError(LogState logState, Exception? exception) =>
+        $"{logState.Path}: error: {logState.Message}";
+
+    record class LogState
+    {
+        public required string Path;
+        public required string Message;
+    }
+
     public void WriteError(string value, Exception? exception = null)
     {
-        logger.LogError(exception, $"{this.GetPath()} - {value}");
+        if (isMsBuildFormat)
+        {
+            var logState = new LogState() { Path = this.GetPath(), Message = value };
+
+            logger.Log(LogLevel.Error, 0, logState, exception, FormatMsBuildError);
+        }
+        else
+        {
+            logger.LogError(exception, $"{this.GetPath()} - {value}");
+        }
     }
 
     public void WriteWarning(string value)

Src/CSharpier.Cli/Program.cs

@@ -23,6 +23,7 @@ public static async Task<int> Main(string[] args)
     public static async Task<int> Run(
         string[]? directoryOrFile,
         bool check,
+        bool msBuildFormat,
         bool fast,
         bool skipWrite,
         bool writeStdout,
@@ -42,7 +43,7 @@ CancellationToken cancellationToken
         var actualConfigPath = string.IsNullOrEmpty(configPath) ? null : configPath;
 
         var console = new SystemConsole();
-        var logger = new ConsoleLogger(console, logLevel);
+        var logger = new ConsoleLogger(console, logLevel, msBuildFormat);
 
         if (pipeMultipleFiles)
         {
@@ -89,6 +90,7 @@ CancellationToken cancellationToken
             OriginalDirectoryOrFilePaths = originalDirectoryOrFile!,
             StandardInFileContents = standardInFileContents,
             Check = check,
+            MsBuildFormat = msBuildFormat,
             NoCache = noCache,
             NoMSBuildCheck = noMSBuildCheck,
             Fast = fast,

Src/CSharpier.MsBuild/build/CSharpier.MsBuild.targets

@@ -43,9 +43,7 @@
       StdOutEncoding="utf-8"
       StdErrEncoding="utf-8"
       IgnoreExitCode="true"
-      IgnoreStandardErrorWarningFormat="true"
-      CustomErrorRegularExpression="^Error "
-      Command=""$(CSharpier_dotnet_Path)" exec "$(CSharpierDllPath)" $(CSharpierArgs) --no-msbuild-check --compilation-errors-as-warnings "$(MSBuildProjectDirectory)" > $(NullOutput) "
+      Command=""$(CSharpier_dotnet_Path)" exec "$(CSharpierDllPath)" $(CSharpierArgs) --msbuild-format --no-msbuild-check --compilation-errors-as-warnings "$(MSBuildProjectDirectory)" > $(NullOutput) "
     />
   </Target>
   <!-- getting this to run a single time for projects that target multiple frameworks requires all of this

Src/CSharpier.Tests/CommandLineFormatterTests.cs

@@ -1,16 +1,19 @@
-using System.IO.Abstractions.TestingHelpers;
-using System.Text;
 using CSharpier.Cli;
 using FluentAssertions;
 using Microsoft.Extensions.Logging;
 using NUnit.Framework;
+using System.IO.Abstractions.TestingHelpers;
+using System.Text;
 
 namespace CSharpier.Tests;
 
 [TestFixture]
 [Parallelizable(ParallelScope.All)]
 public class CommandLineFormatterTests
 {
+    private const bool IsMsBuildFormat = true;
+    private const bool IsNotMsBuildFormat = false;
+
     private const string UnformattedClassContent = "public class ClassName { public int Field; }";
     private const string FormattedClassContent =
         "public class ClassName\n{\n    public int Field;\n}\n";
@@ -362,6 +365,23 @@ public void Format_Checks_Unformatted_File()
             .StartWith("Error ./Unformatted.cs - Was not formatted.");
     }
 
+    [Test]
+    public void Format_Checks_Unformatted_File_With_MsBuildFormat_Message()
+    {
+        var context = new TestContext();
+        const string unformattedFilePath = "Unformatted.cs";
+        context.WhenAFileExists(unformattedFilePath, UnformattedClassContent);
+
+        var result = Format(context, check: true, msBuildFormat: true);
+
+        result.ExitCode.Should().Be(1);
+        context.GetFileContent(unformattedFilePath).Should().Be(UnformattedClassContent);
+        result
+            .ErrorOutputLines.First()
+            .Should()
+            .StartWith("./Unformatted.cs: error: Was not formatted.");
+    }
+
     [TestCase("Src/node_modules/File.cs")]
     [TestCase("node_modules/File.cs")]
     [TestCase("node_modules/Folder/File.cs")]
@@ -750,6 +770,7 @@ private static FormatResult Format(
         TestContext context,
         bool skipWrite = false,
         bool check = false,
+        bool msBuildFormat = false,
         bool writeStdout = false,
         bool includeGenerated = false,
         bool compilationErrorsAsWarnings = false,
@@ -772,7 +793,7 @@ params string[] directoryOrFilePaths
         }
 
         var fakeConsole = new TestConsole();
-        var testLogger = new ConsoleLogger(fakeConsole, LogLevel.Information);
+        var testLogger = new ConsoleLogger(fakeConsole, LogLevel.Information, msBuildFormat);
         var exitCode = CommandLineFormatter
             .Format(
                 new CommandLineOptions
@@ -782,6 +803,7 @@ params string[] directoryOrFilePaths
                     OriginalDirectoryOrFilePaths = originalDirectoryOrFilePaths,
                     SkipWrite = skipWrite,
                     Check = check,
+                    MsBuildFormat = msBuildFormat,
                     WriteStdout = writeStdout || standardInFileContents != null,
                     StandardInFileContents = standardInFileContents,
                     IncludeGenerated = includeGenerated,