Add support for optional CreateNoWindow (#619)

Author: SimonCropp

docs/diff-tool.custom.md

@@ -18,13 +18,14 @@ var resolvedTool = DiffTools.AddTool(
     isMdi: false,
     supportsText: true,
     requiresTarget: true,
+    createNoWindow: false,
     launchArguments: new(
         Left: (tempFile, targetFile) => $"\"{targetFile}\" \"{tempFile}\"",
         Right: (tempFile, targetFile) => $"\"{tempFile}\" \"{targetFile}\""),
     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#L15-L30' 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 +40,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#L82-L91' 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#L85-L94' title='Snippet source file'>snippet source</a> | <a href='#snippet-AddToolBasedOn' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -69,7 +70,7 @@ var resolvedTool = DiffTools.AddToolBasedOn(
 
 await DiffRunner.LaunchAsync(resolvedTool!, "PathToTempFile", "PathToTargetFile");
 ```
-<sup><a href='/src/DiffEngine.Tests/DiffToolsTest.cs#L102-L113' 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#L105-L116' title='Snippet source file'>snippet source</a> | <a href='#snippet-AddToolAndLaunch' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

docs/diff-tool.md

@@ -145,6 +145,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_BeyondCompare`
   * Supported binaries: .bmp, .gif, .ico, .jpeg, .jpg, .pdf, .png, .rtf, .svg, .tif, .tiff
 
@@ -186,6 +187,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_DeltaWalker`
   * Supported binaries: .bmp, .bz2, .doc, .docx, .ear, .gif, .gz, .htm, .html, .ico, .j2k, .jar, .jp2, .jpg, .pbm, .pct, .pdf, .pgm, .pic, .pict, .png, .pnm, .ppm, .ppt, .psd, .rtf, .svg, .tar, .tbz2, .tgz, .tif, .xls, .xlsx, .zip
 
@@ -217,6 +219,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_Diffinity`
   * Supported binaries: .svg
 
@@ -236,6 +239,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_ExamDiff`
   * Supported binaries: .svg
 
@@ -261,6 +265,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_Guiffy`
   * Supported binaries: .bmp, .gif, .jpeg, .jpg, .png, .svg, .wbmp
 
@@ -295,6 +300,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_Kaleidoscope`
   * Supported binaries: .bmp, .gif, .ico, .jpeg, .jpg, .png, .svg, .tif, .tiff
 
@@ -311,6 +317,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_KDiff3`
   * Supported binaries: .svg
 
@@ -345,6 +352,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_Neovim`
   * Supported binaries: .svg
 
@@ -379,6 +387,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_P4Merge`
   * Supported binaries: .bmp, .gif, .jpeg, .jpg, .pbm, .pgm, .png, .ppm, .svg, .tif, .tiff, .xbm, .xpm
 
@@ -419,6 +428,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_Rider`
   * Supported binaries: .svg
 
@@ -460,6 +470,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_TkDiff`
   * Supported binaries: .svg
 
@@ -477,6 +488,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: False
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_TortoiseGitIDiff`
   * Supported binaries: .bmp, .gif, .ico, .jpeg, .jpg, .png, .tif, .tiff
 
@@ -496,6 +508,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_TortoiseGitMerge`
   * Supported binaries: .svg
 
@@ -515,6 +528,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: False
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_TortoiseIDiff`
   * Supported binaries: .bmp, .gif, .ico, .jpeg, .jpg, .png, .tif, .tiff
 
@@ -534,6 +548,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_TortoiseMerge`
   * Supported binaries: .svg
 
@@ -553,6 +568,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_Vim`
   * Supported binaries: .svg
 
@@ -588,6 +604,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_WinMerge`
   * Supported binaries: .bmp, .bw, .cut, .dds, .exr, .g3, .gif, .hdp, .hdr, .ico, .iff, .j2c, .j2k, .jif, .jng, .jp2, .jpe, .jpeg, .jpg, .jxr, .koa, .lbm, .mng, .pbm, .pcd, .pct, .pcx, .pfm, .pgm, .pic, .pict, .png, .ppm, .psd, .ras, .rgb, .rgba, .sgi, .svg, .targa, .tga, .tif, .tiff, .wap, .wbm, .wbmp, .wdp, .webp, .xbm, .xpm
 
@@ -620,6 +637,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_AraxisMerge`
   * Supported binaries: .bmp, .dib, .emf, .gif, .j2c, .j2k, .jif, .jp2, .jpc, .jpeg, .jpg, .jpx, .pbm, .pcx, .pgm, .png, .ppm, .ras, .svg, .tga, .tif, .tiff, .wmf
 
@@ -654,6 +672,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: False
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_Meld`
   * Supported binaries: .svg
 
@@ -693,6 +712,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: False
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_SublimeMerge`
   * Supported binaries: .svg
 
@@ -731,6 +751,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_VisualStudio`
   * Supported binaries: .svg
 
@@ -759,6 +780,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: True
   * Supports text files: True
+  * Create no window: False
   * Environment variable for custom install location: `DiffEngine_VisualStudioCode`
   * Supported binaries: .svg
 

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#L174-L178' 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#L177-L181' title='Snippet source file'>snippet source</a> | <a href='#snippet-UseOrder' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->

src/DiffEngine.Tests/DefinitionsTest.cs

@@ -124,12 +124,13 @@ static void AddTool(StreamWriter writer, Definition tool)
                * Is MDI: {tool.IsMdi}
                * Supports auto-refresh: {tool.AutoRefresh}
                * Supports text files: {tool.SupportsText}
+               * Create no window: {tool.CreateNoWindow}
                * Environment variable for custom install location: `DiffEngine_{tool.Tool}`
              """);
 
         if (tool.BinaryExtensions.Length != 0)
         {
-            writer.WriteLine($"  * Supported binaries: {string.Join(", ", tool.BinaryExtensions.OrderBy(_=>_))}");
+            writer.WriteLine($"  * Supported binaries: {string.Join(", ", tool.BinaryExtensions.OrderBy(_ => _))}");
         }
 
         if (tool.Notes != null)

src/DiffEngine.Tests/DiffRunnerTests.cs

@@ -187,6 +187,7 @@ static DiffRunnerTests() =>
             autoRefresh: true,
             isMdi: false,
             supportsText: true,
+            createNoWindow: false,
             requiresTarget: true,
             launchArguments: new(
                 Left: (tempFile, targetFile) => $"\"{tempFile}\" \"{targetFile}\"",

src/DiffEngine.Tests/DiffToolsTest.cs

@@ -20,6 +20,7 @@ public void AddTool()
             isMdi: false,
             supportsText: true,
             requiresTarget: true,
+            createNoWindow: false,
             launchArguments: new(
                 Left: (tempFile, targetFile) => $"\"{targetFile}\" \"{tempFile}\"",
                 Right: (tempFile, targetFile) => $"\"{tempFile}\" \"{targetFile}\""),
@@ -44,6 +45,7 @@ public void OrderShouldNotMessWithAddTool()
             isMdi: false,
             supportsText: true,
             requiresTarget: true,
+            createNoWindow: false,
             launchArguments: new(
                 Left: (tempFile, targetFile) => $"\"{targetFile}\" \"{tempFile}\"",
                 Right: (tempFile, targetFile) => $"\"{tempFile}\" \"{targetFile}\""),
@@ -65,6 +67,7 @@ public void TextConvention()
             isMdi: false,
             supportsText: true,
             requiresTarget: true,
+            createNoWindow: false,
             launchArguments: new(
                 Left: (tempFile, targetFile) => $"\"{targetFile}\" \"{tempFile}\"",
                 Right: (tempFile, targetFile) => $"\"{tempFile}\" \"{targetFile}\""),