SonarQube plugin for Kotlin
Clone or download

README.md

sonar-kotlin

Join the chat at https://kotlinlang.slack.com/messages/C88E12QH4/convo/C0BQ5GZ0S-1511956674.000289/ build status build status windows

sonar-kotlin-in-action

Features

  • Integrates detekt for code analysis
  • Default quality profile Detekt way
  • Syntax highlighting
  • Supports SonarQube 6.7.3 and up
  • Supports detekt's yaml config and baseline.xml (also path filters)

Usage

Sonar-kotlin is not yet uploaded to the Update Center

  • git clone https://github.com/arturbosch/sonar-kotlin
  • cd sonar-kotlin
  • mvn package
  • cp target/sonar-kotlin-[enter_version].jar $SONAR_HOME/extensions/plugins
  • cd $SONAR_HOME/bin/[your_os]
  • ./sonar.sh restart

Configurations and Baselines (and Filters)

Read about detekt configuration files here and about detekt baseline formats here.

Best ways to get started is to configure the detekt-gradle-plugin in your project and use its detektBaseline and detektGenerateConfig tasks.

  • detektGenerateConfig copies the default configuration file which you can use to turn on and off rules and set appropriate threshold values for some rules.
  • detektBaseline analyzes your project and generates a baseline xml file with all your current findings. This findings won't get reported anymore in sonar.
Usage

To make use of this features, you have to set up some properties:

configs

Detekt path filters support multiple regex entries by adding a , for separating. Detekt yaml configuration path also supports multiple configuration files where the first entered override some values of the later added config files.

Limitations

Sonar analyzes each module individually which makes it harder to search for your config files. If you use relative paths, sonar-kotlin first tries to find the provided path inside this module and if it can't find it, we are searching for the file in the parent folder. This leads to the limitation that only projects with sub-projects of depth 1 are supported. If you need more config files in your project hierarchies, provide them in the sub-projects with the same relative path available.

Mentions

As mentioned/used in ...