Qodana
 
2023.1
You are viewing the documentation for an earlier version of Qodana.
  1. Deployment
  2. Gradle plugin

Gradle plugin

Edit page Last modified: 12 June 2023

official project

The Gradle Qodana plugin provides the Gradle interface for running code inspections provided by Qodana. To get started, apply the Gradle plugin org.jetbrains.qodana in the Gradle configuration file.

Add the following to the build.gradle configuration file.

plugins {
    id "org.jetbrains.qodana" version "<plugin-version>"
}

note

The latest Gradle Qodana plugin version is currently 0.1.13.

tip

For details on working with Gradle in IntelliJ IDEA, see the IntelliJ IDEA Gradle documentation.

'qodana { }' extension configuration

To configure the plugin, use the following options in the top level qodana { } configuration node.

Name

Description

Type

Default Value

autoUpdate

Automatically pull the latest Qodana Docker image before running the inspection.

Boolean

true

cachePath

Path to the cache directory.

String

null

dockerContainerName

Name of the Qodana Docker container.

String

idea-inspections

dockerImageName

Name of the Qodana Docker image.

String

jetbrains/qodana:latest

executable

Docker executable name.

String

docker

projectPath

Path to the project folder to inspect.

String

project.projectDir

resultsPath

Path to directory to store the execution results.

String

"${projectPath}/build/results"

saveReport

Generate HTML report.

Boolean

false

showReport

Serve an HTML report on showReportPort port.

Boolean

false

showReportPort

Default port used to serve the HTML report.

Int

8080

Gradle Qodana tasks

After the Gradle Qodana plugin is applied and configured, you can run the provided tasks:

runInspections

Starts Qodana code analysis in a Docker container. The task runs according to the qodana { } extension configuration but also provides additional properties and helper methods to configure the Docker image.

note

Running analysis locally is a resource-intensive operation. If you experience issues, consider increasing the Docker Desktop runtime memory limit, which by default is set to 2 GB. See the Docker Desktop documentation for Windows and Mac.

Properties

Name

Description

Type

Default Value

profilePath

Path to the profile file to be mounted as /data/profile.xml.

String

null

disabledPluginsPath

Path to the list of plugins to be disabled in the Qodana IDE instance to be mounted as /root/.config/idea/disabled_plugins.txt

String

null

changes

Inspect uncommitted changes and report new problems.

Boolean

false

jvmParameters

JVM parameters to start the IntelliJ IDEA JVM with.

List<String>

empty

Helper methods

Name

Description

bind(localPort: Int, dockerPort: Int)

Adds a new port binding.

mount(localPath: String, dockerPath: String)

Mounts a local directory to the given Docker path.

env(name: String, value: String)

Adds an environment variable.

dockerArg(argument: String)

Adds a Docker argument to the executed command.

arg(argument: String)

Adds a Docker image argument to the executed command.

tip

You can study the detailed description of the Qodana Docker image configuration using the Docker image configuration page.

updateInspections

Pulls the latest Qodana Inspections Docker container. The task automatically runs before runInspections if the qodana.autoUpdate property is set to true.

stopInspections

Stops the Qodana Inspections Docker container.

cleanInspections

Cleans up the Qodana Inspections output directory.

Example

Add the following to the build.gradle configuration file:

plugins {
    // applies the Gradle Qodana plugin to use it in the project
    id "org.jetbrains.qodana" version "0.1.12"
}

qodana {
    // by default, the results path is $projectPath/build/results
    resultsPath = "some/output/path"
}

runInspections {
    // by default qodana.recommended will be used
    profilePath = "./someExternallyStoredProfile.xml"
}

To run the inspections, start the runInspections Gradle task:

gradle runInspections
// or
./gradlew runInspections