Awesome

Gradle Qodana Plugin

Gradle interface to run code inspections from IntelliJ IDEA.

Important: This project requires Gradle 6.6 or newer, however it is recommended to use the latest Gradle available. Update it with:

./gradlew wrapper --gradle-version=VERSION

Issue Tracker

All the issues, feature requests, and support related to the Gradle Qodana Plugin is handled on YouTrack.

If you'd like to file a new issue, please use the following YouTrack | New Issue link.

Docker Image with Qodana tool

Docker Hub: https://hub.docker.com/r/jetbrains/qodana-jvm-community

Gradle Qodana Configuration

Note: Make sure you have docker already installed and available in your environment.

Apply Gradle plugin org.jetbrains.qodana in Gradle configuration file:

• Groovy – build.gradle

  plugins {
      id "org.jetbrains.qodana" version "..."
  }
  

• Kotlin DSL – build.gradle.kts

  plugins {
      id("org.jetbrains.qodana") version "..."
  }
  

Note: The latest version is:

qodana { } extension configuration

Properties available for configuration in the qodana { } top level configuration closure:

Gradle Qodana Tasks

runInspections

Starts Qodana Inspections in a Docker container.

Task relies on the qodana { } extension configuration, however it provides also additional properties and helper methods to configure the Docker image.

Properties

Helper methods

updateInspections

Pulls the latest Qodana Inspections Docker container.

Task will be run automatically before the runInspections if the qodana.autoUpdate property will be set to true.

stopInspections

Stops the Qodana Inspections Docker container.

cleanInspections

Cleans up the Qodana Inspections output directory.

Example

Add this to your Gradle configuration file:

• Groovy – build.gradle

  plugins {
      // applies Gradle Qodana plugin to use it in project
      id "org.jetbrains.qodana" version "..."
  }
  
  qodana {
      // by default result path is $projectPath/build/results
      resultsPath = "some/output/path"
  }
  
  runInspections {
      // by default qodana.recommended will be used
      profilePath = "./someExternallyStoredProfile.xml"  
  }
  

• Kotlin – build.gradle.kts

  plugins {
      // applies Gradle Qodana plugin to use it in project
      id("org.jetbrains.qodana") version "..."
  }
  
  qodana {
      // by default result path is $projectPath/build/results
      resultsPath.set("some/output/path")
  }
  
  tasks {
      runInspections {
          // by default qodana.recommended will be used
          profilePath.set("./someExternallyStoredProfile.xml")
      }
  }
  

Note: Docker requires at least 4GB of memory. Set it in Docker Preferences > Resources > Memory section.

Now you can run inspections with runInspections Gradle task:

gradle runInspections 
// or
./gradlew runInspections

Full guide for options and configuration parameters could be found on qodana docs page.

Build Locally

Build

Execute Gradle task publishToMavenLocal to build Gradle Qodana Plugin and publish it into local Maven repository. By default, plugin will be published into ~/.mvn/org/jetbrains/qodana/ directory.

Apply

Add Maven local repository into available repositories in your Gradle project. For this you need to add following lines at the beginning of settings.gradle[.kts] file:

pluginManagement {
    repositories {
        mavenLocal()
        gradlePluginPortal()
    }
}

Apply Gradle Qodana Plugin with snapshot version in Gradle configuration file and mount the Maven Local directory:

• Groovy – build.gradle

  plugins {
      id "org.jetbrains.qodana" version "0.1.0-SNAPSHOT"
  }
  
  qodana {
      mount("/Users/me/.m2", "/root/.m2")
  }
  

• Kotlin DSL – build.gradle.kts

  plugins {
      id("org.jetbrains.qodana") version "0.1.0-SNAPSHOT"
  }
  
  qodana {
      mount("/Users/me/.m2", "/root/.m2")
  }