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

Src/CSharpier.Cli/CommandLineFormatter.cs

@@ -1,10 +1,10 @@
-using System.Diagnostics;
-using System.IO.Abstractions;
-using System.Text;
 using CSharpier.Cli.Options;
 using CSharpier.Utilities;
 using Microsoft.CodeAnalysis;
 using Microsoft.Extensions.Logging;
+using System.Diagnostics;
+using System.IO.Abstractions;
+using System.Text;
 
 namespace CSharpier.Cli;
 
@@ -60,7 +60,8 @@ CancellationToken cancellationToken
                 {
                     var fileIssueLogger = new FileIssueLogger(
                         commandLineOptions.OriginalDirectoryOrFilePaths[0],
-                        logger
+                        logger,
+                        commandLineOptions.LogFormat
                     );
 
                     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,
+                        logFormat: LogFormat.Console
+                    );
                     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.LogFormat
+        );
 
         logger.LogDebug(
             commandLineOptions.Check

Src/CSharpier.Cli/CommandLineOptions.cs

@@ -1,12 +1,13 @@
-using System.CommandLine;
 using Microsoft.Extensions.Logging;
+using System.CommandLine;
 
 namespace CSharpier.Cli;
 
 internal class CommandLineOptions
 {
     public string[] DirectoryOrFilePaths { get; init; } = [];
     public bool Check { get; init; }
+    public LogFormat LogFormat { 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,
+        LogFormat logFormat,
         bool fast,
         bool skipWrite,
         bool writeStdout,
@@ -52,6 +54,16 @@ public static RootCommand Create()
                 () => LogLevel.Information.ToString(),
                 "Specify the log level - Debug, Information (default), Warning, Error, None"
             ),
+            new Option<LogFormat>(
+                ["--log-format"],
+                () => LogFormat.Console,
+                """
+                Log output format
+                    Console - Formats messages in a human readable way for console
+                              interaction.
+                    MsBuild - 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,8 @@
 
 namespace CSharpier.Cli;
 
-internal class ConsoleLogger(IConsole console, LogLevel loggingLevel) : ILogger
+internal class ConsoleLogger(IConsole console, LogLevel loggingLevel, LogFormat logFormat)
+    : ILogger
 {
     private static readonly object ConsoleLock = new();
 
@@ -52,7 +53,7 @@ void WriteLine(string? value = null)
         {
             var message = formatter(state, exception!);
 
-            if (logLevel >= LogLevel.Warning)
+            if (logFormat == LogFormat.Console && logLevel >= LogLevel.Warning)
             {
                 console.ForegroundColor = GetColorLevel(logLevel);
                 Write($"{logLevel} ");

Src/CSharpier.Cli/FileIssueLogger.cs

@@ -2,16 +2,27 @@
 
 namespace CSharpier.Cli;
 
-internal class FileIssueLogger(string filePath, ILogger logger)
+internal class FileIssueLogger(string filePath, ILogger logger, LogFormat logFormat)
 {
     public void WriteError(string value, Exception? exception = null)
     {
-        logger.LogError(exception, $"{this.GetPath()} - {value}");
+        logger.LogError(exception, GetMessageTemplate(), this.GetPath(), value);
     }
 
     public void WriteWarning(string value)
     {
-        logger.LogWarning($"{this.GetPath()} - {value}");
+        // TODO: add tests for "log warnings in Console / MsBuildFormat"
+        logger.LogWarning(GetMessageTemplate(), this.GetPath(), value);
+    }
+
+    private string GetMessageTemplate()
+    {
+        return logFormat switch
+        {
+            LogFormat.MsBuild => "{Path}: error: {Message}",
+            LogFormat.Console => "{Path} - {Message}",
+            _ => throw new NotImplementedException($"LogFormat: {Enum.GetName(logFormat)}"),
+        };
     }
 
     private string GetPath()

Src/CSharpier.Cli/LogFormat.cs

@@ -0,0 +1,14 @@
+namespace CSharpier.Cli;
+
+internal enum LogFormat
+{
+    /// <summary>
+    /// Formats messages in a human readable way for console interaction.
+    /// </summary>
+    Console,
+
+    /// <summary>
+    /// Formats messages in standard error/warning format for MSBuild.
+    /// </summary>
+    MsBuild
+}

Src/CSharpier.Cli/Program.cs

@@ -1,9 +1,8 @@
+using CSharpier.Cli.Server;
+using Microsoft.Extensions.Logging;
 using System.CommandLine;
 using System.CommandLine.Invocation;
 using System.IO.Abstractions;
-using System.Text;
-using CSharpier.Cli.Server;
-using Microsoft.Extensions.Logging;
 
 namespace CSharpier.Cli;
 
@@ -23,6 +22,7 @@ public static async Task<int> Main(string[] args)
     public static async Task<int> Run(
         string[]? directoryOrFile,
         bool check,
+        LogFormat logFormat,
         bool fast,
         bool skipWrite,
         bool writeStdout,
@@ -42,7 +42,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, logFormat);
 
         if (pipeMultipleFiles)
         {
@@ -89,6 +89,7 @@ CancellationToken cancellationToken
             OriginalDirectoryOrFilePaths = originalDirectoryOrFile!,
             StandardInFileContents = standardInFileContents,
             Check = check,
+            LogFormat = logFormat,
             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) --log-format msBuild --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,9 +1,9 @@
-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;
 
@@ -362,6 +362,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, logFormat: LogFormat.MsBuild);
+
+        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 +767,7 @@ private static FormatResult Format(
         TestContext context,
         bool skipWrite = false,
         bool check = false,
+        LogFormat logFormat = LogFormat.Console,
         bool writeStdout = false,
         bool includeGenerated = false,
         bool compilationErrorsAsWarnings = false,
@@ -772,7 +790,7 @@ params string[] directoryOrFilePaths
         }
 
         var fakeConsole = new TestConsole();
-        var testLogger = new ConsoleLogger(fakeConsole, LogLevel.Information);
+        var testLogger = new ConsoleLogger(fakeConsole, LogLevel.Information, logFormat);
         var exitCode = CommandLineFormatter
             .Format(
                 new CommandLineOptions
@@ -782,6 +800,7 @@ params string[] directoryOrFilePaths
                     OriginalDirectoryOrFilePaths = originalDirectoryOrFilePaths,
                     SkipWrite = skipWrite,
                     Check = check,
+                    LogFormat = logFormat,
                     WriteStdout = writeStdout || standardInFileContents != null,
                     StandardInFileContents = standardInFileContents,
                     IncludeGenerated = includeGenerated,