Add MsExcelDiff support (#685)

Author: SimonCropp

docs/diff-tool.md

@@ -483,7 +483,46 @@ DiffTools.UseOrder(DiffTool.KDiff3);
     * `/Applications/kdiff3.app/Contents/MacOS/kdiff3`
     * `%PATH%kdiff3`
 
-### [MsWordDiff](https://github.com/SimonCropp/MsWordDiff)
+### [MsExcelDiff](https://github.com/SimonCropp/MsOfficeDiff)
+
+  * Cost: Free
+  * Is MDI: False
+  * Supports auto-refresh: False
+  * Supports text files: False
+  * Use shell execute: False
+  * Create no window: True
+  * Environment variable for custom install location: `DiffEngine_MsExcelDiff`
+  * Supported binaries: .xls, .xlsx
+
+#### Tool order:
+
+Use [tool order](diff-tool.order.md) to prioritise MsExcelDiff over other tools.
+
+```
+DiffTools.UseOrder(DiffTool.MsExcelDiff);
+```
+
+#### Notes:
+
+ * Install via `dotnet tool install -g MsExcelDiff`
+ * Requires Spreadsheet Compare (Office Professional Plus / Microsoft 365 Apps for Enterprise)
+ * Uses Microsoft's Spreadsheet Compare to show differences between workbooks
+
+#### Windows settings:
+
+  * Example target on left arguments:
+   ```
+   "targetFile.txt" "tempFile.txt"
+   ```
+  * Example target on right arguments:
+   ```
+   "tempFile.txt" "targetFile.txt"
+   ```
+  * Scanned paths:
+    * `%USERPROFILE%\.dotnet\tools\diffexcel.exe`
+    * `%PATH%diffexcel.exe`
+
+### [MsWordDiff](https://github.com/SimonCropp/MsOfficeDiff)
 
   * Cost: Free
   * Is MDI: False

docs/diff-tool.order.md

@@ -33,7 +33,8 @@ To change this file edit the source file and then run MarkdownSnippets.
  * **[VisualStudioCode](/docs/diff-tool.md#visualstudiocode)** Windows/OSX/Linux (Cost: Free)
  * **[Cursor](/docs/diff-tool.md#cursor)** Windows/OSX/Linux (Cost: Free and Paid)
  * **[VisualStudio](/docs/diff-tool.md#visualstudio)** Windows (Cost: Paid and free options)
- * **[MsWordDiff](/docs/diff-tool.md#msworddiff)** Windows (Cost: Free)<!-- endInclude -->
+ * **[MsWordDiff](/docs/diff-tool.md#msworddiff)** Windows (Cost: Free)
+ * **[MsExcelDiff](/docs/diff-tool.md#msexceldiff)** Windows (Cost: Free)<!-- endInclude -->
 
 
 ## Custom order

readme.md

@@ -29,7 +29,12 @@ DiffEngine manages launching and cleanup of diff tools. It is designed to be use
 
 [Entity Framework Extensions](https://entityframework-extensions.net/?utm_source=simoncropp&utm_medium=DiffEngine) is a major sponsor and is proud to contribute to the development this project.
 
-[![Entity Framework Extensions](https://raw.githubusercontent.com/VerifyTests/DiffEngine/refs/heads/main/docs/zzz.png)](https://entityframework-extensions.net/?utm_source=simoncropp&utm_medium=DiffEngine)<!-- endInclude -->
+[![Entity Framework Extensions](https://raw.githubusercontent.com/VerifyTests/DiffEngine/refs/heads/main/docs/zzz.png)](https://entityframework-extensions.net/?utm_source=simoncropp&utm_medium=DiffEngine)
+
+### Developed using JetBrains IDEs
+
+[![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport)<!-- endInclude -->
+
 
 
 <!-- toc -->
@@ -83,7 +88,8 @@ DiffEngine manages launching and cleanup of diff tools. It is designed to be use
  * **[VisualStudioCode](/docs/diff-tool.md#visualstudiocode)** Windows/OSX/Linux (Cost: Free)
  * **[Cursor](/docs/diff-tool.md#cursor)** Windows/OSX/Linux (Cost: Free and Paid)
  * **[VisualStudio](/docs/diff-tool.md#visualstudio)** Windows (Cost: Paid and free options)
- * **[MsWordDiff](/docs/diff-tool.md#msworddiff)** Windows (Cost: Free)<!-- endInclude -->
+ * **[MsWordDiff](/docs/diff-tool.md#msworddiff)** Windows (Cost: Free)
+ * **[MsExcelDiff](/docs/diff-tool.md#msexceldiff)** Windows (Cost: Free)<!-- endInclude -->
 
 
 ## Launching a tool

src/DiffEngine.Tests/DiffRunnerTests.cs

@@ -94,7 +94,7 @@ public async Task LaunchAndKillDisabled()
         {
             await Assert.That(IsRunning()).IsFalse();
             await Assert.That(ProcessCleanup.IsRunning(command)).IsFalse();
-            var result = DiffRunner.Launch(file1, file2);
+            var result = await DiffRunner.LaunchAsync(file1, file2);
             await Assert.That(result).IsEqualTo(LaunchResult.Disabled);
             Thread.Sleep(500);
             ProcessCleanup.Refresh();
@@ -143,7 +143,7 @@ public async Task LaunchAndKill()
     {
         await Assert.That(IsRunning()).IsFalse();
         await Assert.That(ProcessCleanup.IsRunning(command)).IsFalse();
-        var result = DiffRunner.Launch(file1, file2);
+        var result = await DiffRunner.LaunchAsync(file1, file2);
         await Assert.That(result).IsEqualTo(LaunchResult.StartedNewInstance);
         Thread.Sleep(500);
         ProcessCleanup.Refresh();

src/DiffEngine.Tests/defaultOrder.include.md

@@ -22,3 +22,4 @@
  * **[Cursor](/docs/diff-tool.md#cursor)** Windows/OSX/Linux (Cost: Free and Paid)
  * **[VisualStudio](/docs/diff-tool.md#visualstudio)** Windows (Cost: Paid and free options)
  * **[MsWordDiff](/docs/diff-tool.md#msworddiff)** Windows (Cost: Free)
+ * **[MsExcelDiff](/docs/diff-tool.md#msexceldiff)** Windows (Cost: Free)

src/DiffEngine.Tests/diffToolList.include.md

@@ -22,3 +22,4 @@
  * **[Cursor](/docs/diff-tool.md#cursor)** Windows/OSX/Linux (Cost: Free and Paid)
  * **[VisualStudio](/docs/diff-tool.md#visualstudio)** Windows (Cost: Paid and free options)
  * **[MsWordDiff](/docs/diff-tool.md#msworddiff)** Windows (Cost: Free)
+ * **[MsExcelDiff](/docs/diff-tool.md#msexceldiff)** Windows (Cost: Free)

src/DiffEngine.Tests/diffTools.include.md

@@ -348,7 +348,46 @@ DiffTools.UseOrder(DiffTool.KDiff3);
     * `/Applications/kdiff3.app/Contents/MacOS/kdiff3`
     * `%PATH%kdiff3`
 
-### [MsWordDiff](https://github.com/SimonCropp/MsWordDiff)
+### [MsExcelDiff](https://github.com/SimonCropp/MsOfficeDiff)
+
+  * Cost: Free
+  * Is MDI: False
+  * Supports auto-refresh: False
+  * Supports text files: False
+  * Use shell execute: False
+  * Create no window: True
+  * Environment variable for custom install location: `DiffEngine_MsExcelDiff`
+  * Supported binaries: .xls, .xlsx
+
+#### Tool order:
+
+Use [tool order](diff-tool.order.md) to prioritise MsExcelDiff over other tools.
+
+```
+DiffTools.UseOrder(DiffTool.MsExcelDiff);
+```
+
+#### Notes:
+
+ * Install via `dotnet tool install -g MsExcelDiff`
+ * Requires Spreadsheet Compare (Office Professional Plus / Microsoft 365 Apps for Enterprise)
+ * Uses Microsoft's Spreadsheet Compare to show differences between workbooks
+
+#### Windows settings:
+
+  * Example target on left arguments:
+   ```
+   "targetFile.txt" "tempFile.txt"
+   ```
+  * Example target on right arguments:
+   ```
+   "tempFile.txt" "targetFile.txt"
+   ```
+  * Scanned paths:
+    * `%USERPROFILE%\.dotnet\tools\diffexcel.exe`
+    * `%PATH%diffexcel.exe`
+
+### [MsWordDiff](https://github.com/SimonCropp/MsOfficeDiff)
 
   * Cost: Free
   * Is MDI: False

src/DiffEngine/Definitions.cs

@@ -30,6 +30,7 @@ static Definitions() =>
             Implementation.VisualStudioCode(),
             Implementation.Cursor(),
             Implementation.VisualStudio(),
-            Implementation.MsWordDiff()
+            Implementation.MsWordDiff(),
+            Implementation.MsExcelDiff()
         ];
 }

src/DiffEngine/DiffTool.cs

@@ -25,5 +25,6 @@ public enum DiffTool
     VisualStudioCode,
     VisualStudio,
     Cursor,
-    MsWordDiff
+    MsWordDiff,
+    MsExcelDiff
 }

src/DiffEngine/Implementation/MsExcelDiff.cs

@@ -0,0 +1,36 @@
+static partial class Implementation
+{
+    public static Definition MsExcelDiff()
+    {
+        var launchArguments = new LaunchArguments(
+            Left: (temp, target) => $"\"{target}\" \"{temp}\"",
+            Right: (temp, target) => $"\"{temp}\" \"{target}\"");
+
+        return new(
+            Tool: DiffTool.MsExcelDiff,
+            Url: "https://github.com/SimonCropp/MsOfficeDiff",
+            AutoRefresh: false,
+            IsMdi: false,
+            SupportsText: false,
+            RequiresTarget: true,
+            BinaryExtensions:
+            [
+                ".xlsx",
+                ".xls"
+            ],
+            Cost: "Free",
+            OsSupport: new(
+                Windows: new(
+                    "diffexcel.exe",
+                    launchArguments,
+                    @"%USERPROFILE%\.dotnet\tools\")),
+            UseShellExecute: false,
+            CreateNoWindow: true,
+            KillLockingProcess: true,
+            Notes: """
+                 * Install via `dotnet tool install -g MsExcelDiff`
+                 * Requires Spreadsheet Compare (Office Professional Plus / Microsoft 365 Apps for Enterprise)
+                 * Uses Microsoft's Spreadsheet Compare to show differences between workbooks
+                """);
+    }
+}