Summary
Contains settings used by
InspectCodeRunner
.
- Namespace
- Cake
.Common .Tools .InspectCode - Base Types
-
- object
- ToolSettings
graph BT
Type-->Base0["ToolSettings"]
click Base0 "/api/Cake.Core.Tooling/ToolSettings"
Base0-->Base1["object"]
Type["InspectCodeSettings"]
class Type type-node
Syntax
public sealed class InspectCodeSettings : ToolSettings
Properties
Name | Value | Summary |
---|---|---|
Argument |
Func |
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
|
Build | bool? |
Gets or sets a value indicating whether to build or not-build the
sources before running the tool. Setting this value is only valid
for InspectCode version 2021.2.0 and later.
|
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.
|
Disabled |
SettingsLayer[] |
Gets or sets a list of
InspectCodeSettings which will be disabled.
|
EnvironmentVariables | IDictionary |
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.
|
HandleExitCode | Func |
Gets or sets whether the exit code from the tool process causes an exception to be thrown.
If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code. If the delegate returns true then no exception is thrown. This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional on the exit code value. Inherited from ToolSettings
|
MsBuildProperties | Dictionary |
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.
|
No |
bool |
Gets or sets a value indicating whether disable solution-wide analysis should be forced.
Default value is
false .
|
NoWorkingDirectory | bool |
Gets or sets a value indicating whether or not to opt out of using
an explicit working directory for the process.
Inherited from ToolSettings
|
OutputFile | FilePath |
Gets or sets the location InspectCode should write its output.
|
PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
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.
|
SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
Severity | InspectCodeSeverity? |
Gets or sets the minimal severity of issues to report.
|
SkipOutputAnalysis | bool |
Gets or sets a value indicating whether to skip analysis of the file
that was output by the command line tool or not.
|
SolutionWideAnalysis | bool |
Gets or sets a value indicating whether enable solution-wide analysis should be forced.
Default value is
false .
|
Throw |
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
|
UseX86Tool | bool |
Gets or sets a value indicating whether to use x86 tool.
|
Verbosity | Inspect |
Gets or sets the verbosity level of the log messages.
|
WorkingDirectory | DirectoryPath |
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
From StringExtensions
Requires the Cake.Issues addin
|
With |
T |
Sets the tool argument customization delegate.
|
With |
T |
Sets or adds tool environment variable.
|
WithExpectedExitCode |
T |
Sets expected exit code using
WithHandleExitCode<T>(T, Func<int, bool>) .
|
WithHandleExitCode |
T |
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
|
With |
T |
Sets whether the tool should use a working directory or not.
|
WithPostAction |
T |
Sets a delegate which is executed after the tool process was started.
|
With |
T |
Sets a delegate to configure the process settings.
|
WithToolPath |
T |
Sets the tool path.
|
WithToolSettings |
T |
Provides fluent null guarded tool settings action.
|
WithToolTimeout |
T |
Sets the tool timeout.
|
WithWorkingDirectory |
T |
Sets the tool working directory.
|