ReSharperInspections

An Inspections (ReSharper) build step for gathering JetBrains ReSharper inspection results.

Example. Runs R# InspectCode command line tool for the MyProject.sln solution. Uses the default R# InspectCode tool installed on the TeamCity server.

buildType {
// Other Build Type settings ...
steps {
// Other Build Steps ...
        reSharperInspections {
solutionPath = "MyProject.sln"
targetDotNetFramework_4_8 = true
cltPath = "%teamcity.tool.jetbrains.resharper-clt.DEFAULT%"
cltPlatform = ReSharperInspections.Platform.X64
}
}
}

See also

Constructors

Link copied to clipboard
constructor(init: ReSharperInspections.() -> Unit)
constructor()

Types

Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard
var cltPath: <Error class: unknown class>

A custom path to R# CLT Home Directory. Paths relative to the checkout directory are supported. The value can reference to JetBrains ReSharper Command Line Tool specified via Administration | Tools.

Link copied to clipboard
var cltPlatform: <Error class: unknown class>

Select the platform bitness of the InspectCode tool. To find code issues in C++ projects, use the x86 platform. The cross-platform inspections are also supported in ReSharper 2020.2.1 or later.

Link copied to clipboard
var cltPlugins: <Error class: unknown class>

Newline-delimited list of ReSharper plugins required for InspectCode in the following format: %pluginId%/%version%. If you want InspectCode to obtain plugin .nupkg files from a local storage directory rather than JetBrains Marketplace, set the source option in the Additional InspectCode parameters field: --source=%pluginsDirectoryPath%.

Link copied to clipboard

Optional collection of build step execution conditions

Link copied to clipboard
var customCmdArgs: <Error class: unknown class>

Specify newline-separated command line parameters to add to calling inspectCode.exe.

Link copied to clipboard
var customSettingsProfilePath: <Error class: unknown class>

The path to the file containing ReSharper settings created with JetBrains ReSharper 6.1 or later. The specified path should be relative to the checkout directory. If specified, this settings layer has the top priority, so it overrides ReSharper build-in settings. By default, build-in ReSharper settings layers are applied.

Link copied to clipboard
var debugOutput: <Error class: unknown class>

Check this option to include debug messages in the build log and publish the file with additional logs (dotnet-tools-inspectcode.log) as a hidden artifact.

Link copied to clipboard
var dockerImage: <Error class: unknown class>

Specifies which Docker image to use for running this build step. I.e. the build step will be run inside specified docker image, using 'docker run' wrapper.

Link copied to clipboard
var dockerImagePlatform: <Error class: unknown class>

Specifies which Docker image platform will be used to run this build step.

Link copied to clipboard
var dockerPull: <Error class: unknown class>

If enabled, "pull image" command will be run before docker run.

Link copied to clipboard
var dockerRunParameters: <Error class: unknown class>

Additional docker run command arguments

Link copied to clipboard

Specifies whether the step is enabled, true by default

Link copied to clipboard
Link copied to clipboard
var id: String?

Optional id of the step. Usually the id is not required, however if a build configuration inherits from a template and wants to override a build step defined there, then both steps should have the same id.

Link copied to clipboard

Build step name

Link copied to clipboard
Link copied to clipboard
var projectFilter: <Error class: unknown class>

Project name wildcards to analyze only a part of the solution. Leave blank to analyze the whole solution. Separate wildcards with new lines.

Link copied to clipboard
var solutionPath: <Error class: unknown class>

The path to the .sln file created by Microsoft Visual Studio 2005 or later. The specified path should be relative to the checkout directory.

Link copied to clipboard
var targetDotNetFramework_2_0: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_3_0: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_3_5: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_0: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_5: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_5_1: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_5_2: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_6: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_6_1: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_6_2: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_7: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_7_1: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_7_2: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_8: <Error class: unknown class>
Link copied to clipboard
var targetDotNetFramework_4_8_1: <Error class: unknown class>
Link copied to clipboard

Build step type

Functions

Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard

Deletes all configured build step conditions

Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
open fun create(): BuildStep

Creates an instance of this build step via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

Link copied to clipboard
fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open fun stringParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer