Skip to content

Out Diff

viscalyxbot edited this page Aug 4, 2024 · 2 revisions

Out-Diff

SYNOPSIS

This output two text blocks side-by-side in hex to easily compare the diff.

SYNTAX

Out-Diff [-ActualString] <String[]> [-ExpectedString] <String[]> 
 [<CommonParameters>]

DESCRIPTION

This output two text blocks side-by-side in hex to easily compare the diff. It is main intended use is as a helper for unit test when comparing large text mass which can have small normally invisible difference like an extra pch missing LF.

EXAMPLES

EXAMPLE 1

Out-Diff `
    -ExpectedString 'This is a longer text string that was expected to be shown' `
    -ActualString 'This is the actual text string'

PARAMETERS

-ActualString

A text string that should be compared against the text string that is passed in parameter 'Expected'.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExpectedString

A text string that should be compared against the text string that is passed in parameter 'Actual'.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

This outputs the lines in verbose statements because it is the easiest way to show output when running tests in Pester. The output is wide, 185 characters, to get the best side-by-side comparison.

RELATED LINKS

Clone this wiki locally