Adding XML formatting (#858)

closes #819

Author: belav

.gitignore

@@ -47,7 +47,6 @@ build
 publish
 
 *.doctree.txt
-*.actual.cst
 *.actual.test
 *.vsix
 /.husky/pre-commit

.idea/.idea.CSharpier/.idea/prettier.xml

@@ -1194,7 +1194,7 @@ host.AddSection(
     tags: Tags.SamplesUsed,
     tasks:
     [
-    // TODO: Add any used third party instruments below as you discover them.
+    // TO-DO: Add any used third party instruments below as you discover them.
     ]
 );
 
@@ -1204,7 +1204,7 @@ host.AddSection(
     tags: Tags.SamplesUsed,
     tasks:
     [
-        // TODO: Add any used third party instruments below as you discover them.
+        // TO-DO: Add any used third party instruments below as you discover them.
     ]
 );
 ```

CHANGELOG.md

@@ -1,4 +1,5 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:Boolean x:Key="/Default/CodeStyle/CSharpUsing/AddImportsToDeepestScope/@EntryValue">False</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Concated/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=csharpier/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=csharpierignore/@EntryIndexedValue">True</s:Boolean>

CSharpier.sln.DotSettings

@@ -5,7 +5,7 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <!-- this is the warning generators get when they fail to generate a source file this makes sure the error for it failing is obvious -->
-    <WarningsAsErrors>CS8032</WarningsAsErrors>
+    <WarningsAsErrors>CS8032;CS8033;</WarningsAsErrors>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <EnableNETAnalyzers>true</EnableNETAnalyzers>
     <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>

Directory.Build.props

@@ -46,24 +46,20 @@ function CSH-UpdateCSharpierRepos()
     Set-Location $destination
     & git checkout main
 
-    Get-ChildItem $tempLocation | Copy-Item -Destination $destination -Filter *.cs -Recurse -Force
+    $extensions = (".csproj", ".props", ".targets", ".xml", ".config", ".cs")
+    
+    foreach ($extension in $extensions)
+    {
+        Get-ChildItem $tempLocation | Copy-Item -Destination $destination -Filter "*$extension" -Recurse -Force    
+    }
 
+    return
+    
     $items = Get-ChildItem -Recurse C:\projects\csharpier-repos -File
     $count = 0
     foreach ($item in $items)
     {
-        if ($item.Name -eq ".git")
-        {
-            Remove-Item -Force -Recurse $item.FullName
-        }
-        elseif ($item.Extension -ne ".cs")
-        {
-            if ($item.Name -ne ".csharpierignore")
-            {
-                Remove-Item $item.FullName
-            }
-        }
-        else
+        if ($item.Extension -eq ".cs")
         {
             # we don't really need all of these files, let's just cut out every other one
             if ($count % 2 -eq 0)
@@ -74,15 +70,6 @@ function CSH-UpdateCSharpierRepos()
         }
     }
 
-    $items = Get-ChildItem C:\projects\csharpier-repos -Directory -Recurse
-    foreach ($item in $items)
-    {
-        if ($item.Name -eq ".git")
-        {
-            Remove-Item -Force -Recurse $item.FullName
-        }
-    }
-
     Set-Location $destination
 
     & git add .

Shell/UpdateCSharpierRepos.psm1

@@ -12,7 +12,10 @@ public class Benchmarks
     [Benchmark]
     public void Default_CodeFormatter()
     {
-        CSharpFormatter.FormatAsync(this.largeCode, new PrinterOptions()).GetAwaiter().GetResult();
+        CSharpFormatter
+            .FormatAsync(this.largeCode, new PrinterOptions(Formatter.CSharp))
+            .GetAwaiter()
+            .GetResult();
     }
 
     [Benchmark]

Src/CSharpier.Benchmarks/Program.cs

@@ -1,5 +1,3 @@
-using System.Collections.Generic;
-using System.Linq;
 using System.Text;
 using CliWrap;
 using CliWrap.Buffered;
@@ -95,8 +93,7 @@ public async Task Should_Respect_Ignore_File_With_Subdirectory_When_DirectorOrFi
         await this.WriteFileAsync(filePath, unformattedContent);
         await this.WriteFileAsync(".csharpierignore", filePath);
 
-        var result = await new CsharpierProcess().WithArguments("format .").ExecuteAsync();
-        result.Output.Should().StartWith("Formatted 0 files in ");
+        await new CsharpierProcess().WithArguments("format .").ExecuteAsync();
         var fileContents = await this.ReadAllTextAsync(filePath);
 
         fileContents
@@ -395,7 +392,7 @@ await this.WriteFileAsync(
 
         result.ErrorOutput.Should().BeEmpty();
         result.ExitCode.Should().Be(0);
-        result.Output.Should().StartWith("Formatted 0 files in ");
+        result.Output.Should().StartWith("Formatted 1 files in ");
     }
 
     [Test]

Src/CSharpier.Cli.Tests/CliTests.cs

@@ -1,6 +1,5 @@
 using System.Diagnostics;
 using System.Net.Http.Json;
-using System.Text;
 using CliWrap;
 using CliWrap.EventStream;
 using CSharpier.Cli.Server;

Src/CSharpier.Cli.Tests/ServerTests.cs

@@ -379,18 +379,13 @@ CancellationToken cancellationToken
 
         cancellationToken.ThrowIfCancellationRequested();
 
-        CodeFormatterResult codeFormattingResult;
-
-        var sourceCodeKind = Path.GetExtension(fileToFormatInfo.Path).EqualsIgnoreCase(".csx")
-            ? SourceCodeKind.Script
-            : SourceCodeKind.Regular;
+        CodeFormatterResult? codeFormattingResult;
 
         try
         {
-            codeFormattingResult = await CSharpFormatter.FormatAsync(
+            codeFormattingResult = await CodeFormatter.FormatAsync(
                 fileToFormatInfo.FileContents,
                 printerOptions,
-                sourceCodeKind,
                 cancellationToken
             );
         }
@@ -427,6 +422,12 @@ CancellationToken cancellationToken
             return;
         }
 
+        if (!codeFormattingResult.WarningMessage.IsBlank())
+        {
+            fileIssueLogger.WriteWarning(codeFormattingResult.WarningMessage);
+            return;
+        }
+
         if (!codeFormattingResult.FailureMessage.IsBlank())
         {
             fileIssueLogger.WriteError(codeFormattingResult.FailureMessage);
@@ -435,35 +436,45 @@ CancellationToken cancellationToken
 
         if (!commandLineOptions.Fast)
         {
-            var syntaxNodeComparer = new SyntaxNodeComparer(
-                fileToFormatInfo.FileContents,
-                codeFormattingResult.Code,
-                codeFormattingResult.ReorderedModifiers,
-                codeFormattingResult.ReorderedUsingsWithDisabledText,
-                codeFormattingResult.MovedTrailingTrivia,
-                sourceCodeKind,
-                cancellationToken
-            );
-
-            try
+            if (printerOptions.Formatter is Formatter.CSharp or Formatter.CSharpScript)
             {
-                var failure = await syntaxNodeComparer.CompareSourceAsync(cancellationToken);
-                if (!string.IsNullOrEmpty(failure))
+                var sourceCodeKind =
+                    printerOptions.Formatter is Formatter.CSharpScript
+                        ? SourceCodeKind.Script
+                        : SourceCodeKind.Regular;
+
+                var syntaxNodeComparer = new SyntaxNodeComparer(
+                    fileToFormatInfo.FileContents,
+                    codeFormattingResult.Code,
+                    codeFormattingResult.ReorderedModifiers,
+                    codeFormattingResult.ReorderedUsingsWithDisabledText,
+                    codeFormattingResult.MovedTrailingTrivia,
+                    sourceCodeKind,
+                    cancellationToken
+                );
+
+                try
+                {
+                    var failure = await syntaxNodeComparer.CompareSourceAsync(cancellationToken);
+                    if (!string.IsNullOrEmpty(failure))
+                    {
+                        Interlocked.Increment(
+                            ref commandLineFormatterResult.FailedSyntaxTreeValidation
+                        );
+                        fileIssueLogger.WriteError($"Failed syntax tree validation.\n{failure}");
+                    }
+                }
+                catch (Exception ex)
                 {
                     Interlocked.Increment(
-                        ref commandLineFormatterResult.FailedSyntaxTreeValidation
+                        ref commandLineFormatterResult.ExceptionsValidatingSource
                     );
-                    fileIssueLogger.WriteError($"Failed syntax tree validation.\n{failure}");
-                }
-            }
-            catch (Exception ex)
-            {
-                Interlocked.Increment(ref commandLineFormatterResult.ExceptionsValidatingSource);
 
-                fileIssueLogger.WriteError(
-                    "Failed with exception during syntax tree validation.",
-                    ex
-                );
+                    fileIssueLogger.WriteError(
+                        "Failed with exception during syntax tree validation.",
+                        ex
+                    );
+                }
             }
         }