Sorting usings (#923)

* Initial work for sorting usings

closes #661

* handling more cases

* maybe fixing last edge case

* Sort by alias

* Fixing some edge cases. Cleaning up sorting.

* Working on validation, notes for some failing to compile files

* Making progress on edge cases for sorting usings

* Adding even more edge cases

* Some finishing touches

* Self code review

* minor change

Shell/Release.psm1 → Shell/CreateRelease.psm1

@@ -1,4 +1,4 @@
-function CSH-Release {
+function CSH-CreateRelease {
     param (
         [Parameter(Mandatory=$true)]
         [string]$versionNumber

Shell/DeleteReviewBranches.psm1

@@ -0,0 +1,12 @@
+function CSH-DeleteReviewBranches {
+
+    # TODO probably make this configurable
+    $pathToTestingRepo = "C:/Projects/csharpier-repos"
+    Set-Location $pathToTestingRepo
+
+    git checkout main
+    git branch | Where-Object { $_ -notmatch "main" } | ForEach-Object { git branch -D $_ }
+    git branch -r | Where-Object { $_ -notmatch "origin/main" } | ForEach-Object { git push origin --delete $_.Replace("origin/", "").Trim() }
+}
+
+Export-ModuleMember -Function CSH-*

Shell/Init.ps1

@@ -1,5 +1,5 @@
 foreach ($file in Get-ChildItem $PSScriptRoot -Filter "*.psm1") {
-    Import-Module $file.FullName -DisableNameChecking
+    Import-Module $file.FullName -DisableNameChecking -Force
 }
 
 Write-Host -ForegroundColor DarkMagenta "Welcome to CSharpier shell"

Shell/ReviewBranch.psm1

@@ -10,7 +10,7 @@ function CSH-ReviewBranch {
     $csharpierDllPath = Join-Path $repositoryRoot "Src/CSharpier.Cli/bin/release/net7.0/dotnet-csharpier.dll"
 
     $location = Get-Location
-    
+
     Set-Location $repositoryRoot
 
     if (!$pathToTestingRepo) {
@@ -32,36 +32,41 @@ function CSH-ReviewBranch {
 
     if ($branch -eq "main") {
         Write-Output "You must be on the branch you want to test. You are currently on main"
-        exit 1
+        return
     }
 
     $preBranch = "pre-" + $branch
     $postBranch = "post-" + $branch
-    
+
     if ($folder -ne $null) {
         $preBranch += "-" + $folder
         $postBranch += "-" + $folder
     }
-
-    Set-Location $pathToTestingRepo
-    & git reset --hard
 
-    git checkout $postBranch
-    $postBranchOutput = (git status) | Out-String
+    Set-Location $pathToTestingRepo
+    & git reset --hard *> $null
+    & git pull
+    try {
+        & git checkout $postBranch 2>&1
+    }
+    catch { }
+    $postBranchOutput = (git status 2>&1) | Out-String
     $firstRun = -not $postBranchOutput.Contains("On branch $postBranch")
 
     $fastParam = ""
     if ($fast -eq $true) {
         $fastParam = "--fast"
     }
 
-    if ($firstRun)
-    {
+    if ($firstRun) {
         Set-Location $repositoryRoot
-        $checkoutMainOutput = (git checkout main) | Out-String
-        if (-not $checkoutMainOutput.Contains("Your branch is up to date with ")) {
-            return
-        }
+#        try  {
+            & git checkout main #2>&1 | Out-String
+#        }
+#        catch {
+#            Write-Host "Could not checkout main on csharpier, working directory is probably not clean"
+#            return
+#        }
 
         CSH-BuildProject
 

Src/CSharpier.FakeGenerators/SyntaxNodeComparerGenerator.cs

@@ -4,6 +4,8 @@
 
 namespace CSharpier.FakeGenerators;
 
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+
 public class SyntaxNodeComparerGenerator
 {
     // this would probably be easier to understand as a scriban template but is a lot of effort
@@ -174,14 +176,27 @@ private static void GenerateMethod(StringBuilder sourceBuilder, Type type)
                 )
             )
             {
-                var compare = propertyType == typeof(SyntaxTokenList) ? "Compare" : "null";
-                if (propertyName == "Modifiers")
+                if (
+                    propertyType.IsGenericType
+                    && propertyType.GenericTypeArguments[0] == typeof(UsingDirectiveSyntax)
+                )
                 {
-                    propertyName += ".OrderBy(o => o.Text).ToList()";
+                    sourceBuilder.AppendLine(
+                        $"            result = this.CompareUsingDirectives(originalNode.{propertyName}, formattedNode.{propertyName}, originalNode, formattedNode);"
+                    );
                 }
-                sourceBuilder.AppendLine(
-                    $"            result = this.CompareLists(originalNode.{propertyName}, formattedNode.{propertyName}, {compare}, o => o.Span, originalNode.Span, formattedNode.Span);"
-                );
+                else
+                {
+                    var compare = propertyType == typeof(SyntaxTokenList) ? "Compare" : "null";
+                    if (propertyName == "Modifiers")
+                    {
+                        propertyName += ".OrderBy(o => o.Text).ToList()";
+                    }
+                    sourceBuilder.AppendLine(
+                        $"            result = this.CompareLists(originalNode.{propertyName}, formattedNode.{propertyName}, {compare}, o => o.Span, originalNode.Span, formattedNode.Span);"
+                    );
+                }
+
                 sourceBuilder.AppendLine($"            if (result.IsInvalid) return result;");
             }
             else if (

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives.test

@@ -1,29 +1,13 @@
 // leading
-using First; // trailing
-
+using A; // trailing
 // leading with space
 using // another trailing
-Second;
-
-using
-// static leading
-static // static trailing
-Third;
-
-using M = System.Math;
-using Point = (int x, int y);
-
-using static System.Math;
-
-global using System;
-
-using First;
-using Second;
+B;
 
 namespace Namespace
 {
-    using Third;
     using One.Two.Three;
+    using Third;
 
     public class ClassName { }
 }

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_BasicIfDirective.expected.test

@@ -0,0 +1,4 @@
+using System;
+#if DEBUG
+using Insite.Bad;
+#endif

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_BasicIfDirective.test

@@ -0,0 +1,4 @@
+#if DEBUG
+using Insite.Bad;
+#endif
+using System;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_BasicSort.expected.test

@@ -0,0 +1,5 @@
+using AWord;
+using BWord;
+using MWord;
+using YWord;
+using ZWord;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_BasicSort.test

@@ -0,0 +1,5 @@
+using MWord;
+using ZWord;
+using AWord;
+using BWord;
+using YWord;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_Basics.test

@@ -0,0 +1,7 @@
+global using Global;
+using System;
+using global::Zebra;
+using Custom;
+using static Expression;
+using Point = (int x, int y);
+using Index = Microsoft.Framework.Index;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase1.test

@@ -0,0 +1,9 @@
+#if BUILD_MSI_TASKS
+using System;
+using Microsoft.Build.Framework;
+
+namespace RepoTasks;
+
+class ClassName { }
+
+#endif

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase2.expected.test

@@ -0,0 +1,6 @@
+using System.IO;
+#if DEBUG
+using System;
+#else
+using Microsoft;
+#endif

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase2.test

@@ -0,0 +1,6 @@
+#if DEBUG
+using System;
+#else
+using Microsoft;
+#endif
+using System.IO;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase3.expected.test

@@ -0,0 +1,6 @@
+using System.IO;
+#if !DEBUG
+using System;
+#else
+using Microsoft;
+#endif

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase3.test

@@ -0,0 +1,6 @@
+#if !DEBUG
+using System;
+#else
+using Microsoft;
+#endif
+using System.IO;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase4.test

@@ -0,0 +1,8 @@
+#if DEBUG
+using A;
+#else
+using B;
+#endif
+#if !DEBUG
+using C;
+#endif

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase5.expected.test

@@ -0,0 +1,10 @@
+using C;
+#if DEBUG
+using A;
+#else
+using B;
+#endif
+
+#if !DEBUG
+using C;
+#endif

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase5.test

@@ -0,0 +1,9 @@
+#if DEBUG
+using A;
+#else
+using B;
+#endif
+using C;
+#if !DEBUG
+using C;
+#endif

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase6.expected.test

@@ -0,0 +1,6 @@
+#if DEBUG
+#define SYMBOL
+#endif
+
+using System;
+using System.Collections;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase6.test

@@ -0,0 +1,6 @@
+#if DEBUG
+#define SYMBOL
+#endif
+
+using System.Collections;
+using System;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase7.expected.test

@@ -0,0 +1,7 @@
+#if DEBUG
+extern alias MonoSecurity;
+#else
+using Mono.Security.Cryptography;
+#endif
+
+using System;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase7.test

@@ -0,0 +1,7 @@
+#if DEBUG
+extern alias MonoSecurity;
+#else
+using Mono.Security.Cryptography;
+#endif
+
+using System;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase9.expected.test

@@ -0,0 +1,6 @@
+#if XMLCHARTYPE_GEN_RESOURCE
+#undef XMLCHARTYPE_USE_RESOURCE
+#endif
+
+using System.Diagnostics;
+using System.Threading;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_EdgeCase9.test

@@ -0,0 +1,6 @@
+#if XMLCHARTYPE_GEN_RESOURCE
+#undef XMLCHARTYPE_USE_RESOURCE
+#endif
+
+using System.Threading;
+using System.Diagnostics;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_FileComments.expected.test

@@ -0,0 +1,4 @@
+// Licensed to something
+
+using Apple;
+using Microsoft;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_FileComments.test

@@ -0,0 +1,4 @@
+// Licensed to something
+
+using Microsoft;
+using Apple;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_KeepDefineAtTop.expected.test

@@ -0,0 +1,7 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+//
+
+#define USE_STRUCT
+using System;
+using System.Runtime.CompilerServices;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_KeepDefineAtTop.test

@@ -0,0 +1,7 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+//
+
+#define USE_STRUCT
+using System.Runtime.CompilerServices;
+using System;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_KeepUndefAtTop.expected.test

@@ -0,0 +1,7 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+//
+
+#undef USE_STRUCT
+using System;
+using System.Runtime.CompilerServices;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_KeepUndefAtTop.test

@@ -0,0 +1,8 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+//
+
+#undef USE_STRUCT
+using System.Runtime.CompilerServices;
+using System;
+

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_SortsAlias.test

@@ -0,0 +1,3 @@
+using A = Z;
+using M = A;
+using Z = M;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_SortsSystemToTop.expected.test

@@ -0,0 +1,4 @@
+using System;
+using System.Web;
+using AWord;
+using ZWord;

Src/CSharpier.Tests/FormattingTests/TestFiles/cs/UsingDirectives_SortsSystemToTop.test

@@ -0,0 +1,4 @@
+using ZWord;
+using AWord;
+using System.Web;
+using System;