detekt

Additional

Language
Kotlin
Version
RC9 (Sep 15, 2018)
Created
Oct 24, 2016
Updated
Sep 15, 2018
Owner
Artur Bosch (arturbosch)
Contributors
egor-n
Pavlos-Petros Tournaris (pavlospt)
rock3r
Janusz Bagiński (jbaginski)
Marc Prengemann (winterDroid)
sschuberth
scottkennedy
Serj Lotutovici (serj-lotutovici)
Rafael Toledo (rafaeltoledo)
Karol Wrótniak (koral--)
gitter-badger
Said Tahsin Dane (tasomaniac)
Niklas Baudy (vanniktech)
mnonnenmacher
tokou
mickele
Ilya Zorin (geralt-encore)
eskatos
Show all (56)56
Activity
Badge
Generate
Download
Source code

Advertising

detekt

Meet detekt, a static code analysis tool for the Kotlin programming language. It operates on the abstract syntax tree provided by the Kotlin compiler.

Features

  • Code smell analysis for your Kotlin projects
  • Complexity report based on logical lines of code, McCabe complexity and amount of code smells
  • Highly configurable
  • Suppress findings with Kotlin's @Suppress and Java's @SuppressWarnings annotations
  • Specify code smell thresholds to break your build or print a warning
  • Code Smell baseline and ignore lists for legacy projects
  • Gradle plugin for code analysis via Gradle builds
  • Gradle tasks to use local IntelliJ distribution for formatting and inspecting Kotlin code
  • Optionally configure detekt for each sub module by using profiles (gradle-plugin)
  • SonarQube integration
  • Extensible by own rule sets and FileProcessListener's
  • IntelliJ integration
  • Unofficial Maven plugin by Ozsie

Project Website

Visit https://arturbosch.github.io/detekt/ for installation guides, release notes, migration guides, rule descriptions and configuration options.

Quick Start ...

with command-line interface

  • git clone https://github.com/arturbosch/detekt
  • cd detekt
  • ./gradlew build shadowJar
  • java -jar detekt-cli/build/libs/detekt-cli-[version]-all.jar --help

with gradle

buildscript {
    repositories {
        jcenter()
    }
}

plugins {
    id("io.gitlab.arturbosch.detekt").version("[version]")
}

detekt {
    toolVersion = "[version]"
    input = files("src/main/kotlin")
    filters = ".*/resources/.*,.*/build/.*"
}

Adding more rule sets

detekt itself provides a wrapper over KtLint as a formatting rule set which can be easily added to the gradle configuration:

dependencies {
    detekt "io.gitlab.arturbosch.detekt:detekt-formatting:[version]"
}

Likewise custom extensions can be added to detekt.

Contributors

If you contributed to detekt but your name is not in the list, please feel free to add yourself to it!

Mentions

As mentioned in...

Integrations:

Credits