Meziantou.Framework

InlineSnapshotSettingsScrubberExtensions Class

Namespace
Meziantou.Framework.InlineSnapshotTesting
Assembly
Meziantou.Framework.InlineSnapshotTesting.dll
Package
Meziantou.Framework.InlineSnapshotTesting 6.0.22
Source
InlineSnapshotSettingsScrubberExtensions.cs
Available in package assets
net10.0net11.0

Provides extension methods for adding scrubbers to InlineSnapshotSettings.

public static class InlineSnapshotSettingsScrubberExtensions

Methods

NameDescription
ScrubLines(InlineSnapshotSettings, Func<string, bool>)Adds a scrubber that removes lines matching the specified predicate.
ScrubLinesContaining(InlineSnapshotSettings, StringComparison, string[])Adds a scrubber that removes lines containing any of the specified text values with the specified comparison.
ScrubLinesContaining(InlineSnapshotSettings, string[])Adds a scrubber that removes lines containing any of the specified text values (case-insensitive).
ScrubLinesMatching(InlineSnapshotSettings, string)Adds a scrubber that removes lines matching the specified regular expression pattern.
ScrubLinesMatching(InlineSnapshotSettings, string, RegexOptions)Adds a scrubber that removes lines matching the specified regular expression pattern with options.
ScrubLinesMatching(InlineSnapshotSettings, string, RegexOptions, TimeSpan)Adds a scrubber that removes lines matching the specified regular expression pattern with options and timeout.
ScrubLinesMatching(InlineSnapshotSettings, Regex)Adds a scrubber that removes lines matching the specified regular expression.
ScrubLinesWithReplace(InlineSnapshotSettings, Func<string, string?>)Adds a scrubber that replaces each line using the specified function.
ScrubMachineName(InlineSnapshotSettings)Adds a scrubber that replaces the machine name with a consistent value.
ScrubUserName(InlineSnapshotSettings)Adds a scrubber that replaces the user name with a consistent value.

ScrubLines(InlineSnapshotSettings, Func<string, bool>)

InlineSnapshotSettingsScrubberExtensions.cs

Adds a scrubber that removes lines matching the specified predicate.

public static void ScrubLines(this InlineSnapshotSettings settings, Func<string, bool> predicate)

Parameters

settings InlineSnapshotSettings
predicate Func<string, bool>

ScrubLinesContaining overloads

ScrubLinesContaining(InlineSnapshotSettings, StringComparison, string[])

InlineSnapshotSettingsScrubberExtensions.cs

Adds a scrubber that removes lines containing any of the specified text values with the specified comparison.

public static void ScrubLinesContaining(this InlineSnapshotSettings settings, StringComparison stringComparison, params string[] searchText)
Parameters
settings InlineSnapshotSettings
stringComparison StringComparison
searchText string[]

ScrubLinesContaining(InlineSnapshotSettings, string[])

InlineSnapshotSettingsScrubberExtensions.cs

Adds a scrubber that removes lines containing any of the specified text values (case-insensitive).

public static void ScrubLinesContaining(this InlineSnapshotSettings settings, params string[] searchText)
Parameters
settings InlineSnapshotSettings
searchText string[]

ScrubLinesMatching overloads

ScrubLinesMatching(InlineSnapshotSettings, string)

InlineSnapshotSettingsScrubberExtensions.cs

Adds a scrubber that removes lines matching the specified regular expression pattern.

public static void ScrubLinesMatching(this InlineSnapshotSettings settings, string pattern)
Parameters
settings InlineSnapshotSettings
pattern string

ScrubLinesMatching(InlineSnapshotSettings, string, RegexOptions)

InlineSnapshotSettingsScrubberExtensions.cs

Adds a scrubber that removes lines matching the specified regular expression pattern with options.

public static void ScrubLinesMatching(this InlineSnapshotSettings settings, string pattern, RegexOptions options)
Parameters
settings InlineSnapshotSettings
pattern string
options RegexOptions

ScrubLinesMatching(InlineSnapshotSettings, string, RegexOptions, TimeSpan)

InlineSnapshotSettingsScrubberExtensions.cs

Adds a scrubber that removes lines matching the specified regular expression pattern with options and timeout.

public static void ScrubLinesMatching(this InlineSnapshotSettings settings, string pattern, RegexOptions options, TimeSpan matchTimeout)
Parameters
settings InlineSnapshotSettings
pattern string
options RegexOptions
matchTimeout TimeSpan

ScrubLinesMatching(InlineSnapshotSettings, Regex)

InlineSnapshotSettingsScrubberExtensions.cs

Adds a scrubber that removes lines matching the specified regular expression.

public static void ScrubLinesMatching(this InlineSnapshotSettings settings, Regex regex)
Parameters
settings InlineSnapshotSettings
regex Regex

ScrubLinesWithReplace(InlineSnapshotSettings, Func<string, string?>)

InlineSnapshotSettingsScrubberExtensions.cs

Adds a scrubber that replaces each line using the specified function.

public static void ScrubLinesWithReplace(this InlineSnapshotSettings settings, Func<string, string?> replaceLine)

Parameters

settings InlineSnapshotSettings
replaceLine Func<string, string?>

ScrubMachineName(InlineSnapshotSettings)

InlineSnapshotSettingsScrubberExtensions.cs

Adds a scrubber that replaces the machine name with a consistent value.

public static void ScrubMachineName(this InlineSnapshotSettings settings)

Parameters

settings InlineSnapshotSettings

Remarks

Only whole words are replaced, ignoring case. Does nothing when Environment.MachineName is empty.

ScrubUserName(InlineSnapshotSettings)

InlineSnapshotSettingsScrubberExtensions.cs

Adds a scrubber that replaces the user name with a consistent value.

public static void ScrubUserName(this InlineSnapshotSettings settings)

Parameters

settings InlineSnapshotSettings

Remarks

Only whole words are replaced, ignoring case. Does nothing when Environment.UserName is empty.