bld-detekt/README.md

bld Extension to Perform Static Code Analysis with Detekt for Kotlin

To install the latest version, add the following to the lib/bld/bld-wrapper.properties file:

bld.extension-detekt=com.uwyn.rife2:bld-detekt

For more information, please refer to the extensions documentation.

Check Source Code with Detekt

To check all Kotlin source code located in the project, add the following to your build file:

@BuildCommand(summary = "Checks source with Detekt")
public void detekt() throws ExitStatusException, IOException, InterruptedException {
    new DetektOperation()
        .fromProject(this)
        .execute();
}

./bld compile detekt

• View Examples Project

To generate a Detekt baseline, add the following to your build file:

@BuildCommand(value = "detekt-baseline", summary = "Creates the Detekt baseline")
public void detektBaseline() throws ExitStatusException, IOException, InterruptedException {
    new DetektOperation()
        .fromProject(this)
        .baseline("detekt-baseline.xml")
        .createBaseline(true)
        .execute();
}

./bld compile detekt-baseline

• View Examples Project

Please check the DetektOperation documentation for all available configuration options.

Template Project

There is also a Kotlin Template Project with support for Dokka and the Detekt extensions.