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 reports based on lines of code, cyclomatic complexity and amount of code smells
Highly configurable rule sets
Suppress findings with Kotlin's @Suppress and Java's @SuppressWarnings annotations
Specify code smell thresholds to break your build
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
SonarQube integration
Extensible by own rule sets, FileProcessListener's and OutputReport's
IntelliJ integration
Unofficial Maven plugin by Ozsie

Project Website

Visit the project website for installation guides, release notes, migration guides, rule descriptions and configuration options.

Quick-Links

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

Gradle 4.9+ is required:

buildscript {
    repositories {
        jcenter()
    }
}

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

detekt {
    toolVersion = "[version]"
    input = files("src/main/kotlin")
    filters = ".*/resources/.*,.*/build/.*"
    baseline = file("my-detekt-baseline.xml") // Just if you want to create a baseline file.
}

See bintray for releases and artifactory for snapshots.

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 {
    detektPlugins "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!

Artur Bosch - Maintainer
Marvin Ramin - Collaborator, Bunch of rules, Active on Issues, refactorings, MultiRule
schalks - Collaborator, Active on Issues, Bunch of rules, Project metrics
Niklas Baudy - Active on Issues, Bunch of rules, Bug fixes
lummax - Cli enhancements
Svyatoslav Chatchenko - Active on Issues, NamingConventions and UnusedImport fixes
Sean Flanigan - Config from classpath resource
Sebastian Schuberth - Active on Issues, Windows support
Olivier Lemasle - NP-Bugfix, rules fixes, Gradle plugin improvement
Marc Prengemann - Support for custom output formats, prototyped Rule-Context-Issue separation
Sebastiano Poggi - Enhanced milestone report script, Magic number fixes
Ilya Tretyakov - Sonar runs should not auto correct formatting.
Andrey T - Readme fix
Ivan Balaksha - Rules: UnsafeCast, SpreadOperator, UnsafeCallOnNullableType, LabeledExpression
Anna Y - Readme fix
Karol Wrótniak - Treat comments as not empty blocks
Radim Vaculik - VariableMaxLength - bugfix
Martin Nonnenmacher - UndocumentedPublicClass - enum support
Dmytro Troynikov - Updated Magic Number rule to ignore Named Arguments
Andrew Ochsner - Updated Readme for failFast option
Paul Merlin - Gradle build improvements
Konstantin Aksenov - Coding improvement
Matthew Haughton - Added type resolution, Dependency updates, Coding + Documentation improvements
Janusz Bagiński - Fixed line number reporting for MaxLineLengthRule
Mike Kobit - Gradle build improvements
Philipp Hofmann - Readme improvements
Olivier PEREZ - Fixed Typo in Readme
Sebastian Kaspari - Html-Output-Format, Documentation fix
Ilya Zorin - Rule improvement: UnnecessaryAbstractClass
Gesh Markov - Improve error message for incorrect configuration file
Patrick Pilch - Rule improvement: ReturnCount
Serj Lotutovici - Rule improvement: LongParameterList
Dmitry Primshyts - Rule improvement: MagicNumber
Egor Neliuba - Rule improvement: EmptyFunctionBlock, EmptyClassBlock
Said Tahsin Dane - Gradle plugin improvements
Misa Torres - Added: TrailingWhitespace and NoTabs rules
R.A. Porter - Updated Readme links to RuleSets
Robbin Voortman - Rule improvement: MaxLineLength
Mike Gorunov — Rule improvement: UndocumentedPublicFunction
Joey Kaan - New rule: MandatoryBracesIfStatements
Dmitriy Samaryan - Rule fix: SerialVersionUIDInSerializableClass
Mariano Simone - Rule improvement: UnusedPrivateMember. New Rules: UnusedPrivateClass, VarCouldBeVal
Shunsuke Maeda - Fix: to work on multi module project using maven plugin
Mikhail Levchenko - New rules: Unnecessary let, ExplicitItLambdaParameter
Scott Kennedy - Minor fixes
Mickele Moriconi - Added: ConstructorParameterNaming and FunctionParameterNaming rules
Lukasz Jazgar - Fixed configuring formatting rules
Pavlos-Petros Tournaris - Lazy evaluation of Regex in Rules
Erhard Pointl - Kotlin DSL and Gradle enhancements
Tyler Thrailkill - FunctionNaming rule enhancements
Tarek Belkahia - TooManyFunctions rule options
Bournane Abdelkrim - Fix typos
Rafael Toledo - Fix Gradle plugin badge
Alberto Ballano - ExceptionRaisedInUnexpectedLocation rule improvements
Guido Pio Mariotti - Documentation improvement
Mygod - UnusedImports rule improvement
Andreas Volkmann - yaml code comments
glammers - Documentation improvement
Ahmad El-Melegy - yaml syntax fix
Arjan Kleene - Add unnecessary apply rule
Paweł Gajda - Rule improvement: FunctionParameterNaming
Alistair Sykes - Doc improvement
Andrew Arnott - UnusedPrivateMember improvement
Tyler Wong - UnderscoresInNumericLiterals rule
Daniele Conti - ObjectPropertyNaming improvement
Nicola Corti - Fixed Suppress of MaxLineLenght
Michael Lotkowski - Rule improvement: False positive UnusedImport for componentN
Nuno Caro - Adds TXT report support on gradle plugin

Mentions

As mentioned in...

Integrations:

Credits

JetBrains - Creating Intellij + Kotlin
PMD & Checkstyle & KtLint - Ideas for threshold values and style rules

README.md Unescape Escape

detekt