This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.VsMetrics.

Summary

Contains settings used by VsMetricsRunner.

Assembly

Cake.VsMetrics.dll

Namespace

Cake.VsMetrics

Base Types

ToolSettings

graph BT Type-->Base0["ToolSettings"] Type["VsMetricsSettings"] class Type type-node

Syntax

public sealed class VsMetricsSettings : ToolSettings

Constructors

Name	Summary
VsMetricsSettings()	Initializes a new instance of the `VsMetricsSettings` class.

Properties

Name	Value	Summary
AssemblyDirectories	IEnumerable<DirectoryPath>	Gets or sets the Assembly directory paths.
AssemblyPlatforms	IEnumerable<DirectoryPath>	Gets or sets the Assembly platform paths.
AssemblyReferences	IEnumerable<FilePath>	Gets or sets the Assembly references file paths.
IgnoreGeneratedCode	bool	Gets or sets a value indicating whether generated code should be analysed.
IgnoreInvalidTargets	bool	Gets or sets a value indicating whether invalid targets should be analysed.
Quiet	bool	Gets or sets a value indicating whether metric.exe's output should be shown.
SearchGac	bool	Gets or sets a value indicating whether the GAC should be searched for assemblies.
SuccessFile	bool	Gets or sets a value indicating whether a success file should be created.
ToolVersion	VsMetricsToolVersion	Gets or sets the tool version.

Extension Methods

Name	Value	Summary
Dump<VsMetricsSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<VsMetricsSettings>(VsMetricsSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<VsMetricsSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<VsMetricsSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<VsMetricsSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<VsMetricsSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

VsMetricsSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods