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 running specific version of Qodana CLI

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        qodana {
            cli = "v2024.1.8"
        }
Content copied to clipboard
    }
}

Constructors

Qodana

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

constructor()

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>

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

cli

var cli: String?

Qodana CLI version to use (empty by default and CLI is not used then)

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.cn/en-us/legal/docs/privacy/privacy/

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

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.

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

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"): DelegateProvider<Boolean?>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<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