InspectCodeSettings Class

Summary

Contains settings used by InspectCodeRunner.
Namespace
Cake.Common.Tools.InspectCode
Base Types
graph TD Base0["ToolSettings"]-->Type click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base1["object"]-->Base0 Type["InspectCodeSettings"] class Type type-node

Syntax

public sealed class InspectCodeSettings : ToolSettings

Properties

Name Value Summary
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
Gets or sets the argument customization. Argument customization is a way that lets you add, replace or reuse arguments passed to a tool. This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
CachesHome DirectoryPath
Gets or sets the directory where caches will be stored. The default is %TEMP%.
Debug bool
Gets or sets a value indicating whether the debug output should be enabled.
DisabledSettingsLayers SettingsLayer[]
Gets or sets a list of InspectCodeSettings which will be disabled.
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
Extensions string[]
Gets or sets a list of Resharper extensions which will be used.
MsBuildProperties Dictionary<string, string>
Gets or sets MSBuild properties.
NoBuildinSettings bool
Gets or sets a value indicating whether all global, solution and project settings should be ignored. Alias for disabling the settings layers GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal, ProjectShared and ProjectPersonal.
NoSolutionWideAnalysis bool
Gets or sets a value indicating whether disable solution-wide analysis should be forced. Default value is false
OutputFile FilePath
Gets or sets the location InspectCode should write its output.
Profile FilePath
Gets or sets the path to the file to use custom settings from.
ProjectFilter string
Gets or sets a filter to analyze only particular project(s) instead of the whole solution. Supports wildcards.
SolutionWideAnalysis bool
Gets or sets a value indicating whether enable solution-wide analysis should be forced. Default value is false.
ThrowExceptionOnFindingViolations bool
Gets or sets a value indicating whether to throw an exception on finding violations
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<InspectCodeSettings>() string
Get a basic string representation of specified object.
NotNull<InspectCodeSettings>(string) void
Throws an exception if the specified parameter's value is null.
NotNull<InspectCodeSettings>(string) void
Throws an exception if the specified parameter's value is null.
ThrowIfNull<InspectCodeSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
ThrowIfNull<InspectCodeSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value