Detekt Static Analysis

Detekt is a static code analysis tool for the Kotlin programming language. It operates on the abstract syntax tree provided by the Kotlin compiler and focuses on finding code smells, complexity issues, and potential bugs.

The detekt { } block inside kreate { project { } } provides a deeply integrated configuration for Detekt. Kreate automates the setup of the Detekt Gradle plugin, manages rule-set application, and configures reporting with professional defaults tailored for Kotlin development.

Quick Start

Detekt is disabled by default. To activate it, set the enabled property to true:

kreate {
    project {
        detekt {
            enabled.set(true)
        }
    }
}

Once enabled, you must manually apply the dev.detekt plugin to your project. Kreate will then automatically configure the standard tasks and reports.

plugins {
    id("dev.detekt") version "1.23.6" // Use the latest version
}

kreate {
    project {
        detekt {
            enabled.set(true)
        }
    }
}

Why use Detekt?

Static analysis helps maintain a high-quality codebase by:

Enforcing Consistency: Ensures all developers follow the same coding standards.
Reducing Technical Debt: Catches complex or hard-to-maintain code early.
Finding Bugs: Identifies potential issues that might not be caught by the compiler.
Education: Helps developers learn Kotlin best practices through rule descriptions.

Key Features in Kreate

Zero-Configuration: Sensible defaults are provided out of the box.
Nested DSL: Familiar configuration structure matching the original Detekt plugin.
Automated Reporting: Generates HTML, SARIF, XML, and Markdown reports by default.
Baseline Support: Easily use custom detekt.yaml configurations.
Extensible: Add third-party rule sets like detekt-formatting with ease.

Kreate v1.2.3 Help

Detekt Static Analysis

Quick Start

Why use Detekt?

Key Features in Kreate

Further Reading