⬆️ Update detekt to v1.23.8

[Maxr1998-bot]

This PR contains the following updates:

Package	Type	Update	Change
io.gitlab.arturbosch.detekt (source)	plugin	minor	1.21.0 -> 1.23.8
io.gitlab.arturbosch.detekt:detekt-formatting (source)	dependencies	minor	1.21.0 -> 1.23.8

---

Release Notes

detekt/detekt (io.gitlab.arturbosch.detekt)

v1.23.8

1.23.8 - 2025-02-20

This is a point release for Detekt 1.23.0, built against Kotlin 2.0.21, with fixes for several bugs that got reported by the community.

Notable Changes

• fix(deps): Update kotlin to 2.0.21 - #​7580
• fix(deps): Update AGP to v8.8.1 - #​7879
• fix(deps): update Gradle to v8.12.1 - #​7780

Changelog

• UseDataClass: do not report on expect classes - #​7857
• Fix InjectDispatcher false positives - #​7797
• [UnnecessaryParentheses] Allow float/double without integer part - #​7751
• Fix ThrowingExceptionsWithoutMessageOrCause false positive - #​7715
• Issue #​7634: Make UndocumentedPublicClass configurable to flag `com… - #​7635
• Fix redundant empty tags in baseline XML - #​7625
• MatchingDeclarationName now supports platofrm suffixes - #​6426

Contributors

We would like to thank the following contributors that made this release possible: @​BraisGabin, @​JordanLongstaff, @​Nava2, @​atulgpt, @​eygraber, @​lexa-diky, @​t-kameyama

v1.23.7

1.23.7 - 2024-09-08

This is a point release for Detekt 1.23.0, built against Kotlin 2.0.10, with fixes for several bugs that got reported by the community.

Notable Changes

• fix(deps): update kotlin monorepo to v2.0.10 - #​7517
• Update to Kotlin 2.0.0 #​6640
• fix(deps): update kotlin monorepo to v1.9.24 - #​7264
• fix(deps): update dependency com.android.tools.build:gradle to v8.5.2 - #​7525
• chore(deps): update dependency gradle to v8.10 - #​7546

Changelog

• Add basic support for isolated projects to 1.x - #​7526
• ExplicitCollectionElementAccessMethod: fix false positive when Map put has 3 arguments - #​7563
• BracesOnIfStatements: fix false-positive when chained - #​7444
• Add enum entry check in UndocumentedPublicProperty - #​7426
• Use the anchor which is already present before - #​7423
• Fix small corner-case in "SerialVersionUIDInSerializableClass" rule, … - #​7346
• SwallowedException: fix false positive when exception is used as a receiver - #​7288
• NamedArguments: fix false positive on spread varargs - #​7283
• MultilineLambdaItParameter: fix false negative with single statement on multiple lines - #​7221
• Check for root of receiver in selector expression - #​7220
• Check for public companion object for UndocumentedPublicClass - #​7219
• fix: TopLevelPropertyNaming also detecting extension property name - #​7212
• Publish detekt-compiler-plugin-all to Maven and GH Releases - #​7179
• versioned default detekt config file link - #​7161
• Support rangeUntil operator for UnusedImport rule - #​7104
• Fix false positive on it usages when type parameter is specified - #​6850

Housekeeping/Docs

• [bugfix] AnnotationOnSeparateLine in snippets - #​6526
• Add docs about using the Compiler Plugin with the Kotlin CLI compiler - #​7184

v1.23.6

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

• UselessPostfixExpression - Fix #​7037 false positive postfix - #​7084
• Don't allow invalid Source Locations - #​7030
• UnusedPrivateClass: don't report if private classes are used for type conversion - #​6995
• RedundantSuspendModifier: do not report when the function has 'actual' modifier - #​6951
• Update dependency gradle to v8.7 - #​7080
• Update kotlin monorepo to v1.9.23 - #​7027
• Update dependency gradle to v8.6 - #​6939
• Update dependency com.android.tools.build:gradle to v8.3.1 - #​7070

Contributors

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

v1.23.5

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

• Test Gradle plugin with AGP 8.2.0 - #​6672
• chore(deps): update dependency gradle to v8.5 - #​6663
• fix(deps): update kotlin monorepo to v1.9.22 - #​6746

Changelog

• Report rule's default severity in sarif backport - #​6916
• Add ignoreAnnotatedFunctions to TooManyFunctions - #​6875
• Fix by checking the existence of label in previous statements - #​6671
• Also check USELESS_ELVIS in UnreachableCode - #​6624
• Fix by adding last method call to the set - #​6567

Housekeeping & Refactorings

• Opt in to ExperimentalCompilerApi in all compilations in compiler-plugin - #​6534

Contributors

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

v1.23.4

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

• fix(deps): update kotlin monorepo to v1.9.21 - #​6642
• fix(deps): update kotlin monorepo to v1.9.20 - #​6572

Changelog

• Update the ruleset regex to allow numbers - #​6635
• Show deprecation message - #​6614
• Add io.gitlab.arturbosch.detekt.generator.Main to the jar manifest - #​6613
• Don't report FunctionNaming when the function's name equals to the return type's name with type arguments - #​6605
• Fix issues related to kotlin-stdlib's Gradle module metadata in Kotlin 1.9.20 - #​6590
• MethodSignature - Add the condition of receiver should be null - #​6570
• Remove check for deprectated functions toUpperCase and toLowerCase - #​6548
• Fixes false positive of trailing whitespaces in kdoc - #​6370

Dependency Updates

• Update tested AGP version to 8.1.3 - #​6610
• Switch to kctfork for Kotlin compilation testing - #​6589

Contributors

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

v1.23.3

1.23.3 - 2023-10-31

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.

NOTE: This is a republishing of 1.23.2 which was accidentally published against Kotlin 1.9.0 instead of 1.9.10

Changelog

• Consider deprecated rules as inactive when running allRules #​6381
• Fix inputstream leaking file descriptor in Gradle - #​6519
• ForbiddenMethodCall - Handle sequence of overridden methods - #​6478
• Function to return supported Kotlin version - #​6472
• Fix false negative IgnoredReturnValue with scope functions - #​6446
• UnconditionalJumpStatementInLoop: don't report a conditional break in a single body expression - #​6443
• Fix reporting unused imports at file level - #​6390
• OutdatedDocumentation - Detect param which private property documented as property - #​6372
• NullableToStringCall: fix false negative in lambda - #​6352
• Correctly set scheme for URIs in the SARIF report output - #​6331
• SleepInsteadOfDelay - Find the parent for suspend check - #​6191

Dependency Updates

• Update kotlin monorepo to v1.9.10 - #​6423
• Update dependency gradle to v8.4 - #​6522
• Update dependency gradle to v8.3 - #​6406
• Update com.android.tools.build to 8.1.1 - #​6419
• update dependency org.jetbrains.dokka to v1.9.10 - #​6549

Contributors

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

v1.23.2

1.23.2 - 2023-10-29

NOTE: Please use version 1.23.3 instead - Version 1.23.2 was accidentally built against Kotlin 1.9.0 instead of 1.9.10
https://github.com/detekt/detekt/releases/tag/v1.23.3

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

• Consider deprecated rules as inactive when running allRules #​6381
• Fix inputstream leaking file descriptor in Gradle - #​6519
• ForbiddenMethodCall - Handle sequence of overridden methods - #​6478
• Function to return supported Kotlin version - #​6472
• Fix false negative IgnoredReturnValue with scope functions - #​6446
• UnconditionalJumpStatementInLoop: don't report a conditional break in a single body expression - #​6443
• Fix reporting unused imports at file level - #​6390
• OutdatedDocumentation - Detect param which private property documented as property - #​6372
• NullableToStringCall: fix false negative in lambda - #​6352
• Correctly set scheme for URIs in the SARIF report output - #​6331
• SleepInsteadOfDelay - Find the parent for suspend check - #​6191

Dependency Updates

• Update kotlin monorepo to v1.9.10 - #​6423
• Update dependency gradle to v8.4 - #​6522
• Update dependency gradle to v8.3 - #​6406
• Update com.android.tools.build to 8.1.1 - #​6419
• update dependency org.jetbrains.dokka to v1.9.10 - #​6549

Contributors

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

v1.23.1

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

• Bumped Kotlin to v1.9.0 - #​6258
• Bumped KtLint to v0.50.0 - #​6239
• Updated CLI to reflect Java 20 support - #​6277

Changelog

• Add missing jdkHome and languageVersion properties to DetektCreateBaselineTask - #​6284
• Make InvalidRange aware of rangeUntil operator - #​6264
• MaxChainedCallsOnSameLine: don't count class references as chained calls - #​6224
• CanBeNonNullable: Fix false positive when property is defined after assignment - #​6210
• Add ..< and rangeTo in the ForEachOnRange rule - #​6197
• Don't report UseDataClass if class contains non-property parameters - #​6173
• Allow documenting public fun name when same private variable is present - #​6165
• Find range call using recursion - #​6164
• StringShouldBeRawString: Ignore replaceIndent and prependIndent - #​6154
• UnusedPrivateProperty: Fix false postive by ignoring data classes - #​6151
• PropertyUsedBeforeDeclaration: fix false positive in nested/inner class - #​6139

Dependency Updates

• Update dependency gradle to v8.2.1 - #​6274
• Switch to SLF4J 2.x - #​6266
• Update kotlin monorepo to v1.8.22 - #​6192

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

v1.23.0

We're so proud to announce the next upcoming stable release of detekt: 1.23.0 🚀
This release is coming with 25 new rules and much more.

We moved the detekt-compiler-plugin to the main repo, and you can now use it in your builds following the official documentation.

This release also marks the beginning of development of 2.x from the main branch! You can follow the progress here

We want to take the opportunity to thank our Sponsors and 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

• This is the first version of Detekt that ships with the detekt-compiler-plugin. The Detekt Compiler plugin is still experimental, but we're moving it closer to Detekt to make it easier to integrate. From now on the compiler plugin will follow the same versioning schema as Detekt. We invite you to try it and provide feedback till we stabilize it. You can read more about it in the official documentation page - #​5492
• We added 25 new Rules to detekt
  • BracesOnIfStatements - #​5700
  • BracesOnWhenStatements - #​5838
  • CastNullableToNonNullableType - #​5653
  • DoubleNegativeLambda - #​5937
  • ForbiddenAnnotation - #​5515
  • PropertyUsedBeforeDeclaration - #​6062
  • StringShouldBeRawString - #​5705
  • SuspendFunSwallowedCancellation - #​5666
  • UnusedParameter - #​5722
  • UnusedPrivateProperty - #​5722
  • UseLet - #​6091
  • UnnecessaryBracesAroundTrailingLambda - #​6029
  • Plus the bump to KtLint 0.49.1 added the following rules to the detekt-formatting ruleset:
    • ClassName - #​6037
    • EnumWrapping - #​6028
    • FunctionName - #​6037
    • IfElseBracing - #​6028
    • IfElseWrapping - #​6028
    • MultilineExpressionWrapping - #​6028
    • NoBlankLineInList - #​6028
    • NoConsecutiveComments - #​6028
    • NoEmptyFirstLineInClassBody - #​6028
    • NoSingleLineBlockCommentRule - #​6104
    • ParameterWrapping - #​6028
    • PropertyName - #​6037
    • PropertyWrapping - #​6028
    • StringTemplateIndent - #​6028
    • TryCatchFinallySpacing - #​6028
• Notable changes to existing rules:
  • UnnecessaryAbstractClass now only runs with type resolution - #​5829
  • UnusedPrivateMember has been refactored with some of its logic moved to UnusedParameter and UnusedPrivateProperty - #​5722
  • Removed the ignoreOverridden config from BooleanPropertyNaming, ConstructorParameterNaming, FunctionNaming, VariableNaming and FunctionParameterNaming as not useful for those rules - #​5718
  • Added ignoredSubjectTypes to rule ElseCaseInsteadOfExhaustiveWhen to specify types that should be ignored by the rule (#​5623) - #​5634
  • Added allowOperators to rule DataClassContainsFunctions - #​5658
  • MandatoryBracesIfStatements has been removed in favor of BracesOnIfStatements - #​5700
  • Added ignoreWhenContainingVariableDeclaration to UseIfInsteadOfWhen to ignore captured variables - #​5681
  • Several rules in the detekt-formatting ruleset now accepts an indentSize parameter (see the full list here).
  • We followed the KtLint decisions on turning on some rules by default, so several rules in the detekt-formatting ruleset are now turned on by default (see the full list here).
• We added support for Gradle's Worker API inside Detekt Gradle Plugin, for faster execution on bigger projects. - #​4128
• We fixed the includes/excludes logic on the config file as they were overriding each other - #​5782
• We fully removed support for Spek from detekt-test-utils. The recommended testing framework is JUnit - #​5785
• The minimum supported Gradle version is now v6.8.3 - #​5616
• This version of detekt is built with Gradle v8.1, AGP 8.0.1, Kotlin 1.8.21 and KtLint 0.49.1 (see #​5893 #​5723 #​5877 #​6028 #​6043 #​5995 #​5996)
• We now added a Code of Conduct to our repo. Please read it and follow it when interacting with our community on our channels.

Changelog

• SerialVersionUIDInSerializableClass - Update the error location - #​6114
• Reduce LoopWithTooManyJumpStatements finding scope - #​6110
• Add alias for SuspendFunWithCoroutineScopeReceiver - #​6089
• CastNullableToNonNullableType - Check the SimpleType instead of typeElement - #​6071
• Update plugin com.gradle.enterprise to v3.13.1 - #​6069
• CanBeNonNullable: Check parent condition for checking if nullability info is used or not - #​6064
• Add configuration to add alternate trimming methods - #​6063
• Check if property is documented at class header - #​6061
• OutdatedDocumentation - Check if only public property is documented - #​6057
• UnnecessaryLet: fix false positive in call chains - #​6052
• Add comments with a list of regexes to ForbiddenComment - #​5981
• Fix incomplete requireRootInDeclaration check in InvalidPackageDeclaration - #​6045
• BracesOnWhenStatements: fix false positive for necessary braces - #​6042
• Fix redundant ClassOrdering violations using maximum increasing section - #​6003
• UseIsNullOrEmpty: fix false negative with chained call - #​6027
• Create docs for Gradle Worker API - #​6016
• Compile compiler plugin against kotlin-compiler-embeddable - #​6012
• Update intro.mdx to use setFrom() on detekt config - #​6010
• Use detekt-versions.properties instead of versions.properties - #​6006
• Implement parentPath accessor in concrete config implementations - #​6002
• Increase ALIASES_LIMIT to 100 for YamlConfig - #​5986
• Fix elvis to +/- case in case UnnecessaryParentheses when precedence is unclear - #​5983
• jdkHome as @​Internal - #​5978
• Fix broken POM file for detetk-compiler-plugin - #​5971
• Fix broken publishToMavenLocal - #​5970
• Add allowOmitUnit to rule LibraryCodeMustSpecifyReturnType - #​5861
• Remove dependency that creates a cycle. - #​5777
• Update dependency org.jetbrains:annotations to v24 - #​5969
• Update github/codeql-action digest to 8c8d71d - #​5966
• Add functions to ExitOutsideMain rule - #​5963
• Update README.md - #​5954
• Prevent import statements from counting as references for UnusedPrivateProperty - #​5942
• Fix ExpressionBodySyntax not checking property getters/setters - #​5938
• Improve correctness of UnusedPrivateProperty - #​5935
• Fix documentation for deprecated 'reports' object (Issue #​5908) - #​5924
• Print file path report as link file - #​5921
• "detekt" or "Detekt" - #​5898
• Update JSON schema URL - #​5881
• Add support for local suppression inside formatting - #​5876
• Fix checkExhaustiveness for formatting and third party rules - #​5869
• Allow newline style for MaxChainedCallsOnSameLine - #​5865
• Declare inputs and outputs to support incremental build for testPluginKotlinc - #​5862
• Use code syntax for Unit for ImplicitUnitReturnType rule - #​5857
• MatchingDeclarationName. KtFilesSpec also remove .common.kt suffix from kotlin files - #​5851
• Fix double mutability issues with Gradle plugin's use of ConfigurableFileCollection - #​5850
• MagicNumber - Make ignoreNamedArgument catch more complex expression - #​5837
• Exclude super call when generating guard clauses - #​5835
• Enable test retry for all our modules - #​5825
• Stop configuring report merge tasks while configuring Detekt tasks - #​5813
• FunctionMatcher support for fully qualified function names - #​5812
• Boy Scout - #​5808
• Simplify TestConfig usages - #​5801
• Reduce configuration of UnusedPrivateMember's split rules - #​5800
• Force SerialVerionUID to be private - #​5798
• Exclude the KMP test folders for android - #​5797
• Add aliases for PackageNaming and InvalidPackageDeclaration - #​5795
• Forbid using Jupiter Kotlin assertions - #​5794
• ModifierOrder: fix false positive with block comments - #​5791
• Fixed ProtectedMemberInFinalClass rule reporting valid JVM finalize - #​5788
• Remove unnecessary usage of BeforeAll in tests - #​5781
• Run Kotlin compiler plugin CLI test as part of standard build - #​5766
• Refactor to remove java.util.Array* imports - #​5761
• Replace java.util.Stack with Kotlin's ArrayDeque implementation - #​5760
• Replace java.time.Duration with kotlin.time.Duration - #​5759
• Add NixOS installation method to doc - #​5757
• Remove & forbid usage of java.util.stream - #​5756
• Use stdlib functions for file & path operations - #​5754
• Enable UnnecessaryBackticks in detekt project - #​5753
• Update docusaurus monorepo to v2.3.1 - #​5752
• Resolve runtime classpaths consistently with compile classpaths - #​5730
• Exclude new Kotlin Test directories in default config - #​5727
• Fail when unexpected version of kotlin-compiler-embeddable is on runtime classpath - #​5726
• Fix IgnoredReturnValue rule crash in parallel mode - #​5724
• Use name that return name after backticks - #​5719
• UnusedPrivateMember - Fix false positive in case of invoke operator - #​5717
• Fix false positive for CanBeNonNullable rule - #​5714
• IgnoredReturnValue: fix false negative when annotation is on the package - #​5706
• Check Thread.sleep for block expression - #​5699
• Fix false positive of in UnnecessaryParentheses - #​5684
• Fix url and kotlin reference support in kdoc - #​5683
• Add config for variable expression in when - #​5681
• Enable NoSemicolons rule - #​5663
• Use correct resolvable/consumable flags on detekt's configurations - #​5657
• Prepare for Gradle 8 - #​5656
• ExplicitCollectionElementAccessMethod rule update - #​5654
• Cast nullable to non nullable type - #​5653
• Enable verbose mode for Codecov GH Action - #​5652
• Fail build when issues found with JVM target compatibility of related compile tasks - #​5651
• Don't silently use Kotlin compiler fallback strategy - #​5650
• Documentation tweaks - #​5639
• Have consistent compile-test-snippets between project and system property - #​5630
• Exclude operator functions in function min/max length - #​5618
• Broken link at EmptyFunctionBlock - #​5604
• Update rule description for errorprone rules - #​5603
• FunctionMaxLength false positive for overridden methods #​5590 - #​5599
• Report proper code position in MaxLineLength - #​5583
• Allow access to nonpublic members of public types in java.base/java.lang package - #​5579
• NonBooleanPropertyPrefixedWithIs: Allow AtomicBoolean - #​5577
• Pass compilation output classes to detekt analysis classpath - #​5556
• Fix KDocReferencesNonPublicProperty false positive - #​5534

Dependency Updates

• Update dependency io.github.detekt.sarif4k:sarif4k to v0.4.0 - #​6113
• Update dependency org.jetbrains.kotlinx:kotlinx-coroutines-core to v1.7.1 - #​6097
• Update dependency org.jetbrains.kotlinx:kotlinx-coroutines-core to v1.7.0 - #​6074
• Update com.android.tools.build - #​6065
• Update JaCoCo to v0.8.10 - #​6044
• Update plugin pluginPublishing to v1.2.0 - #​5975
• Update ktlint to v0.48.1 - #​5661
• Update dependency com.android.tools.build:gradle to v7.4.0 - #​5693
• JaCoCo 0.8.9 - #​5959
• Update dependency com.github.tschuchortdev:kotlin-compile-testing to v1.5.0 - #​5882
• Update dependency org.jetbrains.dokka to v1.8.10 - #​5878
• Compile detekt-compiler-plugin against standard Kotlin compiler artifact - #​5765
• Migrate to SnakeYAML Engine - #​5751
• Update kotlin monorepo to v1.8.10 - #​5745
• Update ktlint to v0.48.0 - #​5625
• Migrate to Gradle Nexus Publish Plugin - #​5554
• Update dependency io.github.detekt.sarif4k:sarif4k to v0.2.0 - #​5496

Housekeeping & Refactorings

• Inline Cases enum and inline other external test code into the test classes - #​6107
• Update codecov/codecov-action digest to eaaf4be - #​6102
• Remove unnecessary baselines - #​6092
• Remove unused dependenciesAsNames - #​6059
• Reduce eager POM task creation - #​6041
• Improve our configuration of ClassNaming and FunctionNaming - #​6019
• Comment text in the Issue/PR Template - #​5992
• Fix typo: Github -> GitHub - #​5956
• Review all Detekt and Detekt Gradle Plugin usages. - #​5955
• Review all Detekt and Detekt Gradle Plugin usages. - #​5953
• Add a test for catching undocumented public interfaces - #​5951
• Execute tests in parallel - #​5944
• Make GeneratorSpec use resources - #​5932
• Cleanup detekt-formatting to use detekt's own assertThat function - #​5911
• Stale any issue with support tag in one month - #​5904
• Remove instances of double mutability - #​5899
• Handle todo in LinesOfCode logic - #​5897
• Boy scout - detekt-generator - #​5854
• Tweak GHA configs a bit - #​5852
• Create generateWebsite - #​5849
• Remove dependency between check and jacocoMergedReport - #​5846
• Sort deprecation properties - #​5845
• Simplify generate documentation - #​5844
• Remove unnecessary @Suppress("ReturnCount") - #​5841
• Cleaner merging of Gradle blocks for functionalTests - #​5830
• Replace trimMargin usages - #​5827
• Disable PTS from local and enable it for PRs - #​5826
• Activate MultilineRawStringIndentation on detekt - #​5819
• Remove single-use times method, use stdlib's repeat instead. - #​5774
• Remove redundant build config - #​5617
• Migrate to AGP namespaces - #​5569
• Fix typo - #​5557

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

v1.22.0

We're extremely excited to announce the next upcoming stable release of Detekt: 1.22.0 🚀
This release is coming with 16 new rules, 2 new rulesets and several new functionalities & APIs.

We've also introduced the Detekt Marketplace, a place for users to share their 3rd party rules and extensions.

We want to take the opportunity to thank our Sponsors and 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

• We're introducing the Detekt Marketplace, a place where you can add your own 3rd party extension such as rule, plugins, custom reporter, etc. - #​5191
• Our website is now versioned. You can find the changes for each version using the dropdown menu on the top bar. Documentation for the upcoming version (next) can be found here.
• We added 16 new Rules to Detekt
  • AlsoCouldBeApply - #​5333
  • MultilineRawStringIndentation - #​5058
  • TrimMultilineRawString - #​5051
  • UnnecessaryNotNullCheck - #​5218
  • UnnecessaryPartOfBinaryExpression - #​5203
  • UseSumOfInsteadOfFlatMapSize - #​5405
  • FunctionReturnTypeSpacing from KtLint - #​5256
  • FunctionSignature from KtLint - #​5256
  • FunctionStartOfBodySpacing from KtLint - #​5256
  • NullableTypeSpacing from KtLint - #​5256
  • ParameterListSpacing from KtLint - #​5256
  • SpacingBetweenFunctionNameAndOpeningParenthesis from KtLint - #​5256
  • TrailingCommaOnCallSite from KtLint - #​5312
  • TrailingCommaOnDeclarationSite from KtLint - #​5312
  • TypeParameterListSpacing from KtLint - #​5256
• We added a new ruleset called detekt-rules-ruleauthors containing rules for Rule Authors to enforce best practices on Detekt rules such as the new ViolatesTypeResolutionRequirements - #​5129 #​5182
• We added a new ruleset called detekt-rules-libraries containing rules mostly useful for Library Authors - We moved the following rules inside ForbiddenPublicDataClass, LibraryCodeMustSpecifyReturnType, LibraryEntitiesShouldNotBePublic this new ruleset - See Migration below on how to migrate #​5360
• We added support for JVM toolchain. This means that Detekt will now respect the JDK toolchain you specify on your Gradle configuration. You will also be able to specify a custom JDK home with the --jdk-home CLI parameter - #​5269
• Improvement for Type Resolution
  • We will now skip rules annotated with @RequiresTypeResolution when without Type Resolution - #​5176
  • We will warn users if they run rules requiring Type Resolution when Type Resolution is disabled, so they're not silently skipped - #​5226
• Improvement for Config Management
  • We added exhaustiveness check during config validation. You can enable it checkExhaustiveness: true in your config file. This is disabled by default. - #​5089
  • We added support for generating custom configuration for rule authors - #​5080
• Deprecations & Removals
  • We deprecated the MultiRule class as it was overly complicated. The suggested approach is to just provide separated rules. - #​5161
  • The --fail-fast CLI flag (and failFast Gradle property) has been removed. It was deprecated since 1.16.x - #​5290
  • We deprecated the following rules DuplicateCaseInWhenExpression, MissingWhenCase, RedundantElseInWhen as the Kotlin Compiler is already reporting errors for those scenarios - #​5309
  • We removed the --print-ast CLI flag as PsiViewer provides the same features - #​5418
• Notable changes to existing rules
  • ArrayPrimitive is now working only with Type Resolution - #​5175
  • WildcardImport is now running also on tests by default - #​5121
  • ForbiddenImport allows now to specify a reason for every forbidden import - #​4909
  • IgnoredReturnValue: option restrictToAnnotatedMethods is now deprecated in favor of restrictToConfig - #​4922
• This version of Detekt is built with Gradle v7.5.1, AGP 7.3.1, Kotlin 1.7.21 and KtLint 0.47.1 (see #​5363 #​5189 #​5411 #​5312 #​5519)
• The minimum supported Gradle version is now v6.7.1 - #​4964

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 you 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

• ReturnCount: correctly count assignment expressions with elvis return as guard clauses - #​5539
• UnnecessaryPartOfBinaryExpression: fix false positive with pair creation - #​5516
• False positive at UnnecessaryPartOfBinaryExpression - #​5514
• Update documentation for TrailingComma rules - #​5513
• TrimMultilineRawString false-positive on annotation parameters - #​5476
• Detekt 1.22.0-RC1 -> 1.22.0-RC2 breaks UnreachableCode - #​5435
• Detekt 1.22.0-RC1 ->

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

---

• If you want to rebase/retry this PR, check this box

---

This PR has been generated by Renovate Bot.