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

Qodana

fun BuildSteps.qodana(init: Qodana.() -> Unit): Qodana

Example. Adds a simple Qodana step for analyzing JVM-based projects

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        qodana {
            linter = jvm {}
        }
Content copied to clipboard
    }
}

Example. Adds a simple Qodana step for analyzing Python projects

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        qodana {
            linter = python {}
        }
Content copied to clipboard
    }
}

Example. Adds a Qodana step for analyzing JVM-based projects and uses qodana.sarif.json file as a baseline

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        qodana {
            linter = jvm {}
            additionalQodanaArguments = "--baseline qodana.sarif.json"
        }
Content copied to clipboard
    }
}

Example. Adds a Qodana step for analyzing JVM-based projects using provided qodana.starter inspection profile

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        qodana {
            linter = jvm {}
            inspectionProfile = embedded {
                name = "qodana.starter"
            }
        }
Content copied to clipboard
    }
}

Example. Adds a Qodana step for analyzing JVM-based projects using specific version of IntelliJ Community

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        qodana {
            linter = jvmCommunity {
                version = Qodana.JVMCommunityVersion.v2022_1
            }
        }
Content copied to clipboard
    }
}

Constructors

Qodana

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

Qodana

fun Qodana()

Types

AndroidVersion

enum AndroidVersion : Enum<Qodana.AndroidVersion>

DotNetVersion

enum DotNetVersion : Enum<Qodana.DotNetVersion>

GoVersion

enum GoVersion : Enum<Qodana.GoVersion>

InspectionProfile

sealed class InspectionProfile : CompoundParam<Qodana.InspectionProfile>

JSVersion

enum JSVersion : Enum<Qodana.JSVersion>

JVMCommunityVersion

enum JVMCommunityVersion : Enum<Qodana.JVMCommunityVersion>

JVMVersion

enum JVMVersion : Enum<Qodana.JVMVersion>

Linter

sealed class Linter : CompoundParam<Qodana.Linter>

PHPVersion

enum PHPVersion : Enum<Qodana.PHPVersion>

PythonVersion

enum PythonVersion : Enum<Qodana.PythonVersion>

Functions

android

fun android(init: Qodana.Linter.Android.() -> Unit = {}): Qodana.Linter.Android

Official Docker image for analyzing Android projects

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.

customLinter

fun customLinter(init: Qodana.Linter.CustomLinter.() -> Unit = {}): Qodana.Linter.CustomLinter

Custom Docker image

customProfile

fun customProfile(init: Qodana.InspectionProfile.CustomProfile.() -> Unit = {}): Qodana.InspectionProfile.CustomProfile

Path to the custom profile

default

fun default(): Qodana.InspectionProfile.Default

Default inspection profile

dotNet

fun dotNet(init: Qodana.Linter.DotNet.() -> Unit = {}): Qodana.Linter.DotNet

Official Docker image for analyzing .NET projects

doubleParameter

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

embedded

fun embedded(init: Qodana.InspectionProfile.Embedded.() -> Unit = {}): Qodana.InspectionProfile.Embedded

Select embedded profile name

enumParameter

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

findRawParam

fun findRawParam(paramName: String): Parameter?

fun go(init: Qodana.Linter.Go.() -> Unit = {}): Qodana.Linter.Go

Official Docker image for analyzing Go projects

hasParam

fun hasParam(paramName: String): Boolean

intParameter

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

javascript

fun javascript(init: Qodana.Linter.Javascript.() -> Unit = {}): Qodana.Linter.Javascript

Official Docker image for analyzing JavaScript projects

jvm

fun jvm(init: Qodana.Linter.Jvm.() -> Unit = {}): Qodana.Linter.Jvm

Official Docker image for analyzing JVM projects

jvmCommunity

fun jvmCommunity(init: Qodana.Linter.JvmCommunity.() -> Unit = {}): Qodana.Linter.JvmCommunity

Official Docker image for analyzing JVM projects with IntelliJ Community edition

param

fun param(name: String, value: String)

Adds parameter with specified name and value

php

fun php(init: Qodana.Linter.Php.() -> Unit = {}): Qodana.Linter.Php

Official Docker image for analyzing PHP projects

python

fun python(init: Qodana.Linter.Python.() -> Unit = {}): Qodana.Linter.Python

Official Docker image for analyzing Python projects

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

additionalDockerArguments

var additionalDockerArguments: String?

Additional Docker arguments

additionalQodanaArguments

var additionalQodanaArguments: String?

Additional Qodana arguments

argumentsCommandDocker

~~var~~ ~~argumentsCommandDocker~~: String?

Arguments for running a Docker image

argumentsEntryPointDocker

~~var~~ ~~argumentsEntryPointDocker~~: String?

Entry points for running a Docker image

cloudToken

var cloudToken: String?

Cloud Token

collectAnonymousStatistics

var collectAnonymousStatistics: Boolean?

By setting this property, you agree to let Qodana collect statistical information during linter execution. It lets us better improve linter performance. All data is collected anonymously in accordance with the JetBrains Privacy Policy: https://www.jetbrains.com/legal/docs/privacy/privacy/

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

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.

inspectionProfile

var inspectionProfile: Qodana.InspectionProfile?

Inspection profile

linter

var linter: Qodana.Linter?

Linter that performs the analysis

name

var name: String

Build step name

params

val params: List<Parameter>

projectKey

var projectKey: String?

Provide this name if you have several Qodana steps in one build, or you combine several builds into one composite configuration. If empty, auto-generated step name will be used

reportAsTests

var reportAsTests: Boolean?

Enable report problems as tests

tools

var tools: String?

Tool names separated by ','. Example tool = "Code Inspection"

type

var type: String

Build step type

workingDir

var workingDir: String?

Working directory