Features

Quick-Links

Quick Start ...

with the command-line interface

curl -sSLO https://github.com/detekt/detekt/releases/download/v[version]/detekt-cli-[version]-all.jarjava -jar detekt-cli-[version]-all.jar --help

with Gradle

plugins {    id("io.gitlab.arturbosch.detekt") version"[version]"}repositories {    mavenCentral()}detekt {    buildUponDefaultConfig=true// preconfigure defaults    allRules=false// activate all available (even unstable) rules.    config.setFrom("$projectDir/config/detekt.yml")// point to your custom config defining rules to run, overwriting default behavior    baseline= file("$projectDir/config/baseline.xml")// a way of suppressing issues before introducing detekt}tasks.withType<Detekt>().configureEach {    reports {        html.required.set(true)// observe findings in your browser with structure and code snippets        xml.required.set(true)// checkstyle like format mainly for integrations like Jenkins        sarif.required.set(true)// standardized SARIF format (https://sarifweb.azurewebsites.net/) to support integrations with GitHub Code Scanning        md.required.set(true)// simple Markdown format    }}// Groovy DSLtasks.withType(Detekt).configureEach {    jvmTarget="1.8"}tasks.withType(DetektCreateBaselineTask).configureEach {    jvmTarget="1.8"}// or// Kotlin DSLtasks.withType<Detekt>().configureEach {    jvmTarget="1.8"}tasks.withType<DetektCreateBaselineTask>().configureEach {    jvmTarget="1.8"}

Requirements

Adding more rule sets

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

dependencies {    detektPlugins("io.gitlab.arturbosch.detekt:detekt-rules-libraries:[version]")    detektPlugins("io.gitlab.arturbosch.detekt:detekt-rules-ruleauthors:[version]")}

Contributing

Mentions

Credits