support file path for text check

Author: SimonCropp

docs/diff-tool.custom.md

@@ -24,7 +24,7 @@ var resolvedTool = DiffTools.AddTool(
     exePath: diffToolPath,
     binaryExtensions: [".jpg"])!;
 ```
-<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L15-L29' title='Snippet source file'>snippet source</a> | <a href='#snippet-AddTool' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L17-L31' title='Snippet source file'>snippet source</a> | <a href='#snippet-AddTool' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Add a tool based on existing resolved tool:
@@ -39,7 +39,7 @@ var resolvedTool = DiffTools.AddToolBasedOn(
         Left: (temp, target) => $"\"custom args \"{target}\" \"{temp}\"",
         Right: (temp, target) => $"\"custom args \"{temp}\" \"{target}\""))!;
 ```
-<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L62-L71' title='Snippet source file'>snippet source</a> | <a href='#snippet-AddToolBasedOn' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L64-L73' title='Snippet source file'>snippet source</a> | <a href='#snippet-AddToolBasedOn' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -69,7 +69,7 @@ var resolvedTool = DiffTools.AddToolBasedOn(
 
 await DiffRunner.LaunchAsync(resolvedTool!, "PathToTempFile", "PathToTargetFile");
 ```
-<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L82-L93' title='Snippet source file'>snippet source</a> | <a href='#snippet-AddToolAndLaunch' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L84-L95' title='Snippet source file'>snippet source</a> | <a href='#snippet-AddToolAndLaunch' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

docs/diff-tool.md

@@ -63,7 +63,7 @@ This value can also be set using [the DiffEngineTray options dialog](/docs/tray.
 ```cs
 DiffRunner.MaxInstancesToLaunch(10);
 ```
-<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L6-L8' title='Snippet source file'>snippet source</a> | <a href='#snippet-MaxInstancesToLaunch' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L8-L10' title='Snippet source file'>snippet source</a> | <a href='#snippet-MaxInstancesToLaunch' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

docs/diff-tool.order.md

@@ -51,5 +51,5 @@ For example `VisualStudio,Meld` will result in VisualStudio then Meld then all o
 ```cs
 DiffTools.UseOrder(DiffTool.VisualStudio, DiffTool.AraxisMerge);
 ```
-<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L139-L143' title='Snippet source file'>snippet source</a> | <a href='#snippet-UseOrder' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L147-L151' title='Snippet source file'>snippet source</a> | <a href='#snippet-UseOrder' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->

src/DiffEngine.Tests/DiffEngine.Tests.csproj

@@ -16,6 +16,6 @@
     <PackageReference Include="ProjectDefaults" PrivateAssets="all" />
     <PackageReference Include="XunitContext" />
     <ProjectReference Include="..\DiffEngine\DiffEngine.csproj" />
-    <Compile Remove="DefinitionsTest.cs" Condition="'$(TargetFramework)' != 'net8.0'" />
+    <Compile Remove="DefinitionsTest.cs" Condition="'$(TargetFramework)' == 'net9.0'" />
   </ItemGroup>
 </Project>

src/DiffEngine.Tests/DiffToolsTest.cs

@@ -55,6 +55,27 @@ public void OrderShouldNotMessWithAddTool()
         Assert.Equal("MyCustomDiffTool", forExtension.Name);
     }
 
+    [Fact]
+    public void TextConvention()
+    {
+        var diffToolPath = FakeDiffTool.Exe;
+        var resolvedTool = DiffTools.AddTool(
+            name: "MyCustomDiffTool",
+            autoRefresh: true,
+            isMdi: false,
+            supportsText: true,
+            requiresTarget: true,
+            launchArguments: new(
+                Left: (tempFile, targetFile) => $"\"{targetFile}\" \"{tempFile}\"",
+                Right: (tempFile, targetFile) => $"\"{tempFile}\" \"{targetFile}\""),
+            exePath: diffToolPath,
+            binaryExtensions: [])!;
+        DiffTools.UseOrder(DiffTool.VisualStudio, DiffTool.AraxisMerge);
+        Assert.Equal("MyCustomDiffTool", resolvedTool.Name);
+        Assert.True(DiffTools.TryFindByExtension(".txtConvention", out var forExtension));
+        Assert.Equal("MyCustomDiffTool", forExtension.Name);
+    }
+
 #if DEBUG
     [Fact]
     public void AddToolBasedOn()
@@ -129,6 +150,12 @@ public Task LaunchSpecificTextDiff() =>
             Path.Combine(SourceDirectory, "input.target.txt"));
     **/
 
+    [Fact]
+    public Task TextFileConvention()
+    {
+        FileExtensions.AddTextFileConvention(_ => _.EndsWith(".txtConvention".AsSpan()));
+        return DiffRunner.LaunchAsync(Path.Combine(SourceDirectory, "input.temp.txtConvention"), Path.Combine(SourceDirectory, "input.target.txtConvention"));
+    }
     //todo: re enable tests with fake diff tool.
 
     /**
@@ -167,8 +194,7 @@ public void TryFindByName()
     }
 #endif
 **/
-    public DiffToolsTest(ITestOutputHelper output)
-        :
+    public DiffToolsTest(ITestOutputHelper output) :
         base(output) =>
         DiffTools.Reset();
 }

src/DiffEngine.Tests/GlobalUsings.cs

@@ -1,2 +1,3 @@
 global using System.Collections.Immutable;
-global using System.Management;
+global using System.Management;
+global using EmptyFiles;

src/DiffEngine.Tests/ModuleInitializer.cs

@@ -5,6 +5,7 @@ public static class ModuleInitializer
     [ModuleInitializer]
     public static void Initialize()
     {
+        FileExtensions.AddTextFileConvention(_ => _.EndsWith(".txtConvention".AsSpan()));
         Logging.Enable();
         DiffRunner.Disabled = false;
     }

src/DiffEngine.Tests/input.target.txtConvention

@@ -0,0 +1 @@
+target

src/DiffEngine.Tests/input.temp.txtConvention

@@ -0,0 +1 @@
+temp

src/DiffEngine/DiffTools_TryFind.cs

@@ -20,6 +20,32 @@ public static bool TryFindByExtension(
         return ExtensionLookup.TryGetValue(extension, out tool);
     }
 
+    public static bool TryFindForInputFilePath(
+        string path,
+        [NotNullWhen(true)] out ResolvedTool? tool)
+    {
+        if (FileExtensions.IsTextFile(path))
+        {
+            tool = resolved.FirstOrDefault(_ => _.SupportsText);
+            return tool != null;
+        }
+
+        return ExtensionLookup.TryGetValue(Path.GetExtension(path), out tool);
+    }
+    public static bool TryFindForInputFilePath(
+        CharSpan path,
+        [NotNullWhen(true)] out ResolvedTool? tool)
+    {
+        if (FileExtensions.IsTextFile(path))
+        {
+            tool = resolved.FirstOrDefault(_ => _.SupportsText);
+            return tool != null;
+        }
+
+        var extension = Path.GetExtension(path).ToString();
+        return ExtensionLookup.TryGetValue(extension, out tool);
+    }
+
     public static bool TryFindByName(
         DiffTool tool,
         [NotNullWhen(true)] out ResolvedTool? resolvedTool)