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.SPCAF.

Summary

SPCAF tool settings.

Assembly

Cake.SPCAF.dll

Namespace

Cake.SPCAF

Base Types

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

Syntax

public sealed class SPCAFSettings : ToolSettings

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

Name	Value	Summary
About	bool	Gets or sets a value indicating whether the information about the software is shown.
Filters	string	Gets or sets a list of regular expressions, separated by a semicolon which is applied as filters for the input files.Helpful if argument input files is a directory.Only the input files which match the filter are analyzed.
Help	bool	Gets or sets a value indicating whether the help is shown.
InputFiles	List<Path>	Gets the required location of files to be included in the analysis.
LogFile	FilePath	Gets or sets the path where the log file should be written to.
Output	FilePath	Gets or sets the output file with processed data when a report generator is specified.
Recursive	bool	Gets or sets a value indicating whether to scan the input folder recursively for analyzable files. This is to be used if you have files in subfolders.
Report	List<Report>	Gets the report generator that will be used to generate the output file. Visual Studio compatible console output will be generated regardless of this argument.
Settings	FilePath	Gets or sets the name of SPCAF ruleset file.
SkipProjectCreation	bool	Gets or sets a value indicating whether to skip the creation of a .spcaf project file.
TempDir	DirectoryPath	Gets or sets directory into which all temporary files are extract.
Verbosity	Verbosity	Gets or sets the amount of information to display in the output window.

Name	Value	Summary
Evaluate(ProcessArgumentBuilder, ICakeEnvironment)	void	Evaluate the given properties.

Name	Value	Summary
Dump<SPCAFSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<SPCAFSettings>(SPCAFSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<SPCAFSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<SPCAFSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<SPCAFSettings>(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<SPCAFSettings>(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