InspectCodeSettings Class

Summary

Contains settings used by InspectCodeRunner.
Namespace
Cake.Common.Tools.InspectCode
Base Types
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
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
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.

  • Setting this property to true will result in passing the '--build' option.
  • Setting this property to false will result in passing the '--no-build' option.
  • Setting this property to null will result in no changes to the options. This is the default and the only valid setting for versions before 2021.2.

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.
HandleExitCode Func<int, bool>
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<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.
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<IProcess>
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<ProcessSettings>
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.
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
UseX86Tool bool
Gets or sets a value indicating whether to use x86 tool.
Verbosity InspectCodeVerbosity?
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<InspectCodeSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<InspectCodeSettings>(InspectCodeSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<InspectCodeSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<InspectCodeSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<InspectCodeSettings>(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<InspectCodeSettings>(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
WithArgumentCustomization<InspectCodeSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
WithEnvironmentVariable<InspectCodeSettings>(string, string) T
Sets or adds tool environment variable.
WithExpectedExitCode<InspectCodeSettings>(int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
WithHandleExitCode<InspectCodeSettings>(Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
WithNoWorkingDirectory<InspectCodeSettings>(bool) T
Sets whether the tool should use a working directory or not.
WithPostAction<InspectCodeSettings>(Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
WithSetupProcessSettings<InspectCodeSettings>(Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
WithToolPath<InspectCodeSettings>(FilePath) T
Sets the tool path.
WithToolSettings<InspectCodeSettings>(Action<InspectCodeSettings>) T
Provides fluent null guarded tool settings action.
WithToolTimeout<InspectCodeSettings>(TimeSpan) T
Sets the tool timeout.
WithWorkingDirectory<InspectCodeSettings>(DirectoryPath) T
Sets the tool working directory.