TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildSteps/ReSharperInspections

ReSharperInspections

open class ReSharperInspections : BuildStep

fun BuildSteps.reSharperInspections(init: ReSharperInspections.() -> Unit): 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
        }
Content copied to clipboard
    }
}

Constructors

ReSharperInspections

fun ReSharperInspections(init: ReSharperInspections.() -> Unit)

ReSharperInspections

fun ReSharperInspections()

Types

ImagePlatform

enum ImagePlatform : Enum<ReSharperInspections.ImagePlatform>

Docker image platforms

Platform

enum Platform : Enum<ReSharperInspections.Platform>

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): SingleDelegateProvider<Boolean>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<T>

conditions

fun conditions(init: BuildStepConditions.() -> Unit = {})

Configures build step conditions

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

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.

doubleParameter

fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): SingleDelegateProvider<Int>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

fun stringParameter(customName: String? = null): SingleDelegateProvider<String>

toString

open override fun toString(): String

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

cltPath

var cltPath: String?

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.

cltPlatform

var cltPlatform: ReSharperInspections.Platform?

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.

cltPlugins

var cltPlugins: String?

Newline-delimited list of ReSharper plugins required for InspectCode in the following format:

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

customCmdArgs

var customCmdArgs: String?

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

customSettingsProfilePath

var customSettingsProfilePath: String?

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.

debugOutput

var debugOutput: Boolean?

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.

dockerImage

var dockerImage: String?

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.

dockerImagePlatform

var dockerImagePlatform: ReSharperInspections.ImagePlatform?

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

dockerPull

var dockerPull: Boolean?

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

dockerRunParameters

var dockerRunParameters: String?

Additional docker run command arguments

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

var id: String? = null

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.

name

var name: String

Build step name

params