Class SnapshotDiffTool

Describes an external application used to compare verified and received snapshots.

public sealed class SnapshotDiffTool

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: SnapshotAssertionExtensions.ShouldMatchSnapshot(object?, Action<SnapshotSettings>, CancellationToken, string, string)

SnapshotAssertionExtensions.ShouldMatchSnapshot(object?, string, CancellationToken, string, string)

SnapshotAssertionExtensions.ShouldMatchSnapshot(object?, SnapshotSettings?, CancellationToken, string, string)

Constructors

Creates a diff-tool configuration.

public SnapshotDiffTool(string executable, params string[] arguments)

executable string: Non-empty executable path or command name. Resolution is delegated to the operating system when the tool is launched.
arguments string[]: Non-null argument array. Entries may contain {verified} and {received} placeholders; other values are passed unchanged. The array is retained and exposed, so callers must not mutate it after construction.

Gets command arguments. Use {verified} and {received} as path placeholders.

public IReadOnlyList<string> Arguments { get; }

IReadOnlyList<string>: The retained caller-supplied argument array, exposed as a read-only list.

Gets the executable path or command name.

public string Executable { get; }

Creates a JetBrains Rider diff configuration.

public static SnapshotDiffTool Rider(string executable = "rider")

executable string: Non-empty executable path or command name. The default is rider.

SnapshotDiffTool: A new configuration that invokes Rider's diff command with verified and received paths.

Creates a Visual Studio diff configuration.

public static SnapshotDiffTool VisualStudio(string executable = "devenv.exe")

executable string: Non-empty executable path or command name. The default is devenv.exe.

SnapshotDiffTool: A new configuration that invokes Visual Studio's /diff command with verified and received paths.

Creates a Visual Studio Code diff configuration.

public static SnapshotDiffTool VisualStudioCode(string executable = "code")

executable string: Non-empty executable path or command name. The default is code.

SnapshotDiffTool: A new configuration that invokes Visual Studio Code's --diff command with verified and received paths.