doco

Author: SimonCropp

docs/diff-tool.order.md

@@ -34,7 +34,7 @@ To change this file edit the source file and then run MarkdownSnippets.
 
 ### ViaEnvironment Variable
 
-Set an `Verify.DiffToolOrder` environment variable with the preferred order of toll resolution. The value can be comma (`,`), pipe (`|`), or space separated.
+Set an `DiffEngine.DiffToolOrder` environment variable with the preferred order of toll resolution. The value can be comma (`,`), pipe (`|`), or space separated.
 
 For example `VisualStudio,Meld` will result in VisualStudio then Meld then all other tools being the order.
 

docs/mdsource/diff-tool.order.source.md

@@ -11,7 +11,7 @@ include: defaultDiffToolOrder
 
 ### ViaEnvironment Variable
 
-Set an `Verify.DiffToolOrder` environment variable with the preferred order of toll resolution. The value can be comma (`,`), pipe (`|`), or space separated.
+Set an `DiffEngine.DiffToolOrder` environment variable with the preferred order of toll resolution. The value can be comma (`,`), pipe (`|`), or space separated.
 
 For example `VisualStudio,Meld` will result in VisualStudio then Meld then all other tools being the order.
 

src/DiffEngine.Tests/AssemblyLocation.cs

@@ -0,0 +1,17 @@
+using System;
+using System.IO;
+
+static class AssemblyLocation
+{
+    static AssemblyLocation()
+    {
+        var assembly = typeof(AssemblyLocation).Assembly;
+
+        var uri = new UriBuilder(assembly.CodeBase!);
+        var path = Uri.UnescapeDataString(uri.Path);
+
+        CurrentDirectory = Path.GetDirectoryName(path)!;
+    }
+
+    public static string CurrentDirectory;
+}

src/DiffEngine.Tests/DiffRunnerTests.cs

@@ -27,6 +27,27 @@ public void Kill()
         #endregion
     }
 
+    //static string diffToolPath = Path.GetFullPath(Path.Combine(AssemblyLocation.CurrentDirectory, "../../../../FakeDiffTool/bin/FakeDiffTool.exe"));
+
+    //[Fact]
+    //public void LaunchAndKill()
+    //{
+    //    DiffTools.AddCustomTool(
+    //        supportsAutoRefresh: true,
+    //        isMdi: false,
+    //        supportsText: true,
+    //        requiresTarget: true,
+    //        buildArguments: (path1, path2) => $"\"{path1}\" \"{path2}\"",
+    //        exePath: diffToolPath,
+    //        binaryExtensions: new[] {"knownBin"});
+    //    var tempFile = Path.Combine(SourceDirectory, "DiffRunner.file1.txt");
+    //    var targetFile = Path.Combine(SourceDirectory, "DiffRunner.file2.txt");
+    //    DiffRunner.Launch(tempFile, targetFile);
+    //    Assert.NotEmpty(ProcessCleanup.FindAll());
+    //    DiffRunner.Kill(tempFile, targetFile);
+    //    Assert.Empty(ProcessCleanup.FindAll());
+    //}
+
     public DiffRunnerTests(ITestOutputHelper output) :
         base(output)
     {

src/DiffEngine.Tests/DiffToolsTest.cs

@@ -53,7 +53,7 @@ public void ParseEnvironmentVariable()
     public void BadEnvironmentVariable()
     {
         var exception = Assert.Throws<Exception>(() => DiffTools.ParseEnvironmentVariable("Foo").ToList());
-        Assert.Equal("Unable to parse tool from `Verify.DiffToolOrder` environment variable: Foo", exception.Message);
+        Assert.Equal("Unable to parse tool from `DiffEngine.DiffToolOrder` environment variable: Foo", exception.Message);
     }
 
     [Fact]

src/DiffEngine/DiffTools.cs

@@ -71,7 +71,12 @@ internal static List<ToolDefinition> Tools()
 
         static DiffTools()
         {
-            var diffOrder = Environment.GetEnvironmentVariable("Verify.DiffToolOrder");
+            var diffOrder = Environment.GetEnvironmentVariable("DiffEngine.ToolOrder");
+            if (diffOrder == null)
+            {
+                diffOrder = Environment.GetEnvironmentVariable("Verify.DiffToolOrder");
+            }
+
             IEnumerable<DiffTool> order;
             bool throwForNoTool;
             if (string.IsNullOrWhiteSpace(diffOrder))
@@ -140,7 +145,7 @@ internal static IEnumerable<DiffTool> ParseEnvironmentVariable(string diffOrder)
             {
                 if (!Enum.TryParse<DiffTool>(toolString, out var diffTool))
                 {
-                    throw new Exception($"Unable to parse tool from `Verify.DiffToolOrder` environment variable: {toolString}");
+                    throw new Exception($"Unable to parse tool from `DiffEngine.DiffToolOrder` environment variable: {toolString}");
                 }
 
                 yield return diffTool;
@@ -160,7 +165,7 @@ static IEnumerable<ToolDefinition> ToolsByOrder(bool throwForNoTool, IEnumerable
                         continue;
                     }
 
-                    throw new Exception($"`Verify.DiffToolOrder` is configured to use '{diffTool}' but it is not installed.");
+                    throw new Exception($"`DiffEngine.DiffToolOrder` is configured to use '{diffTool}' but it is not installed.");
                 }
 
                 yield return definition;