Meziantou.FrameworkSnapshotSettings Class
public sealed class SnapshotSettings : IEquatable<SnapshotSettings>No documentation is available.
- Implements
Constructors
| Name | Description |
|---|---|
| SnapshotSettings() |
SnapshotSettings()
SnapshotSettings.cspublic SnapshotSettings()No documentation is available.
Properties
| Name | Description |
|---|---|
| AutoDetectContinuousEnvironment | Gets or sets a value indicating whether to automatically detect continuous integration, continuous testing, and LLM environments and disable snapshot updates. |
| Comparers | |
| Default | |
| ForceUpdateSnapshots | |
| MaxSnapshotFileNameLength | |
| MergeTools | Gets or sets the ordered list of tools used by SnapshotUpdateStrategy.MergeTool and SnapshotUpdateStrategy.MergeToolSync. The first tool that can be started is used. The default list tries the DiffEngine_Tool environment variable, the git merge and diff tools, the current IDE (Visual Studio, Visual Studio Code, Rider), and then the GUI tools detected by DiffEngine. Terminal tools such as Vim are only used when named explicitly. If null or empty, no merge tool is launched and the assertion failure is reported. |
| Scrubbers | |
| Serializers | |
| SnapshotNamingStrategy | |
| SnapshotPathStrategy | |
| SnapshotUpdateStrategy |
AutoDetectContinuousEnvironment
SnapshotSettings.csGets or sets a value indicating whether to automatically detect continuous integration, continuous testing, and LLM environments and disable snapshot updates.
public bool AutoDetectContinuousEnvironment { get; set; }Property value
Remarks
The default value is true, unless the SNAPSHOTTESTING_AUTODETECT_CONTINUOUS_ENVIRONMENT environment variable is set to false, 0, no or off.
Comparers
SnapshotSettings.csDefault
SnapshotSettings.csForceUpdateSnapshots
SnapshotSettings.csMaxSnapshotFileNameLength
SnapshotSettings.csMergeTools
SnapshotSettings.csGets or sets the ordered list of tools used by SnapshotUpdateStrategy.MergeTool and SnapshotUpdateStrategy.MergeToolSync. The first tool that can be started is used. The default list tries the DiffEngine_Tool environment variable, the git merge and diff tools, the current IDE (Visual Studio, Visual Studio Code, Rider), and then the GUI tools detected by DiffEngine. Terminal tools such as Vim are only used when named explicitly. If null or empty, no merge tool is launched and the assertion failure is reported.
public IEnumerable<MergeTool>? MergeTools { get; set; }Property value
Remarks
The DiffEngine_Disabled environment variable disables all merge tools, even the ones set explicitly. Merge tools are also never launched on a continuous integration server, in a continuous testing runner, or in an LLM agent.
Scrubbers
SnapshotSettings.csProperty value
No documentation is available.
Serializers
SnapshotSettings.cspublic SnapshotSerializerCollection Serializers { get; }Property value
No documentation is available.
SnapshotNamingStrategy
SnapshotSettings.cspublic SnapshotNamingStrategy SnapshotNamingStrategy { get; set; }Property value
No documentation is available.
SnapshotPathStrategy
SnapshotSettings.cspublic SnapshotPathStrategy SnapshotPathStrategy { get; set; }Property value
No documentation is available.
SnapshotUpdateStrategy
SnapshotSettings.cspublic SnapshotUpdateStrategy SnapshotUpdateStrategy { get; set; }Property value
No documentation is available.
Methods
| Name | Description |
|---|---|
| Equals(SnapshotSettings?) | |
| Equals(object?) | |
| GetHashCode() | |
| ToString() |
Equals overloads
Equals(SnapshotSettings?)
public bool Equals(SnapshotSettings? other)No documentation is available.
Equals(object?)
GetHashCode()
ToString()
Operators
| Name | Description |
|---|---|
| operator ==(SnapshotSettings?, SnapshotSettings?) | |
| operator !=(SnapshotSettings?, SnapshotSettings?) |
operator ==(SnapshotSettings?, SnapshotSettings?)
public static bool operator ==(SnapshotSettings? left, SnapshotSettings? right)No documentation is available.
operator !=(SnapshotSettings?, SnapshotSettings?)
public static bool operator !=(SnapshotSettings? left, SnapshotSettings? right)No documentation is available.