Functions/GenXdev.AI/Invoke-WinMerge.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.AI Original cmdlet filename : Invoke-WinMerge.ps1 Original author : René Vaessen / GenXdev Version : 1.268.2025 ################################################################################ MIT License Copyright 2021-2025 GenXdev Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ################################################################################> ############################################################################### <# .SYNOPSIS Launches WinMerge to compare two files side by side. .DESCRIPTION Launches the WinMerge application to compare source and target files in a side by side diff view. The function validates the existence of both input files and ensures WinMerge is properly installed before launching. Provides optional wait functionality to pause execution until WinMerge closes. .PARAMETER SourcecodeFilePath Full or relative path to the source file for comparison. The file must exist and be accessible. .PARAMETER TargetcodeFilePath Full or relative path to the target file for comparison. The file must exist and be accessible. .PARAMETER Wait Switch parameter that when specified will cause the function to wait for the WinMerge application to close before continuing execution. .EXAMPLE Invoke-WinMerge -SourcecodeFilePath "C:\source\file1.txt" ` -TargetcodeFilePath "C:\target\file2.txt" ` -Wait .EXAMPLE merge "C:\source\file1.txt" "C:\target\file2.txt" #> function Invoke-WinMerge { [CmdletBinding()] param( ######################################################################## [Parameter( Mandatory = $true, Position = 0, HelpMessage = 'Path to the source file to compare' )] [ValidateNotNullOrEmpty()] [ValidateScript({ Microsoft.PowerShell.Management\Test-Path -LiteralPath $_ -PathType Leaf })] [string]$SourcecodeFilePath, ######################################################################## [Parameter( Mandatory = $true, Position = 1, HelpMessage = 'Path to the target file to compare against' )] [ValidateNotNullOrEmpty()] [ValidateScript({ Microsoft.PowerShell.Management\Test-Path -LiteralPath $_ -PathType Leaf })] [string]$TargetcodeFilePath, ######################################################################## [Parameter( Mandatory = $false, Position = 2, HelpMessage = 'Wait for WinMerge to close before continuing' )] [switch]$Wait ######################################################################## ) begin { # verify that winmerge is installed and accessible Microsoft.PowerShell.Utility\Write-Verbose 'Verifying WinMerge installation status...' GenXdev.AI\EnsureWinMergeInstalled # convert any relative paths to full paths for reliability $sourcePath = GenXdev.FileSystem\Expand-Path $SourcecodeFilePath $targetPath = GenXdev.FileSystem\Expand-Path $TargetcodeFilePath # log the resolved file paths for troubleshooting Microsoft.PowerShell.Utility\Write-Verbose "Resolved source file path: $sourcePath" Microsoft.PowerShell.Utility\Write-Verbose "Resolved target file path: $targetPath" } process { # prepare the process start parameters including executable and files $processArgs = @{ FilePath = 'WinMergeU.exe' ArgumentList = $sourcePath, $targetPath } # add wait parameter if specified to block until winmerge closes if ($Wait) { $processArgs['Wait'] = $true Microsoft.PowerShell.Utility\Write-Verbose 'Will wait for WinMerge process to exit' } # launch winmerge with the configured parameters Microsoft.PowerShell.Utility\Write-Verbose 'Launching WinMerge application...' Microsoft.PowerShell.Management\Start-Process @processArgs } end { } } |