Skip to content

Add support for optional UseShellExecute #619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SimonCropp merged 6 commits into from
Apr 1, 2025
Merged

Add support for optional UseShellExecute #619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
94bdb72
.
SimonCropp Apr 1, 2025
2c99a42
.
SimonCropp Apr 1, 2025
d093237
Merge branch 'main' into CreateNoWindow
SimonCropp Apr 1, 2025
06ec5ec
.
SimonCropp Apr 1, 2025
876fc05
.
SimonCropp Apr 1, 2025
8b11fcc
.
SimonCropp Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/diff-tool.custom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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 -->


Expand Down Expand Up @@ -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 -->


Expand Down
22 changes: 22 additions & 0 deletions docs/diff-tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/diff-tool.order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
3 changes: 2 additions & 1 deletion src/DiffEngine.Tests/DefinitionsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
1 change: 1 addition & 0 deletions src/DiffEngine.Tests/DiffRunnerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ static DiffRunnerTests() =>
autoRefresh: true,
isMdi: false,
supportsText: true,
createNoWindow: false,
requiresTarget: true,
launchArguments: new(
Left: (tempFile, targetFile) => $"\"{tempFile}\" \"{targetFile}\"",
Expand Down
3 changes: 3 additions & 0 deletions src/DiffEngine.Tests/DiffToolsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}\""),
Expand All @@ -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}\""),
Expand All @@ -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}\""),
Expand Down
Loading