Treat files that don't compile as errors. (#1311)

closes #1131 --------- Co-authored-by: Lasath Fernando <devel@lasath.org>
belav · Aug 16, 2024 · 0df263d · 0df263d
1 parent 7d1dc56
commit 0df263d
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 13 deletions.
diff --git a/Src/CSharpier.Cli/CommandLineFormatter.cs b/Src/CSharpier.Cli/CommandLineFormatter.cs
@@ -330,7 +330,7 @@ CommandLineFormatterResult result
     )
     {
         if (
-            (commandLineOptions.StandardInFileContents != null && result.FailedCompilation > 0)
+            (!commandLineOptions.CompilationErrorsAsWarnings && result.FailedCompilation > 0)
             || (commandLineOptions.Check && result.UnformattedFiles > 0)
             || result.FailedSyntaxTreeValidation > 0
             || result.ExceptionsFormatting > 0
@@ -411,7 +411,7 @@ CancellationToken cancellationToken
                 errorMessage.AppendLine(message.ToString());
             }
 
-            if (commandLineOptions.WriteStdout)
+            if (!commandLineOptions.CompilationErrorsAsWarnings)
             {
                 fileIssueLogger.WriteError(errorMessage.ToString());
             }

diff --git a/Src/CSharpier.Cli/CommandLineOptions.cs b/Src/CSharpier.Cli/CommandLineOptions.cs
@@ -13,6 +13,7 @@ internal class CommandLineOptions
     public bool WriteStdout { get; init; }
     public bool NoCache { get; init; }
     public bool NoMSBuildCheck { get; init; }
+    public bool CompilationErrorsAsWarnings { get; init; }
     public bool IncludeGenerated { get; init; }
     public string? StandardInFileContents { get; init; }
     public string? ConfigPath { get; init; }
@@ -30,6 +31,7 @@ internal delegate Task<int> Handler(
         bool noCache,
         bool noMSBuildCheck,
         bool includeGenerated,
+        bool compilationErrorsAsWarnings,
         string config,
         LogLevel logLevel,
         CancellationToken cancellationToken
@@ -93,6 +95,10 @@ public static RootCommand Create()
             new Option<string>(
                 new[] { "--config-path" },
                 "Path to the CSharpier configuration file"
+            ),
+            new Option(
+                new[] { "--compilation-errors-as-warnings" },
+                "Treat compilation errors from files as warnings instead of errors."
             )
         };
 

diff --git a/Src/CSharpier.Cli/Program.cs b/Src/CSharpier.Cli/Program.cs
@@ -33,6 +33,7 @@ public static async Task<int> Run(
         bool noCache,
         bool noMSBuildCheck,
         bool includeGenerated,
+        bool compilationErrorsAsWarnings,
         string configPath,
         LogLevel logLevel,
         CancellationToken cancellationToken
@@ -95,7 +96,8 @@ CancellationToken cancellationToken
             SkipWrite = skipWrite,
             WriteStdout = writeStdout || standardInFileContents != null,
             IncludeGenerated = includeGenerated,
-            ConfigPath = actualConfigPath
+            ConfigPath = actualConfigPath,
+            CompilationErrorsAsWarnings = compilationErrorsAsWarnings,
         };
 
         return await CommandLineFormatter.Format(

diff --git a/Src/CSharpier.MsBuild/build/CSharpier.MsBuild.targets b/Src/CSharpier.MsBuild/build/CSharpier.MsBuild.targets
@@ -17,12 +17,14 @@
   </PropertyGroup>
 
   <Target Name="CSharpierFormatInner" Condition="'$(CSharpier_Bypass)' != 'true'">
+    <!-- IgnoreExitCode cleans up the output when files aren't formatted and fail the check -->
     <!-- &gt; NullOutput suppresses the output from this so that compilation errors will show up a single time -->
     <Exec
       ConsoleToMSBuild="true"
       StdOutEncoding="utf-8"
       StdErrEncoding="utf-8"
-      Command="dotnet &quot;$(CSharpierDllPath)&quot; $(CSharpierArgs) --no-msbuild-check &quot;$(MSBuildProjectDirectory)&quot; &gt; $(NullOutput) " />
+      IgnoreExitCode="true"
+      Command="dotnet &quot;$(CSharpierDllPath)&quot; $(CSharpierArgs) --no-msbuild-check --compilation-errors-as-warnings &quot;$(MSBuildProjectDirectory)&quot; &gt; $(NullOutput) " />
   </Target>
 
   <!-- getting this to run a single time for projects that target multiple frameworks requires all of this

diff --git a/Src/CSharpier.Tests/CommandLineFormatterTests.cs b/Src/CSharpier.Tests/CommandLineFormatterTests.cs
@@ -24,10 +24,28 @@ public void Format_Writes_Failed_To_Compile()
 
         var result = this.Format(context);
 
+        result
+            .ErrorOutputLines.First()
+            .Should()
+            .Be("Error ./Invalid.cs - Failed to compile so was not formatted.");
+
+        result.ExitCode.Should().Be(1);
+    }
+
+    [Test]
+    public void Format_Writes_Failed_To_Compile_As_Warning()
+    {
+        var context = new TestContext();
+        context.WhenAFileExists("Invalid.cs", "asdfasfasdf");
+
+        var result = this.Format(context, compilationErrorsAsWarnings: true);
+
         result
             .OutputLines.First()
             .Should()
             .Be("Warning ./Invalid.cs - Failed to compile so was not formatted.");
+
+        result.ExitCode.Should().Be(0);
     }
 
     [Test]
@@ -39,9 +57,9 @@ public void Format_Writes_Failed_To_Compile_For_Subdirectory()
         var result = this.Format(context, directoryOrFilePaths: "Subdirectory");
 
         result
-            .OutputLines.First()
+            .ErrorOutputLines.First()
             .Should()
-            .Be("Warning ./Subdirectory/Invalid.cs - Failed to compile so was not formatted.");
+            .Be("Error ./Subdirectory/Invalid.cs - Failed to compile so was not formatted.");
     }
 
     [Test]
@@ -56,10 +74,10 @@ public void Format_Writes_Failed_To_Compile_For_FullPath()
         );
 
         result
-            .OutputLines.First()
+            .ErrorOutputLines.First()
             .Should()
             .Be(
-                $"Warning {context.GetRootPath().Replace('\\', '/')}/Subdirectory/Invalid.cs - Failed to compile so was not formatted."
+                $"Error {context.GetRootPath().Replace('\\', '/')}/Subdirectory/Invalid.cs - Failed to compile so was not formatted."
             );
     }
 
@@ -72,9 +90,9 @@ public void Format_Writes_Failed_To_Compile_With_Directory()
         var result = this.Format(context);
 
         result
-            .OutputLines.First()
+            .ErrorOutputLines.First()
             .Should()
-            .Be("Warning ./Directory/Invalid.cs - Failed to compile so was not formatted.");
+            .Be("Error ./Directory/Invalid.cs - Failed to compile so was not formatted.");
     }
 
     [Test]
@@ -91,6 +109,7 @@ public void Format_Writes_Unsupported()
             .Be(@"Warning ./Unsupported.js - Is an unsupported file type.");
     }
 
+    [Test]
     public void Format_Writes_File_With_Directory_Path()
     {
         var context = new TestContext();
@@ -583,9 +602,9 @@ public void File_With_Compilation_Error_Should_Not_Lose_Code()
 
         context.GetFileContent("Invalid.cs").Should().Be(contents);
         result
-            .OutputLines.First()
+            .ErrorOutputLines.First()
             .Should()
-            .Be("Warning ./Invalid.cs - Failed to compile so was not formatted.");
+            .Be("Error ./Invalid.cs - Failed to compile so was not formatted.");
     }
 
     [TestCase(
@@ -652,6 +671,7 @@ private FormatResult Format(
         bool check = false,
         bool writeStdout = false,
         bool includeGenerated = false,
+        bool compilationErrorsAsWarnings = false,
         string? standardInFileContents = null,
         params string[] directoryOrFilePaths
     )
@@ -681,7 +701,8 @@ params string[] directoryOrFilePaths
                     Check = check,
                     WriteStdout = writeStdout || standardInFileContents != null,
                     StandardInFileContents = standardInFileContents,
-                    IncludeGenerated = includeGenerated
+                    IncludeGenerated = includeGenerated,
+                    CompilationErrorsAsWarnings = compilationErrorsAsWarnings,
                 },
                 context.FileSystem,
                 fakeConsole,

diff --git a/Tests/CSharpier.MsBuild.Test/nuget.config b/Tests/CSharpier.MsBuild.Test/nuget.config
@@ -1,6 +1,16 @@
 <?xml version="1.0" encoding="utf-8"?>
 <configuration>
   <packageSources>
+    <clear />
+    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
     <add key="Local" value="../../nupkg" />
   </packageSources>
+  <packageSourceMapping>
+    <packageSource key="nuget.org">
+      <package pattern="*" />
+    </packageSource>
+    <packageSource key="Local">
+      <package pattern="*" />
+    </packageSource>
+  </packageSourceMapping>
 </configuration>