FluentSPCAFSettings Class

Summary

Wrapper for SPCAFSetting to generate fluent api.
Assembly
Cake.SPCAF.dll
Namespace
Cake.SPCAF
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["FluentSPCAFSettings"] class Type type-node

Syntax

public class FluentSPCAFSettings

Methods

Name Value Summary
About() FluentSPCAFSettings
Displays information about the software.
Help() FluentSPCAFSettings
Displays the help screen.
Recursive() FluentSPCAFSettings
Set to true to scan the input folder recursively for analyzable files.
SkipProjectCreation() FluentSPCAFSettings
Set to true to skip the creation of a .spcaf project file.
WithCsvReport() FluentSPCAFSettings
Csv generator that will be used to generate the output file.
WithDebugVerbosity() FluentSPCAFSettings
Set the amount of information to "debug".
WithFilters(string) FluentSPCAFSettings
List of regular expressions, separated by a semicolon which is applied as filters for the input files.
WithHtmlReport() FluentSPCAFSettings
Html generator that will be used to generate the output file.
WithInput(Path[]) FluentSPCAFSettings
Required. Location of files to be included in the analysis.
WithLogFile(FilePath) FluentSPCAFSettings
The path where the log file should be written to.
WithMinimalVerbosity() FluentSPCAFSettings
Set the amount of information to "minimal".
WithNoneReport() FluentSPCAFSettings
None generator. Visual Studio compatible console output will be generated regardless of this argument.
WithNormalVerbosity() FluentSPCAFSettings
Set the amount of information to "normal".
WithOutput(FilePath) FluentSPCAFSettings
Output file with processed data when a report generator is specified.
WithQuietVerbosity() FluentSPCAFSettings
Set the amount of information to "quiet".
WithSettings(Action<SPCAFSettings>) FluentSPCAFSettings
The settings are supplied to set additionally parameter of ToolSettings.
WithSettings(FilePath) FluentSPCAFSettings
Name of SPCAF ruleset file.
WithTempDir(DirectoryPath) FluentSPCAFSettings
Directory into which all temporary files are extract.
WithToolPath(FilePath) FluentSPCAFSettings
Sets the tool path.
WithXmlReport() FluentSPCAFSettings
XML generator that will be used to generate the output file.

Extension Methods

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