Fix tool order

Author: SimonCropp

readme.md

@@ -72,8 +72,8 @@ DiffEngine manages launching and cleanup of diff tools. It is designed to be use
  * **[Diffinity](/docs/diff-tool.md#diffinity)** Windows (Cost: Free with option to donate)
  * **[ExamDiff](/docs/diff-tool.md#examdiff)** Windows (Cost: Paid)
  * **[Guiffy](/docs/diff-tool.md#guiffy)** Windows/OSX (Cost: Paid)
- * **[KDiff3](/docs/diff-tool.md#kdiff3)** Windows/OSX (Cost: Free)
  * **[Kaleidoscope](/docs/diff-tool.md#kaleidoscope)** OSX (Cost: Paid)
+ * **[KDiff3](/docs/diff-tool.md#kdiff3)** Windows/OSX (Cost: Free)
  * **[Meld](/docs/diff-tool.md#meld)** Windows/OSX/Linux (Cost: Free)
  * **[MsExcelDiff](/docs/diff-tool.md#msexceldiff)** Windows (Cost: Free)
  * **[MsWordDiff](/docs/diff-tool.md#msworddiff)** Windows (Cost: Free)

src/DiffEngine.Tests/DefinitionsTest.cs

@@ -65,6 +65,14 @@ static string GetOsSupport(OsSupport osSupport)
         return builder.ToString();
     }
 
+    [Test]
+    public async Task ToolOrderMatchesEnumOrder()
+    {
+        var definitionsOrder = Definitions.Tools.Select(_ => _.Tool).ToList();
+        var enumOrder = Enum.GetValues(typeof(DiffTool)).Cast<DiffTool>().ToList();
+        await Assert.That(definitionsOrder).IsEquivalentTo(enumOrder);
+    }
+
     [Test]
     public void WriteDefaultOrder()
     {

src/DiffEngine/Definitions.cs

@@ -5,6 +5,7 @@ public static class Definitions
     public static IReadOnlyCollection<Definition> Tools { get; }
 
     static Definitions() =>
+        // Order determines default tool priority. Keep in sync with the DiffTool enum.
         Tools =
         [
             Implementation.MsWordDiff(),

src/DiffEngine/DiffTool.cs

@@ -1,7 +1,11 @@
 namespace DiffEngine;
 
+// The order of this enum determines the default tool priority in DiffTools.Resolved.
+// Keep this order in sync with Definitions.Tools.
 public enum DiffTool
 {
+    MsWordDiff,
+    MsExcelDiff,
     BeyondCompare,
     P4Merge,
     Kaleidoscope,
@@ -25,6 +29,4 @@ public enum DiffTool
     VisualStudioCode,
     VisualStudio,
     Cursor,
-    MsWordDiff,
-    MsExcelDiff
 }

src/Directory.Build.props

@@ -2,7 +2,7 @@
 <Project>
   <PropertyGroup>
     <NoWarn>CS1591;CS0649;NU1608;NU1109</NoWarn>
-    <Version>19.1.1</Version>
+    <Version>19.1.2</Version>
     <AssemblyVersion>1.0.0</AssemblyVersion>
     <PackageTags>Testing, Snapshot, Diff, Compare</PackageTags>
     <Description>Launches diff tools based on file extensions. Designed to be consumed by snapshot testing libraries.</Description>