Changelog and Migration Guide

1.23.6 - 2024-03-23 ​

This is a point release for Detekt 1.23.0 , where we added support for Kotlin 1.9.23 and fixed several bugs that got reported by the community.

Changelog ​

Contributors ​

We would like to thank the following contributors that made this release possible: @BraisGabin, @t-kameyama

1.23.5 - 2024-01-31 ​

This is a point release for Detekt 1.23.0 , where we added support for Kotlin 1.9.22 and fixed several bugs that got reported by the community.

Notable Changes ​

Changelog ​

Housekeeping & Refactorings ​

Contributors ​

We would like to thank the following contributors that made this release possible: @3flex, @TWiStErRob, @atulgpt, @matejdro

1.23.4 - 2023-11-26 ​

This is a point release for Detekt 1.23.0 , where we added support for Kotlin 1.9.21 and fixed several bugs that got reported by the community.

Notable Changes ​

Changelog ​

Dependency Updates ​

Contributors ​

We would like to thank the following contributors that made this release possible: @3flex, @BraisGabin, @Gosunet, @atulgpt, @t-kameyama

1.23.3 - 2023-10-31 ​

This is a point release for Detekt 1.23.0 . The changelog is equivalent to 1.23.2 .

1.23.2 - 2023-10-29 ​

Note: please use version 1.23.3 instead as Kotlin 1.9.10 support was added there

This is a point release for Detekt 1.23.0 , where we added support for Kotlin 1.9.10 and fixed several bugs that got reported by the community.

Changelog ​

Dependency Updates ​

Contributors ​

We would like to thank the following contributors that made this release possible: @3flex, @arturbosch, @atulgpt, @kkocel, @marschwar, @pablobaxter, @t-kameyama

1.23.1 - 2023-07-30 ​

This is a point release for Detekt 1.23.0 , where we added support for Kotlin 1.9.0 and fixed several bugs that got reported by the community.

Notable Changes ​

Changelog ​

Dependency Updates ​

Contributors ​

We would like to thank the following contributors that made this release possible: @3flex, @Goooler, @Hexcles, @PoisonedYouth, @TWiStErRob, @VirtualParticle, @atulgpt, @cortinico, @dzirbel, @eygraber, @marschwar, @rmarquis, @segunfamisa, @severn-everett, @t-kameyama

See all commit history here

1.23.0 - 2023-05-22 ​

Notable Changes ​

Changelog ​

Dependency Updates ​

Housekeeping & Refactorings ​

Contributors ​

We would like to thank the following contributors that made this release possible: @3flex, @BeBAKE, @BraisGabin, @Goooler, @SaumyaBhushan, @TWiStErRob, @VitalyVPinchuk, @adef145, @asomov, @atulgpt, @chao2zhang, @cketti, @cortinico, @drawers, @dzirbel, @igorwojda, @lexa-diky, @luanpotter, @marschwar, @mjovanc, @mmorozkov, @ncteisen, @osipxd, @ov7a, @schalkms, @t-kameyama, @tresni

See all issues at: 1.23.0

1.22.0 - 2022-11-20 ​

Notable Changes ​

Migration ​

We deprecated a number of rules in this release.

You should update your config file as follows:

  potential-bugs:
    active: true
    ...
-   DuplicateCaseInWhenExpression:
-     active: true
    ...
-   MissingWhenCase:
-     active: true
-     allowElseExpression: true
    ...
-   RedundantElseInWhen:
-     active: true

  style:
    active: true
    ...
-   ForbiddenPublicDataClass:
-     active: true
-     excludes: ['**']
-     ignorePackages:
-       - '*.internal'
-       - '*.internal.*'
    ...
-   LibraryCodeMustSpecifyReturnType:
-     active: true
-     excludes: ['**']
    ...
-   LibraryEntitiesShouldNotBePublic:
-     active: true
-     excludes: ['**']

If you wish to use the libraries ruleset we introduced you should add the following to your config file:

+ libraries:
+   active: true
+   ForbiddenPublicDataClass:
+     active: false
+   LibraryEntitiesShouldNotBePublic:
+     active: false
+   LibraryCodeMustSpecifyReturnType:
+     active: true

and add the following to your build.gradle file:

detektPlugins("io.gitlab.arturbosch.detekt:detekt-rules-libraries:$version")

If you're using our KtLint wrapper (i.e. detekt-formatting ) you should also update your config file as follows:

formatting:
  active: true
  ...
- TrailingComma:
-   active: false
-   autoCorrect: true
-   allowTrailingComma: false
-   allowTrailingCommaOnCallSite: false
  ...
+ TrailingCommaOnCallSite:
+   active: false
+   autoCorrect: true
+   useTrailingCommaOnCallSite: false
+ TrailingCommaOnDeclarationSite:
+   active: false
+   autoCorrect: true
+   useTrailingCommaOnDeclarationSite: false

Changelog ​

Dependency Updates ​

Housekeeping & Refactorings ​

See all issues at: 1.22.0

1.21.0 - 2022-07-16 ​

We're delighted to announce the next upcoming stable release of detekt: 1.21.0 🎉 This release is coming with 6 new rules, new API and functionalities and several stability improvements.

We want to thank you very much our Sponsors for the support in those last months. The work behind detekt is all happening on a voluntary basis, and we're more than grateful for all the support we get from the Open Source Ecosystem.

We're also excited to announce that we're now having an Open Source Gradle Enterprise instance. When building the detekt projects, you'll benefit from the Gradle Remote Cache that this instance is providing!

Finally, we want to take the opportunity to thank our contributors for testing, bug reporting and helping us release this new version of detekt. You're more than welcome to join our community on the #detekt channel on KotlinLang's Slack (you can get an invite here ).

Notable Changes ​

Migration ​

We fixed a bug related to function with KDocs and how their location in the source code was calculated (see #4961 and #4887 ).

Because of this, some users might have to recreate their baseline as the location of such functions are not matched anymore against the baseline. You can do so by deleting your old baseline and invoking the detektBaseline task (or the corresponding task, based on your configuration).

Changelog ​

Dependency Updates ​

Housekeeping & Refactorings ​

See all issues at: 1.21.0

1.20.0 - 2022-04-14 ​

We're extremely excited to share with you all the next upcoming stable release of detekt: 1.20.0 🎉 This release is coming with 16 new rules, new API and functionalities and several stability improvements.

First, much thanks to our sponsors ❤️ as we were able to buy a domain and move our website to https://detekt.dev/ .

As for the feature shipped, we work a lot on the Reporting side: we added a new type of reporting, improved the styling of the existing one and generally reduced the unnecessary warnings of run with type resolution.

For rules like ForbiddenMethod where you can configure a signature of a method you want to use in your rule, we added a new syntax that allows to reference generic methods & extension functions.

We update a lot of the libraries we depend on bringing detekt up to the ecosystem: KtLint 0.45.2, Kotlin 1.6.20 and Gradle 7.4.2 to name a few.

Finally, we also migrated all of our tests from Spek to JUnit . This was a huge effort that will hopefully make easier for contributors to be involved with detekt.

As always, we want to take the opportunity to thank our contributors for testing, bug reporting and helping us release this new version of detekt. You're more than welcome to join our community on the #detekt channel on KotlinLang's Slack (you can get an invite here ).

Notable Changes ​

Changelog ​

Dependency Updates ​

Housekeeping & Refactorings ​

See all issues at: 1.20.0

1.19.0 - 2021-11-29 ​

Please welcome the next upcoming stable release of detekt: 1.19.0 🎉 This release is coming with a lot of new features, new rules, evolution in the API and stability improvements.

Specifically, we've shipped some features that will allow you to better adapt detekt to run on codebases that are using JetPack compose with features such as ignoreAnnotated and ignoreFunction .

As always, we want to take the opportunity to thank our contributors for testing, bug reporting and helping us release this new version of detekt. You're more than welcome to join our community on the #detekt channel on KotlinLang's Slack (you can get an invite here ).

Notable Changes ​

Migration ​

Configuring reports in the Gradle plugin should be done at the task level instead of at the extension (or global) level. The previous recommendation resulted in the report output for multiple tasks overwriting each other when multiple detekt tasks were executed in the same Gradle run.

Before this release the recommended way to configure reports was using the detekt extension:

detekt {
    reports {
        xml {
            enabled 




    
= true
            destination = file("build/reports/detekt/detekt.xml")
        }
    }
}

This meant all detekt tasks would output the report to the same destination. From this detekt release you should enable and disable reports for all tasks using the withType Gradle method:

// Kotlin DSL
tasks.withType<Detekt>().configureEach {
    reports {
        xml.required.set(true)
    }
}

// Groovy DSL
tasks.withType(Detekt).configureEach {
    reports {
        xml.required.set(true)
    }
}

To customize the report output location configure the task individually:

tasks.detektMain {
    reports {
        xml {
            outputLocation.set(file("build/reports/detekt/customPath.xml"))
            required.set(true) // reports can also be enabled and disabled at the task level as needed
        }
    }
}

Changelog ​

Dependency Updates ​

Housekeeping & Refactorings ​

See all issues at: 1.19.0

1.18.1 - 2021-08-30 ​

This is a point release for detekt 1.18.0 containing bugfixes for problems that got discovered just after the release.

Notable Changes ​

See all issues at: 1.18.1

1.18.0 - 2021-08-12 ​

We're more than excited to introduce you a next stable release of detekt: 1.18.0 🎉 This release is coming with a lot of changes, new rules, evolution in the API and stability improvements.

We want to take the opportunity to thank our contributors for testing, bug reporting and helping us release this new version of detekt.

Notable Changes ​

Migration ​

// BEFORE
detekt {
    input = files(...)
}

// AFTER
detekt {
    source = files(...)
}

/* simple property */
// BEFORE
val ignoreDataClasses = valueOrDefault("ignoreDataClasses", true)
// AFTER
val ignoreDataClasses: Boolean by config(true)

/* transformed simple property */
// BEFORE
val ignoredName = valueOrDefault("ignoredName", "").trim()
// AFTER
val ignoredName: String by config("", String::trim)

/* transformed list property */
// BEFORE
val ignoreAnnotated = valueOrDefaultCommaSeparated("ignoreAnnotated", listOf("Inject", "Value"))
        .map(String::trim)
// AFTER
val ignoreAnnotated: List<String> by config(listOf("Inject", "Value")) { list ->
    list.map(String::trim)
}

/* ThresholdRule */
// BEFORE
class MyRule(config: Config, threshold: Int = 10) : ThresholdRule(config, threshold) {
    // ...
}
// AFTER
class MyRule(config: Config) : Rule(config) {
    private val threshold: Int by config(10)
    // ...
}

/* LazyRegex */
// BEFORE
private val allowedPattern: Regex by LazyRegex("allowedPatterns", "")
// AFTER
private val allowedPattern: Regex by config("", String::toRegex)

Changelog ​

Dependency Updates ​

Housekeeping & Refactorings ​

See all issues at: 1.18.0

1.17.1 - 2021-05-19 ​

Notable Changes ​

This is a patch release for detekt 1.17.0 including fixes that we considered worth a point release.

Specifically, we're reverting a change on our Gradle Plugin. The original change #3655 resulted in several false positives when using rules with Type Resolution on Java/Kotlin mixed codebases.

Moreover we included a couple of false positive fixes for NoNameShadowing and UnnecessaryLet

Changelog ​

1.17.0 - 2021-05-15 ​

Notable Changes ​

Changelog ​

Dependency Updates ​

Housekeeping & Refactorings ​

See all issues at: 1.17.0

1.16.0 - 2021-03-10 ​

Changelog ​

Housekeeping & Refactorings ​

See all issues at: 1.16.0

1.15.0 - 2020-12-18 ​

Notable Changes ​

detekt 1.15.0 bundles Kotlin 1.4.10.
You may experience some known issues when your project already uses 1.4.20

In addition to many rule improvements, there are also new ones:

We added documentation on how to configure type resolution .
Only the rules marked with Requires Type Resolution (on the website documentation or @requiresTypeResolution in code) are executed (see here for example ).

detekt now supports SARIF as an output format. In the future you will be able to upload this format to GitHub and see detekt issues right in your pull requests.

Migration ​

We removed implementations of the Config interface from the public api.
It was first deprecated and then moved to internal package earlier this year.
Rule authors can use TestConfig(Map) or yamlConfig(String) from detekt-test to test their rules.

Changelog ​

Housekeeping & Refactorings ​

See all issues at: 1.15.0

1.14.2 - 2020-10-20 ​

Changelog ​

Housekeeping & Refactorings ​

See all issues at: 1.14.2

1.14.1 - 2020-09-30 ​

Changelog ​

Housekeeping & Refactorings ​

See all issues at: 1.14.1

1.14.0 - 2020-09-26 ​

Notable Changes ​

Changelog ​

Housekeeping & Refactorings ​

See all issues at: 1.14.0

1.13.1 - 2020-09-13 ​

Notable Changes ​

We now publish directly to maven central. The 1.13.0 release got corrupted and should not be used.

1.13.0 - 2020-09-07 ​

Migration ​

Changelog ​

Housekeeping & Refactorings ​

See all issues at: 1.13.0

1.12.0 - 2020-08-25 ​

Notable Changes ​

Migration ​

Note the default gradle detekt task does not run over test sources. To include test sources following setup can be used:

detekt {
    // ...
    input = objects.fileCollection().from(
        "src/main/java",
        "src/test/java",
        "src/main/kotlin",
        "src/test/kotlin"
    )
}

This does not apply to gradle detektTest . We encourage to also check test sources.
We will include test sources by default in detekt 1.15.0 or later.

Changelog ​

Housekeeping & Refactorings ​

See all issues at: 1.12.0

1.12.0-RC1 - 2020-08-20 ​

Notable Changes ​

The Gradle plugin now requires at least Gradle 5.4. This aligns with Kotlin's Gradle plugin.

Changelog ​

See all issues at: 1.12.0-RC1

1.11.2 - 2020-08-19 ​

Changelog ​

See all issues at: 1.11.2

1.11.1 - 2020-08-18 ​

Changelog ​

See all issues at: 1.11.1

1.11.0 - 2020-08-13 ​

Changelog ​

See all issues at: 1.11.0
See all issues at: 1.11.0-RC2
See all issues at: 1.11.0-RC1

1.11.0-RC2 - 2020-08-09 ​

Changelog ​

Housekeeping & Refactorings ​

See all issues at: 1.11.0-RC2

1.11.0-RC1 - 2020-08-02 ​

Changelog ​

Housekeeping & Refactorings ​

See all issues at: 1.11.0-RC1

1.10.0 ​

Notable Changes ​

Migration ​

Changelog ​

Housekeeping & Refactorings ​

See all issues at: 1.10.0

1.9.1 ​

Changelog ​

See all issues at: 1.9.1

1.9.0 ​

Changelog ​

See all issues at: 1.9.0

1.8.0 ​

Notable Changes ​

Migration ​

Changelog ​

See all issues at: 1.8.0

1.7.4 ​

Notable Changes ​

The last Gradle plugin version was referencing 1.7.2 instead of 1.7.3. This was fixed and specifying the toolVersion is not necessary anymore.

detekt {
    toolversion = "1.7.3"
}

Changelog ​

See all issues at: 1.7.4

1.7.3 ​

Changelog ​

See all issues at: 1.7.3

1.7.2 ​

Changelog ​

See all issues at: 1.7.2

1.7.1 ​

Changelog ​

See all issues at: 1.7.1

1.7.0 ​

Notable Changes ​

Changelog ​

See all issues at: 1.7.0

1.6.0 ​

Migration ​

Rule set authors do not need to exclude their rule set from config validation anymore. This will be done by default now.

If you need to include further config property checks, give the new ConfigValidator api a try.

Changelog ​

See all issues at: 1.6.0

1.5.1 ​

See all issues at: 1.5.1

1.5.0 ​

Notable Changes ​

console-reports:
    active: true
    exclude:
        - "ProjectStatisticsReport"
        - "ComplexityReport"
        - "NotificationReport"

build:
    maxIssues: 0

Changelog ​

See all issues at: 1.5.0

1.4.0 ​

Notable Changes ​

New rule set coroutines with two specialized rules was added.
As always new rules must be activated by the user until they get stable.

coroutines:
    active: true
    GlobalCoroutineUsage:
        active: false
    RedundantSuspendModifier:
        active: false

Wrapped KtLint was updated to 0.36.0 introducing two rules

Migration ​

The properties ignoreOverriddenFunction and ignoreOverriddenFunctions of some rules got deprecated and unified to a new property ignoreOverridden .

Changelog ​

See all issues at: 1.4.0

1.3.1 ​

See all issues at: 1.3.1

1.3.0 ​

Notable changes ​

Changelog ​

See all issues at: 1.3.0

1.2.2 ​

Notable Changes ​

Changelog ​

See all issues at: 1.2.2

1.2.1 ​

Notable changes ​

Changelog ​

See all issues at: 1.2.1

1.2.0 ​

Notable changes ​

Migration ​

Changelog ​

See all issues at: 1.2.0

1.1.1 ​

Changelog ​

See all issues at: 1.1.1

1.1.0 ​

Changelog ​

See all issues at: 1.1.0

1.0.1 ​

Notable changes ​

Changelog ​

See all issues at: 1.0.1

1.0.0 ​

Migration ​

Changelog ​