Edit me

RC16

Migration
  • Notice that we removed the deprecated warningThreshold and failThreshold. Use maxIssues from now on instead.
  • We updated KtLint integration to 0.33.0 which introduces four new rules. Make sure to enable them.
Changelog
  • Use Codecov’s recommended JaCoCo config - #1739
  • Write a post about how to use snapshot releases - #1737
  • Document how to include/exclude source files in the gradle plugin - #1736
  • Publish snapshots to jfrogs oss artifactory - #1734
  • Extract building runner - #1733
  • Move to JSR compilation for rule Specs - #1732
  • Remove deprecated threshold settings doc - #1730
  • Publish snapshots to jfrogs oss artifactory - #1729
  • Remove deprecated build failure threshold settings - #1723 - #1728
  • Print to console the count of weighted issues if above 0 - #1725
  • Extract building a runner from main method - #1719
  • Run all detekt tasks with project dependencies - #1718
  • Update doc for UnusedImports rule - #1714
  • Update Kotlin to 1.3.40 - #1713
  • Unable to use “exclude” in 1.0.0-RC15 with groovy dsl - #1712
  • Introduce lock-bot - #1711
  • Fix broken hasLocationStrings and similar broken assert - #1707
  • Rule improvement: False positive UnusedImport for componentN - #1705
  • Update doc (report extension section) - #1703
  • Disable colors on Windows OS - #1701
  • Add two more examples and one integrating site - #1699
  • Filter fake elements when processing ast nodes - Closes #1688 - #1698
  • Set ignoreFailures on all sourceset tasks - #1697
  • Gradle plugin: Pass arguments to detekt in a file - #1696
  • Gradle: Upgrade the ktlint version to 0.33.0 - #1692
  • Fixed bug reporting false positives with EmptyFunctionBlock - #1690
  • Fix reporting logic for UseRequire and UseCheckOrErrorSpec - #1689
  • Bogus NoTrailingSpaces findings in some files - #1688
  • Implement LibraryCodeMustSpecifyReturnType rule - #1659
  • Add RedundantElseInWhen rule - #1603
  • Wrap four new KtLint rules - #1455

See all issues at: RC16

RC15

Migration
  • Cli: filters concept got deprecated and removed. Please use the new excludes and includes options. excludes works exactly like filters did except it takes now a comma separated list of globing patterns instead of a regular expressions. For example --filters .*/resources/.* becomes --excludes **/resources/**. includes also accepts globing patterns. Globing patterns allow us to reuse some common logic of the java.nio.file package which for example handle Windows specific paths for us. This change also allows to be more fine granular with analyzing files: --excludes **/generated/** --includes **/generated/this-needs-to-be-checked. The following how-to guide describes the migration process from the test-pattern functionality.
  • Gradle Plugin: Including or excluding paths and files from detekt scanning is now done by setting include & exclude on the detekt task which aligns with how other static analysis tools handle filters. Any use of filters will be ignored. See custom task examples for Groovy and Kotlin. For details of syntax see https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/util/PatternFilterable.html
  • Gradle Plugin: Adds support for TXT report.
  • Cli/Gradle Plugin: autoCorrect inside the yaml config was removed. Please use the --auto-correct cli flag or autoCorrect detekt extension property in the Gradle plugin.
Changelog
  • Adding test for UselessCallOnNotNull and platform types - #1674
  • Fix MaxLineLength and suppressing issues with multiline strings - #1673
  • Update website for all breaking changes in RC15 - #1671
  • Fix TooManyFunctions report logic - #1669
  • Rework UnderscoresInNumericLiterals Rule - #1664
  • JaCoCo 0.8.4 - #1663
  • Add support for JSR test infrastructure for type resolved rules - #1661
  • Unify use of kotlin environment and make AST modification work again - #1657
  • Do not use relativePath as it is not set anymore and will crash the detekt run - #1655
  • Move autocorrect to cli - #1654
  • Replace test pattern concept with rule excludes - #1651
  • Refactor api tests to use test-api - #1649
  • Allow to configure exclusion and inclusion patterns for rule sets - #1648
  • Revert cross module coverage - #1647
  • Migrate to lazy searching of child nodes - #1646
  • Do not report when using shortcut ‘return’ on nullable types - #1645
  • Consider default functions inside interface for used private functions - #1644
  • Lazily add detekt task as a dependency of the check task - #1641
  • Detekt gradle task is not executed upon check - #1640
  • Remove git commit message check - #1638
  • Remove additional space in EmptyClassBlock report msg - #1636
  • Whitelist provideDelegate operator in UnusedImports rule - #1632
  • Reports no duplicated findings in empty ruleset - #1623
  • Add support for JSR test infrastructure in style ruleset - #1620
  • Update to kotlin version 1.3.31 - #1618
  • Publish detekt-api docs to the detekt documentation site - #1615
  • False Positive on UnusedPrivateMember with interface’s default method - #1613
  • Update dependencies - #1612
  • Improve handling of classpaths in Gradle plugin - #1609
  • False positive from UnusedImports on org.gradle.kotlin.dsl.provideDelegate - #1608
  • Provide meaningful config error message by tracking sub configurations - #1607
  • Replace cli filters parameter with incudes and excludes - #1606
  • Duplicated findings are being added to Detektion.findings - #1605
  • Don’t trigger SpreadOperator rule when array copy not required - #1604
  • Add MissingWhenCase rule - #1602
  • Custom reports in gradle plugin - #1598
  • Gradle plugin: create task per source set (JVM) - #1597
  • Added auto correct information to finding - #1595
  • Add DataClassShouldBeImmutable rule - #1588
  • Using custom output inside Gradle plugin - #1583
  • Colorizes CLI output. - #1581
  • Using the Gradle Plugin analyzes files sequentially - #1580
  • Bump Spek version - #1578
  • Ignore void types in overridden function signatures. - #1576
  • Test case and fix for issue #1573 - #1575
  • ForbiddenImport matches on substring, not full class - #1573
  • Silence dokka - #1572
  • AssertJ housekeeping - #1571
  • Add rules to suggest usage of check(), require() and error(). - #1570
  • Allow configuration to ignore magic number in ranges. - #1567
  • Add support for JSR test infrastructure in naming ruleset - #1564
  • Add support for JSR test infrastructure in empty ruleset - #1563
  • Add support for JSR test infrastructure in complexity ruleset - #1562
  • Add support for JSR test infrastructure in bugs ruleset - #1561
  • Add detekt mention to readme - #1560
  • Add formatting issue to baseline - #1559
  • Update doc for fail-fast argument - #1558
  • Travis: Skip default install step - #1557
  • Fix the check for private top-level property naming - #1556
  • Allow to ignore local properties in magic number - Closes #1536 - #1555
  • Test on OpenJDK 12 - #1554
  • Update Gradle & dependencies - #1549
  • Simplify Java interop - #1547
  • Improve RC13 migration instructions in changelog - #1546
  • Enable local build cache for CI - #1544
  • ktlint 0.31.0 - #1543
  • Add code formatting instructions to CONTRIBUTING.md - #1542
  • Remove non popular watcher module - #1541
  • Add ignoreVariables to MagicNumber - #1536
  • Ignore local properties - #1535
  • Enable Kotlin’s progressive compilation mode - #1534
  • Type and symbol resolving - #1532
  • Remove the timestamp from the baseline doc #1524 - #1531
  • Add newline at end of baseline files - #1527
  • Add a final newline in the baseline files - #1525
  • Configure build-scan plugin - #1523
  • [docs] Introduce guides in the news section - #1522
  • Repackage formatting to make it able to use the jar as –plugins jar for cli runs - #1521
  • Single statement in nullable apply calls - #1520
  • Update dependencies - #1519
  • Fix compliant/noncompliant code example in OptionalWhenBraces - #1511
  • Ensure IntelliJ is configured to use official Kotlin style - #1510
  • Fix deprecation warnings - #1509
  • Exit process with specific code when detekt finds code issues - #1508
  • Show friendlier error when wrong type used for a config parameter - #1507
  • Show message only when failFast in config is not null - #1506
  • Convert tasks to SourceTasks - #1505
  • Load dependencies over HTTPS - #1504
  • Exception thrown when running detekt with -p [detekt-format jar] - #1503
  • Ignore enums in ProtectedMemberInFinalClass rule - #1489 - #1496
  • Add “issues found” exit code - #1493
  • Project dependency to override detekt-cli in composite build does not run assemble automatically - #1208
  • Gradle plugin: create task per source set - #1198

See all issues at: RC15

RC14

Changelog
  • TooManyFunctions: Use existing functions to be more readable - #1491
  • Disable rules that ktlint disables by default - #1490
  • Add ignoreOverridden option for TooManyFunctions rule - #1411 - #1488
  • Do only consider calls and member accesses in UnnecessaryApply rule - #1487
  • Remove project cache dir workaround from tests - #1484
  • Add comment about baseline setup on readme - #1483
  • Test Gradle plugin on multiple Gradle versions - #1482
  • Update Default acceptableDecimalLength for UnderscoresInNumericLiterals - #1477
  • RC13 doesn’t work on gradlew 4.9 - #1475
  • False Positive UnusedPrivateClass - #1474
  • False Positive UnnecessaryApply - #1473
  • Spek 2 - #1470

See all issues at: Upcoming

RC13

Migration
  • ‘failFast’ inside the yaml config was deprecated. Please use the --fail-fast cli flag or failFast detekt extension property in the Gradle plugin.
  • The --buildUponDefaultConfig CLI flag or buildUponDefaultConfig detekt Gradle extension property allow to run detekt with the default config without duplicating it in your project. All users who use the default config and override some properties in a second config file are encouraged to migrate.
  • LongMethod and LargeClass rules got refactored and now count source lines of code and not statements anymore. You may need to change your defaults.
  • Files matching .*/androidTest/.* and *Spek.kt are now part of the test-pattern by default.
Changelog
  • Support new flags in gradle plugin - #1465
  • Add UnderscoresInNumericLiterals Rule - #1464
  • Prepare RC13 - #1462
  • Use sensible defaults for not set properties - Closes #1457 - #1461
  • Update to Kotlin v1.3.21 - #1460
  • Gradle 5.2 - #1458
  • Custom Detekt Task fails with Gradle 5.2: No value has been specified for this provider - #1457
  • Treat androidTest directory and *Spek.kt files as test sources. - #1456
  • Exclude inline classes as they are a light form of data class - Closes #1450 - #1454
  • Publish shadowed jars (-all) - #1453
  • Reimplement lines of code based rules (LargeClass & LongMethod) - #1448
  • Add test case for TooManyFunctons fix - #1439 - #1447
  • Fix false positives for UnnecessaryApply rule - Closes #1305 - #1446
  • Skip operator functions when searching for unused private members - #1354 - #1445
  • Do not report annotation classes as candidates for utility class - #1428 - #1442
  • Do not report unused import when alias is used by import from same package - #1441
  • Update Kotlin to 1.3.20 - #1438
  • Mention jcenter repository in getting started guides - #1437
  • Do not report main functions args parameter in objects - #1436
  • Update default package naming rule according to official style guide. Closes #1429 - #1434
  • UtilityClassWithPublicConstructor on annotation class - #1428
  • UnusedPrivateMember with main method - #1427
  • Ignore InstanceOfCheckForException by default for tests. - #1424
  • Respect @Suppress in UnusedPrivateMember - #1423
  • Documentation - using Gradle 5.0, need jcenter() in top-level dependencies block, not just buildscript - #1420
  • Build upon default config for cli module - #1417
  • Better wording when default config isn’t up to date. - #1416
  • UnusedPrivateClass does not consider when class is referenced via ::class.java - #1410
  • Slight tweak to lazy task configuration. - #1407
  • Reformat code base before 1.0 - #1406
  • Introduce script to find and compare differences between two releases - #1405
  • Add a section about how to integrate custom extensions into detekt - #1403
  • Run detekt on detekt-gradle-plugin - #1402
  • Add LabeledExpression ignore label option - #1399
  • Consider double colon references for class usages - Closes #1390 - #1391
  • False positive UnusedPrivateClass when using class references - #1390
  • Fix some issues reported by IntelliJ - #1389
  • Minor improvements to detekt-rules - #1388
  • False positive on UnusedImport when using ‘as’ and the same package - #1385
  • Build upon default config - Closes #1248 - #1384
  • Document api module for 1.0 - #1382
  • false positive EmptyDefaultConstructor for annotation - #1362
  • Update to Gradle v5 - #1350
  • False Positive UnnecessaryApply - #1305
  • LongMethod counts statements but not actual lines as its description says - #1279
  • Build upon the default configuration - #1248

See all issues at: RC13

RC12

Changelog
  • Actually print the exception message next to the stacktrace - #1378
  • Added support for JSR test infrastructure in documentation ruleset - #1377
  • Actually load the manifest to report detekt’s version - #1376
  • fix typo - #1374
  • Drop JDK 9 & 10 from CI - #1371
  • Add EqualsOnSignatureLine - #1370
  • Do not add +1 complexity for nested functions inside functions - #1365
  • Do not report expect’ed annotation classes with an empty constructor … - #1364
  • Add more talks mentioning detekt - #1363
  • false positive EmptyDefaultConstructor for annotation - #1362
  • Mention published url change in the migration guide - #1361
  • Support multiple it refs in UnnecessaryLet (#1359) - #1360
  • Allow multiple ‘it’ references in UnnecessaryLet - #1359
  • Fix link to contributing guideline in PR template - #1358
  • Updated groovydsl version doc - #1353
  • gradle plugin min gradle version - #1352
  • Hide dev flags in CLI - #1351
  • Filter wildcards for type references as they can be null - Closes #1345 - #1349
  • I can’t please detekt and/or ktlint with the following - what’s kotlin idiomatic approach - #1348
  • False positive UnusedPrivateClass in RC11 - #1347
  • UnusedPrivateClass check led to an exception - #1345
  • Added support for JSR test infrasture in performance ruleset - #1343
  • Added SwallowedException ignore type config - #1342
  • RC10 not published? - #1339
  • Allow to exclude labeled return statements - #1317 - #1336
  • Updated kotlin version to 1.3.10 - #1332
  • Don’t publish Gradle plugin to Bintray - #1161
  • ComplexMethod false positive for returning anonymous inner class - #1037

See all issues at: RC12

RC11

Migration
  • The –input parameter is no longer required. If it is missing, the current working directory is used instead.
Changelog
  • Update docs dependencies due to security issues - #1337
  • Fixes #1319 - false positive for UnusedImports - #1335
  • Update appveyor.yml to support jdk11 - #1334
  • Updated ObjectPropertyNaming privatePropertyPattern - fixes #1331 - #1333
  • ObjectPropertyNaming defaults do not match Kotlin style guide - #1331
  • Supports @this expr in extension functions - #1328
  • Added first prototype for compiling test snippets - #1327
  • Swallowed exception update - #1326
  • Removed todo without description - #1323
  • Added tests for excludeClassPattern in NamingRules - #1322
  • Ignores interfaces in NestedClassesVisibility - fixes #1075 - #1321
  • False positive for UnusedImports - #1319
  • Option to only build reports on failure - #1318
  • Update detekt-gradle-plugin version - #1315
  • Ignore TooGenericExceptionCaught by default for tests. - #1312
  • Update README with “detektPlugins” configuration. - #1311
  • Add license scan report and status - #1310
  • New Rule: UnusedPrivateClass - #1309
  • Use current working directory if –input parameter is not specified. - #1308
  • Set current directory as default input path - #1301

See all issues at: RC11

RC10

Migration

The configurations in the Detekt Gradle Plugin have changed to align the Plugin further with other static analysis plugins. Similar to FindBugs the Detekt Gradle Plugin now defines two configurations: detekt and detektPlugins.

  • detekt is now used to define detekt dependencies such as the detekt-cli.
  • detektPlugins is used to define custom detekt RuleSets and rules such as the detekt-formatting rules

To define custom detekt extensions or to add the detekt-formatting rules you will now have to define them as:

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

The report id plain has been renamed to txt. If you were using --report "plain:/tmp/plaintxt" before it’s now --report "txt:/tmp/plaintxt".

The --filters argument no longer checks on the absolute path of files, but rather relative paths to the project root.

The published url changed slightly. So users using the old way of applying plugins need to change their gradle setup:

buildscript {
  repositories {
    jcenter()
    maven { url "https://plugins.gradle.org/m2/" }
  }
  dependencies {
    // https://mvnrepository.com/artifact/gradle.plugin.io.gitlab.arturbosch.detekt/detekt-gradle-plugin 
    // for version <= 1.0.0.RC9.2
    classpath "gradle.plugin.io.gitlab.arturbosch.detekt:detekt-gradle-plugin:[version]"
    // https://mvnrepository.com/artifact/io.gitlab.arturbosch.detekt/detekt-gradle-plugin?repo=gradle-plugins
    // for version >= 1.0.0-RC10
    classpath "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:[version]"
  }
}

apply plugin: "io.gitlab.arturbosch.detekt"
Changelog
  • Update regex for private properties in ObjectPropertyNaming to be on pare with intellij - #1303
  • Get rid of jdk classes - #1302
  • Clarification on Use Cases/Limitations - #1300
  • Drop kotlin-dsl plugin from detekt-gradle-plugin - #1298
  • Ask for Gradle version with bug reports - #1297
  • Upgrade to Kotlin 1.3.0 - #1296
  • Ignore FunctionMaxLength by default for tests. - #1293
  • Typealiases for RuleId and RuleSetId - #1292
  • Generate test coverage report and upload to Codecov - #1291
  • Drop FunctionMinLength & FunctionMaxLength - #1290
  • Fix a simple typo in TooManyFunctions rule’s description text - #1289
  • [WIP] [POC] Config based aliases - #1287
  • Question: drop kotlin-dsl dependency from Gradle plugin? - #1286
  • Add test coverage report for detekt project - #1285
  • Add test case for reported false positive - #1264 - #1284
  • Depend on open jdk and include openjdk11 - #1282
  • Drop rules that ktlint implements - #1281
  • Readd missing detekt-rules dependency for cli to avoid NOP detekt run - #1280
  • Change the way we locate and filter Rules - #1278
  • Gradle plugin: print path reports in output - #1277
  • MagicNumber: Allow 300 by default. - #1275
  • Added tests for PropertyNaming rules - #1274
  • Updated MethodOverloading message - fixed #1223 - #1273
  • Show error messages for unused properties distinguish (#1243) - #1272
  • No BuildFailure for create-baseline - #1271
  • Add rule for detecting arrays of primitive types in function parameters - #1270
  • Split UnnecessaryApply tests - #1269
  • Consider variable to be this prefixed - Closes #1257 - #1268
  • Remove duplicate configurations for reports. - #1267
  • Update ktlint - #1266
  • [Gradle] Don’t fail the build if baseline file is missing - #1265
  • false positive unused import - #1264
  • Remove unused baseline - #1263
  • detektBaseline task returns failure on success - #1261
  • Fix formatting issues - #1259
  • Fix formatting issues - #1258
  • VarCouldBeVal false positive - #1257
  • Use PathFilter in TestPattern to make patterns OS independent - #1256
  • Run detekt-formatting plugin on detekt itself - #1255
  • Travis: oraclejdk10 > openjdk10 - #1254
  • Use detekt formatting plugin on detekt - #1252
  • Issue with Travis build on JDK 10 - #1251
  • Change –filters argument to only check relative paths - #1250
  • Add missing reports {} closure in docs - #1247
  • Removed MaximumLineLength - #1246
  • Fixed #1238 - MethodOverloading false positive - #1244
  • Improve err message for UnusedPrivateMember distinguish between property/param etc. - #1243
  • run travis build on windows and linux - #1241
  • AppVeyor: Disable Kotlin’s incremental build support - #1240
  • AppVeyor: Disable Kotlin incremental compilation - #1239
  • MethodOverloading false positive if extension function for different receiver - #1238
  • [RFC] activateAll config flag - #1236
  • fix test-pattern to support windows path separator - #1234
  • Exclude external functions from unused parameter check. - #1232
  • AppVeyor: Timeout before deleting Gradle lock file - #1231
  • AppVeyor: w: The ‘-d’ option with a directory destination is ignored because ‘-Xbuild-file’ is specified - #1230
  • Add unnecessary apply rule - #1229
  • Suppress UNUSED_PARAMETER should work as well - #1228
  • false positive UnusedPrivateMember for external function - #1227
  • CliArgs Doc Change - #1225
  • MethodOverloading with wrong line - #1223
  • create one detekt task per sourceset - #1220
  • [WIP] AppVeyor: Save Gradle cache to the AppVeyor build cache - #1218
  • AppVeyor fails downloading dependencies - #1217
  • Unsafe cast is wrong - #1216
  • Allow for additional aliases to @Suppress rules - #1215
  • UnnecessaryApply rule - #1214
  • Migrate JUnit tests to Spek - #1213
  • Filters apply to absolute paths not relative paths - #1212
  • fix gradle plugin link - #1211
  • fix gradle plugin link - #1210
  • Build: build detekt-cli before running detekt tasks - #1207
  • [gradle plugin] test code refactoring - #1205
  • Revert “Re-add additional empty check for report paths” - #1204
  • Add new style multi-option issue templates - #1203
  • clarify error message in verify documentation task - #1202
  • Documentation verification requires committing changes but that’s not clear - #1199
  • Rule Explicit it lambda parameter - #1197
  • Do not detect parameter name violations in overridden function - #1196
  • Fatal error on the android project - Unable to find method ‘org.gradle.api.tasks.TaskContainer.register - #1195
  • [gradle-plugin] use lazy evaluation of properties - #1194
  • Implement lazy configuration for Gradle plugin - #1193
  • Revert “Revert “Update dependencies”” - #1192
  • Revert “Update dependencies” - #1191
  • Change PathSensitivity to RELATIVE - #1190
  • Use new GitHub Issue Templates - #1189
  • remove gitlab CI config - #1188
  • explicitly give KtTestCompiler a filename ending in .kt - #1187
  • make OptionalUnit ignore functions in interfaces - #1186
  • update kotlin to v1.2.71 - #1185
  • Rename Plain reporting to Txt. - #1184
  • Allow importing just detekt-gradle-plugin into IDE - #1183
  • Update dependencies - #1182
  • Gradle Plugin: If tasks are configured eagerly configuration from DetektExtension isn’t used - #1181
  • Fix build failing to compile on master - #1180
  • Master is broken - #1179
  • Detekt should not use PathSensitivity.ABSOLUTE for Detekt task - #1178
  • Re-remove kotlin-reflect dependency - #1177
  • OptionalUnit triggers on a default method in an interface - #1176
  • FunctionParameterNaming false positive - #1175
  • Migrate all assertions to AssertJ - #1174
  • rename configurations of Gradle Plugin to detekt and detektPlugins - #1173
  • CI: Test on Java 10 - #1172
  • Gradle configuration not respecting configuration in RC9.2 - #1171
  • Choose single assertion library and test engine - #1170
  • ObjectPropertyNaming should to flag const properties that are not simple types - #1167
  • Architecture Compliance Rule - #1164
  • Fix typo on getting started docs pages - #1163
  • Detekt Gradle Plugin Configurations - #1162
  • Gradle Plugin Portal “latest” version incorrect - #1159
  • In Travis CI: “0 kotlin files were analyzed.” - #1158

See all issues at: RC10

RC9.2

Migration

Please update to this bug fix version of RC9 as it contains many essential and important fixes for the new gradle plugin. Also take a look at the migration section of RC9 if you are < RC9.

Changelog
  • Revert change to ignoreNamedArguments - Closes #1115 - #1157
  • Rename config and id of ConfigAware - #1156
  • Add test case for parameter annotations - Closes #1115 - #1155
  • use correct instance of valueOrDefault in FormattingRule - #1154
  • Make config property in Rule effectively private - #1153
  • Use correct accessor method for config in LazyRegex - #1152
  • print test outcome for debugging during the build - #1150
  • Fix Gradle Plugin Tests - #1148
  • Prevent overwriting of defaultDependency detekt-cli by additional detekt dependencies - #1147
  • Fix issue with wrong report name - #1145
  • Set group to Detekt task - #1144
  • Running RC9 gradlew detekt crashes with detekt-formatting included - #1143
  • The IntelliJ IDEA plugin does not define the settings from the Gradle - #1142
  • RC9 creates files called “C” with tags inside - [#1141](https://github.com/arturbosch/detekt/issues/1141)
  • Sample / demo code? - #1140
  • Reimplement watch service - #1139
  • RC9 not working with gradle 4.4 - #1136
  • Fix issue when multiple input files are specified - #1134
  • Nested functions not reported by FunctionNaming - #1133
  • #1122/Add tests for ObjectPropertyNaming for private val overrides - #1130
  • #1120/Ignore naming of overridden functions and properties - #1129
  • Upload JUnit test results to AppVeyor - #1128
  • 1125/Allow spaces in CLI filters param - #1127
  • detektCheck starts failing - Was passed main parameter ‘–output’ but no main parameter was defined in your arg class - #1126
  • Spaces around separators in CLI input filters break filters - #1125
  • HTML report created at the wrong place - #1123
  • ObjectPropertyNaming/privatePropertyPattern not loaded from configuration - #1122
  • Missing GitHub release & tag for RC9 - #1121
  • FunctionNaming should exclude overridden functions - #1120
  • Use plugin version as default Detekt version - #1119
  • Remove hardcoded default version in Detekt Gradle Plugin - #1118
  • Documented version not available in gradle plugins - #1117
  • MagicNumber regression with RC9 in Annotation methods - #1115
  • IndexOutOfBoundsException when changing –output to –report with RC9 - #1114
  • Updated contributors list - #1112
  • update Gradle to v4.10.1 - #1109
  • Print stacktraces recursively - Closes #1107 - #1108
  • Detektor doesn’t print stack trace causes which makes debugging difficult - #1107
  • Delete a bunch of files from the docs directory - #1106
  • use KtImportDirective instead of KtImportList for ForbiddenImport - #1105
  • Reference vcsreader repo via GrabResolver - Fixes #1101 - #1104
  • org.vcsreader:vcsreader:1.1.0 does not exist - #1101

See all issues at: RC9.2

RC9

Migration

You need Gradle 4.9 or higher to migrate to RC9.

With RC9, which is the last major release candidate before 1.0.0, a new gradle plugin gets introduced. The detekt extension configuration changes a bit and the concept of profiles was removed. There is no detektCheck task anymore, just a detekt task which is incremental and is bound to the check task. Now the detekt plugin must be applied to every project and just analyzes Kotlin files in the source set of this project.

An important change is that detekt-gradle-plugin does not pull the latest version which is found online but has a hardcoded version by default. This can break your current setup if you have not specified a version = "..."" property! Furthermore this version property got now removed and the new toolVersion property is used to specify the underlying detekt tool version. This was done to be inline with other static analysis tools.

Instead of writing

detekt {
    defaultProfile { // or profile("main") {...}
        // properties
    }
}

we now write

detekt {
    // properties
}

If we want all our sub projects to get analyzed by detekt, something like

 subprojects {
    detekt {
        // properties
    }
 }

can be applied to the root build file.

A full detekt configuration for multi-module gradle project could look like detekt’s own build file. Attention(!) this must be translated to groovy if you do not use the kotlin-dsl.

plugins {
	id("io.gitlab.arturbosch.detekt") version "[1.0.0.RC9]"
}
...
subprojects {
    ...
	apply {
		plugin("io.gitlab.arturbosch.detekt")
		...
	}

	val userHome = System.getProperty("user.home")

    detekt {
        debug = true
        toolVersion = usedDetektVersion
        config = files(
                project.rootDir.resolve("detekt-cli/src/main/resources/default-detekt-config.yml"),
                project.rootDir.resolve("reports/failfast.yml")
        )
        filters = ".*/resources/.*,.*/build/.*"
        baseline = project.rootDir.resolve("reports/baseline.xml")

        reports {
            xml.enabled = true
            html {
                enabled = true
                destination = project.rootDir.resolve("reports/detekt.html")
            }
        }

        idea {
            path = "$userHome/.idea"
            codeStyleScheme = "$userHome/.idea/idea-code-style.xml"
            inspectionsProfile = "$userHome/.idea/inspect.xml"
            report = "project.projectDir/reports"
            mask = "*.kt"
        }
}

Make sure that all properties expecting a path expect a FileCollection or a File type now. The config property now explicitly tells the user that detekt can consume multiple configuration yaml files (config = files(…)).

There is also a breaking change for the detekt-cli module which will attack custom gradle task and cli users. The output and reports options are no longer. There is the new --report option which can be used multiple times to generate specific reports. The report pattern now is --report [report-id:path-to-store-report]. There are three provided output reports named: plain, xml and html. Custom reports can be added to leveraging the detekt extension mechanism as described on the website.

Changes
  • fix false positive in UnnecessaryParentheses - #1098
  • remove duplicated detekt in readme - #1097
  • use debug flag for printing outputs in gradle plugin - #1096
  • update documentation to use new detekt gradle plugin - #1095
  • remove img/ directory and link to docs images - #1094
  • Update “Features” section of the README.md and documentation - #1093
  • Allow to use kotlin.Any? - #1085 - #1092
  • UnnecessaryAbstractClass: Support exclusion via Annotations. - #1091
  • Auto deploy SNAPSHOT versions. - #1088
  • MaxLineLength: Ignore comments that end with a long url. - #1087
  • Move Issue template & Pull Request template into .github directory. - #1086
  • EqualsWithHashCodeExist false positives - #1085
  • Feature #1047 OptionalUnit - #1084
  • Replace Regex with LazyRegex in Rules - #1083
  • Invalid line value on TrailingWhitespace error with gradle - #1082
  • Lazy regex evaluation on Rules - #1080
  • Merge gradle plugin rework - #1079
  • Fixed typo line:35 from diffently to differently - #1076
  • Stuff RC8 - #1074
  • Fixed #1065 - ThrowingExceptionsWithoutMessageOrCause assert - #1073
  • re-add useJUnitPlatform - #1071
  • MaxLineLength should ignore link only comments by default - #1070
  • Detekt MagicNumber ignoreHashCodeFunction on by default - #1069
  • MaxLineLength should ignore import statements by default - #1068
  • NoTabs Ignore in strings - #1067
  • ThrowingExceptionsWithoutMessageOrCause false positive - #1065
  • Unknown exception thrown when running detekt - #1064
  • Juggling between CollapsibleIfStatements and ComplexCondition - #1063
  • Make “ComplexMethod” rule also ignore “return when” if configured - #1062
  • Improvement #1055 MagicNumber - #1061
  • Improvement #1056 TooGenericExceptionCaught - #1060
  • Add ForbiddenVoid rule - #1059
  • Forbid usage of Void - #1058
  • DetektCheck only for git commiting files? - #1057
  • TooGenericExceptionCaught should not be reported if the name is ignored - #1056
  • False positive with MagicNumber on default value for parameters - #1055
  • ComplexMethod should treat “return when” as “single when” expression when ignoring - #1054
  • CLI description says only single config file supported - #1053
  • Reworked NoTabs rule - #1052
  • False positive: Unnecessary parentheses for functions with two function parameters - #1051
  • Fixed #932 - Updated documentation for configuring detekt using kotlin-dsl - #1050
  • Fix #1043 UtilityClassWithPublicConstructor - #1049
  • Reworked UnconditionalJumpStatementInLoop - #1048
  • OptionalUnit - lone Unit statement - #1047
  • Add ParameterNaming rules for Constructors and Functions parameters - #1046
  • Cannot generate baseline file - #1044
  • Detekt reports classes with only constructors as UtilityClassWithPublicConstructor - #1043
  • Fixed #1039 - Indentation and MaximumLineLength configuration paramet… - #1042
  • RC8 patch - Updated rule config option and description - #1041
  • Changing indentation settings is not effective - #1039
  • Fixes Gradle plugin badge version - #1038
  • Update LabeledExpression to support outer class refs - #1036
  • Removed FeatureEnvy test case - #1035
  • OptionalUnit update - #1034
  • Fix incorrect line number in TrailingWhitespace - #1033
  • Fix RuleProvider - #1032
  • Update kotlin version to 1.2.60 - #1031
  • TrailingWhitespace reports incorrect line number - #1030
  • Tests are not run when using the CLI - #1029
  • Fix #1027 - FunctionOnlyReturningConstant - #1028
  • FunctionOnlyReturningConstant false positive for interfaces with default implementations - #1027
  • Refactor ObjectPropertyNaming - #1026
  • InstanceOfCheckForException being too general - #1025
  • Add serialVersionUID to UnusedPrivateMember.allowedNames - #1024
  • Ignore tabs in raw strings (“””) for NoTabs? - #1023
  • InstanceOfCheckForException being too general - #1022
  • How to run “autoCorrect” - #1021
  • Fix typo in KDoc of UnnecessaryAbstractClass - #1020
  • Windows 10 : getting error while configuring detekt plugin - #1019
  • Analyze issue #1014 - #1018
  • Mr/gradle classes - #1017
  • Change description of TopLevelPropertyNaming rule - #1015
  • ‘super.visitNamedDeclaration()’ is not invoked in the short-circuit case - #1014
  • Replace // with # in yaml code - #1013
  • Activate rules in failfast.yml part3 - #1004
  • UnnecessaryParentheses: Allow to use parenthesis when in math expression with mixed operators - #969
  • 1.0.0-RC7-2 is not published to gradlePluginPortal() - #967

See all issues at: RC9

RC8

  • Prepare rc8 - #1011
  • Feature ‘aliases documentation’ - #1008
  • Add another missing space - #1006
  • Add a missing space - #1005
  • Add prefix wildcard to SplitPattern - #1002
  • Specify both prefix and suffix wildcard for ForbiddenImport pattern - #1001
  • Flag empty nested functions - fixes #998 - #999
  • EmptyFunctionBlock should flag empty functions defined inside other functions - #998
  • UnusedImports: Add test for inner classes in same package - #997
  • Refactor ProfileStorage to be no singleton anymore - Fixes #980 - #996
  • Fix false positive lambda in constructor call - Fixes #990 - #995
  • Fix magic number report for named constructor calls - Fixes #992 - #994
  • magic number ignoreNamedArgument not working with inheriting abstract class - #992
  • Fix to work on maven multi-module project - #991
  • False positive UnnecessaryParentheses on constructors with lambdas - #990
  • UnusedImports: Add detection of imports in same package - #989
  • Document formatting rule set - Closes #925 - #988
  • Use ktlint for selfanalysis - #987
  • Refactor UnusedImports rule - #986
  • UnusedImports: False negative when importing class in same package - #985
  • Update kotlin version to 1.2.51 - #984
  • UnusedPrivateMember rule in abstract functions - #983
  • Mention –run-rule option and get_analysis_projects script - #982
  • Activate rules in failfast.yml part2 - #981
  • Detekt RC 7-3 checks the wrong Gradle module - #980
  • Add aliases to rules’ documentations - #979
  • New rule: VarCouldBeVal - #978
  • Fix ExpressionBodySyntax when multiline expression - #977
  • ExpressionBodySyntax: false positive with includeLineWrapping in multiline expression - #976
  • Activate rules in failfast.yml - #975
  • UnusedPrivateMember: do not report unused parameters in abstract/open functions - #973
  • UnusedPrivateMember: Incorrectly reports unused params in open/abstract functions - #972
  • Use detekt 7-3 in self analysis - #971
  • UnnecessaryParentheses false positive when using extension function with default parameter - #927
  • Running ktlint formatting on every build - #823

See all issues at: RC8

RC7-3

  • UnusedPrivateMember: detect top level declarations - #968
  • Support suppression of single instances of MaxLineLength violations - #966
  • Fix SerialVersionUIDInSerializableClass when value’s less then zero #964 - #965
  • SerialVersionUIDInSerializableClass reports when const value less then true - #964
  • Fixed #960 - private properties naming report - #963
  • Allow “All” in @Suppress statements - #962
  • TopLevelPropertyNaming description reports wrong regex with private properties - #960
  • Migrate detekt-formatting/build.gradle to Kotlin DSL - #958
  • Allow maxLines option for ExpressionBodySyntax - #957
  • Updated kotlin compiler to version 1.2.50 - #956
  • WildcardImport: Remove one force unwrap and reuse it from let function - #955
  • Use native junitPlatform from gradle 4.6 - #953
  • Fix #950 ExpressionBodySyntax - #952
  • Gradle native junitplatform in detekt gradle plugin project - #951
  • Prepare RC7-3 release - #949
  • Rule: find unused private top level properties, constants or functions - #948
  • Suppress undocumented classes in dokka - #947
  • Do not crash on rule exceptions - #793 #944 - #946
  • Provide signing config for bintray - #345 - #945
  • Exclude private functions for TooManyFunctions rule - #943
  • Add a space between two words - #942
  • MaybeConst tests - #938
  • Respect string interpolation - Closes #808 - #937

See all issues at: RC7-3

RC7-2

  • Generate javadocJar for maven central publishing - #345 - #934
  • TooManyFunctions : Add option to ignore private functions - #933
  • Fixed some IntelliJ inspection warnings in test cases - #931
  • Fixed MayBeConst false negative when concatenating strings #900 - #930
  • Remove #807 workaround - #929
  • Fix divergent issues with UnsafeCasts rule on windows - Closes #926 - #928
  • Divergent behaviour for UnsafeCast rule on *nix & Windows - #926
  • Build Gradle plugin using composite build - #924
  • Extended documentation - #923
  • Don’t treat ‘input’ and ‘output’ parameters to Gradle as an InputDirectory/OutputDirectory - #922
  • Build Gradle plugin using a composite build - #920
  • CI: Test Windows build on Java 9 - #919
  • CI: Improve Windows testing - #918
  • Added missing message to CollapsibleIfStatements rule - #917
  • Support more range expressions in ForEachOnRange rule - #916
  • Support more range expressions in ForEachOnRange rule (downTo, step, until etc.) - #915
  • Add rule for preferring to syntax for creating pairs - #914
  • Upgrade to Gradle 4.7 - #913
  • Style rule: Prefer to over Pair - #912
  • Add style rule for mandatory braces for control flow statements - #911
  • Applied allowedNames in UnusedPrivateMember to declarations - #910
  • UnusedPrivateMember – allowedNames is not applied to properties - #909
  • Updated StringLiteralDuplication to treat multiline string parts as 1 - #908
  • Added support for special handling in RethrowCaughtException - #907
  • RethrowCaughtException Usage - #906
  • VariableNaming not working after 1.0.0.RC5-6 - #905
  • StringLiteralDuplication - 3/3 - [toString] unclear error - #904
  • Adjust terminal output in case there’s only one file. - #903
  • Updated MatchingDeclarationName with typealias - #901
  • MatchingDeclarationName with typealias - #898
  • Exclude ForEachOnRange in default config for test-pattern. - #897
  • Make website/documentation link more prominent - #896
  • Print link to html report in console on check fail - #894
  • 0 kotlin files were analyzed while running on concourse - #889
  • Link to documentation for new ‘maxIssues’ config property - #887
  • ./gradlew detektBaseline fails with “Creating a baseline.xml requires the –baseline parameter to specify a path.” - #886
  • Add “FunctionName” alias for suppressing “FunctionNaming” rule - #882
  • CompositeConfig does not allow forcing the default value - #881
  • False positive with OptionalAbstractKeyword - #879

See all issues at: RC7-2

RC7

  • Add functionname alias - #884
  • Make executor in detekt configurable - #862 - #883
  • Add missing ` character to exception ruleset docs - #878
  • Updated kotlinVersion to 1.2.40 - #874
  • Gradle plugin - can’t run detektCheck with JDK 9 - #873
  • Adjust top level property naming to be on pair with intellij - #866 - #872
  • Splitted positve and negative test cases - #871
  • Spaces around colon - #870
  • Corrected “Allowed Maximum” message - #868
  • Ignored deprecated functions for TooManyFunctions rule - #867
  • Allow top level properties to be named as constants - #866
  • Migrate detekt-gradle-plugin/settings.gradle to Gradle DSL - #864
  • Migrate detekt-gradle-plugin/settings.gradle to Kotlin DSL - #863
  • Incorrect “Allowed Maximum” message - #861
  • Detekt task always runs on the same module - #860
  • Ignore deprecated functions for TooManyFunctions rule - #859
  • Fixes #857 - Fixes UselessPostfixExpression false positives - #858
  • UselessPostfixExpression false positives - #857
  • Additional cli options for printing AST’s and running single rules - #856
  • Implement detekt-formatting, a wrapper over ktlint - #855
  • detekt-cli tests - #851
  • Splitted test cases for NamingRulesSpec - #850
  • Added option to exclude comments from MaxLineLength - #849
  • Allow underscore as ignored exception name in EmptyCatchBlock - #848
  • Implement script to download given analysis projects - #847
  • Set up pipeline to test new detekt rules/features on selected kotlin projects - #846
  • Add dependencies for gradle plugin (for custom rules) - #845
  • Should ObjectPropertyNaming have a constantPattern? - #844
  • VariableMinLength is in the wrong category - #843
  • MatchingDeclarationName behavior results in false positives. - #841
  • Fix false positives in unused private members - #840
  • Use absolute paths in console output to make them clickable - #839
  • [Console Output] Change all file paths from relative to absolute - #838
  • False positive for UnnecessaryParentheses - #836
  • Fixed #783 - OptionalAbstractKeyword false positive - #835
  • Added rule debt to documentation - #834
  • Update mention of git commit hook in CONTRIBUTING.md - #833
  • Do not write deprecated build fail properties to default config file - #831
  • Fix debt reporting in console report - #830
  • Update kotlin to v1.2.31 - #829
  • Build depends on a full download of IntelliJ - #827
  • Extract intellij plugin to its own repository - #826
  • Updates Readme with corrected links to RuleSets documentation - #825
  • Added threshold change to changelog - #824
  • Threshold changed when updating from RC6-3 to RC6-4 - #822
  • Migrate detekt/build.gradle to kotlin dsl - #821
  • Migrate detekt-sample-extensions/build.gradle to kotlin dsl - #820
  • Fixed #816 - webpage documentation generator - #819
  • NestedClassesVisibility doesn’t detect violation for object - #817
  • potential-bugs web page is broken - #816
  • Commit hook - #815
  • NestedClassesVisibility doesn’t detect violation for “object” - #814
  • UnusedPrivateMember false positives - #812
  • deprecation message is printed even when warningThreshold and failThreshold are not used - #811
  • Added naming ruleset to RC6-3 migration guide - #810
  • 1.0.0.RC6-3 changelog migration block is incomplete - #809
  • Add Novoda static analysis plugin to readme - #806
  • Added filepath to console output when generating reports - #805
  • Updated EmptyFunctionBlock rule - #804
  • Updated debt report - #803
  • When generating reports it would be nice if the path would be printed out as well - #801
  • False negatives for EmptyFunctionBlock with overridden functions - #800
  • Updated rule debt values - #776
  • WIP: Detekt IntelliJ Plugin - #773

See all issues at: RC7

RC6-4

  • NoSuchElementException when running from build.gradle.kts - #793
  • No files analysed if path contains test - #792
  • Does detekt include copy/paste detector ? - #789
  • @Suppress(“MaxLineLength”) at file-level doesn’t work - #788
  • Update test dependencies and publish versions - #787
  • Bitrise step to run detekt - #785
  • Add no tabs rule - #782
  • Added test case for EmptyCatchBlock rule - #781
  • Add trailing whitespace rule - #780
  • EmptyCatchBlock.allowedExceptionNameRegex doesn’t seem to be useful - #779
  • Incorrect behavior for EqualsAlwaysReturnsTrueOrFalse - #778
  • Thresholds rework - #774
  • Implemented EndOfSentenceFormat to support urls as last argument - #772
  • Fixed report of unnecessary parentheses when assigning a lambda to a val - #770
  • TopLevelPropertyNaming ease UPPER_CASE notation on vals - #769
  • EndOfSentenceFormat does not work well with urls. - #768
  • UnnecessaryParentheses false positive when copying with a function - #767
  • Added excludeClassPattern for VariableNaming rule - #765
  • Add class name exclusion or pattern exclusion for VariableNaming rule - #764
  • update kotlin to v1.2.30 - #763
  • update gradle to v4.6 - #762
  • Remove useTabs from sample Maven config in README - #761
  • Change exceptions property to throwable - #109 - #760
  • Overriding defaults throws java.util.ConcurrentModificationException - #758
  • Rule: Unnecessary brackets - #756
  • What do you think about making configuration type safe? - #755
  • 0 kotlin files were analyzed Android Setup. - #754
  • Space before curly brackets - #753
  • Fix in yaml syntax - #752
  • Added ignoreSingleWhenExpression config for ComplexMethod rule - #750
  • Generate documentation inside website folder - #746
  • Removed obsolete OptionalReturnKeyword rule - #745
  • add task inputs/outputs to detektCheck task - #743
  • define inputs/outputs for detekt-generator task - #742
  • Fixes for .kts files - #741
  • EqualsAlwaysReturnsTrueOrFalse for multiple returns - #740
  • Getting EqualsAlwaysReturnsTrueOrFalse incorrectly (I think) - #738
  • add messages to all CodeSmells - #737
  • Added allowedExceptionNameRegex config for EmptyCatchBlock - #736
  • Extend EmptyCatchBlock - #734
  • Add MayBeConst rule - #733
  • Simplify SingleAssign by using lateinit and add tests for it - #732
  • Style rule: val constants can be declared as const - #731
  • Allow aliases for rules to allow for suppression - #730
  • More idiomatic build configuration - #729
  • Ignored classes with supertype entries from UnnecessaryAbstractClass - #728
  • Handle @Suppress(“UNCHECKED_CAST”) for UnsafeCast rule - #726
  • The “detektCheck” Gradle task is never UP-TO-DATE - #725
  • Fixed incorrect behavior of EmptyDefaultConstructor - #723 - #724
  • EmptyDefaultConstructor incorrect behavior - #723
  • OptionalReturnKeyword incorrect behavior - #722
  • Fix message for TooGenericExceptionCaught - #720
  • Gradle plugin rework - new dsl - #719
  • Corrected documentation in EnumNaming - #717
  • EnumNaming should also allow digits - #716
  • External dependency ‘detekt-cli’ not found when using Gradle plugin in submodule - #713
  • Quickfixes API - #710

See all issues at: RC6-4

Migration
  • changed threshold definition (value >= threshold instead of value > threshold)
  • build failure threshold properties are now deprecated in favor of the new maxIssues property.
  • warningThreshold and failThreshold will get removed in a later release, a deprecation warning is printed to the console.
build:
  warningThreshold: 5 // deprecated
  failThreshold: 10 // deprecated
  maxIssues: 10

RC6-3

  • Improve documentation of sample project - #438 - #712
  • Added tests for naming rules - #711
  • Gradle Plugin: Expose a copy of profiles - #709
  • update gradle to v4.5 - #708
  • EmptyClassBlock should not be reported for objects deriving from superclasses - #707
  • remove FeatureEnvy class - #706
  • Tooling: Accessing the profiles defined by the user - #705
  • make detekt-cli tests depend on updated documentation/config - #704
  • KDocStyle MultiRule with EndOfSentenceFormat Rule - #703
  • Add documentation for style rules - #702
  • Add documentation for complexity rules - #701
  • [Question] How to reference to a version of the plugin in the main project before it’s even published? - #700
  • Rule: KDoc’s first sentence should have a proper end - #699
  • Added documentation for naming rule set - #697
  • update kotlin to v1.2.20 - #696
  • Added excludeAnnotatedClasses to UseDataClass - #694 - #695
  • Consider adding excludeAnnotatedClasses to UseDataClass. - #694
  • Fix compliant case for UntilInsteadOfRangeTo rule - #693
  • Documentation generator truncates config descriptions - #692
  • Documentation generator truncates some configuration descriptions - #691
  • Introduce “naming” ruleset - #690
  • Sort Rules in Config & Documentation alphabetically - #689
  • Default configuration file should be sorted alphabetically - #688
  • Fix MatchingDeclarationName false positives - #687
  • MatchingDeclarationName has false positives - #686
  • UtilityClassWithPublicConstructor reports classes with delegates - #682
  • ComplexMethod rule question - #680
  • generator: anchor tags are lower case; TOC links to CamelCase - #678

See all issues at: RC6-3

Migration
  • ATTENTION!! The default configuration now uses an alphabetical order. We apologize for any inconveniences this might cause.
  • Introduced naming ruleset containing
    • Naming Rules (min/max length, naming regex rules, forbidden name)
    • MatchingDeclarationName
    • MemberNameEqualsClassName
  • Fixed false positives in UtilityClassWithPublicConstructor, MatchingDeclarationName and EmptyClassBlock
  • make sure to rerun your baseline (if you ignored some of these)!

RC6-2

  • Updates two rules to detect violated range expressions outside of loops - #684
  • Add UntilInsteadOfRangeTo rule - #676
  • Implement MatchingDeclarationName rule - #674
  • Consider adding ignoreOptionalParameters to LongParameterList - #673
  • Fix false negative reporting of non-named argument - Fixes #659 - #672
  • Change LateInitUsage to LateinitUsage in failfast.yml - #671
  • Rule: ‘rangeTo’ or the ‘..’ call can be replaced with ‘until’ - #670
  • Treat all compiler warnings as errors - #669
  • Do not run EmptyFunctionBlock on open functions - #667
  • EmptyFunctionBlock should not flag functions with open modifier - #666
  • Do not run EmptyClassBlock on objects of anonymous classes - #665
  • MatchingDeclarationName rule to match single declaration to file name - #664
  • Rename *.yaml to *.yml so fixtures use expected line endings - #661
  • Appveyor: Use default git config - #660
  • ignoreNamedArguments breaks marking non-named magic number params - #659
  • Run tests on Travis on Oracle JDK 8 & 9 - #658

See all issues at: RC6-2

Migration
  • The new rule MatchingDeclarationName is active on default. If a file has only one top-level declaration then the file name must match the declaration name according to the jetbrains and android style guides.

RC6-1

  • Added factory function check to MemberNameEqualsClassName - #653
  • detekt generator tests - rc6 - #650
  • Rule examples improvement - #649
  • Improved documentation for rule test cases - #648
  • Apply compiler and baseline changes to work properly on java 9 - #647
  • Test coverage rc6 - #645
  • Implements #643 - MagicNumber ignores default values in ctor properties - #644
  • update gradle to v4.4.1 - #642
  • Documentation for Exceptions RuleSet - #640
  • Documentation for “emtpy” rules - #639
  • Documentation for documentation rules - #638
  • Change variable min & max length to match IntelliJ. - #635
  • Remove “native filesystem” warning on Windows - #634
  • Failed to initialize native filesystem for Windows - #630

See all issues at: RC6-1

Migration
  • Running detekt under Java 9 should work again with newest Kotlin Version
  • Ignores default values in constructor properties (MagicNumber) - #644

RC6

  • Allow numbers in ClassNaming. - #631
  • Renamed MethodNameEqualsClassName to support properties - #629
  • Allow detekt to run on kts too. - #628
  • Updated kotlin compiler version - #625
  • Add TooManyFunctions to test-pattern exclude-rules by default. - #624
  • Consider adding TooManyFunctions to the test-pattern exclude-rules - #622
  • Added rule documentation to CONTRIBUTING.md - #621
  • Merged CHANGELOG.md and MIGRATION_GUIDE.md - #620
  • Do not depend on a specific project path in core classes - #605 - #619
  • Consider merging CHANGELOG.md and MIGRATION_GUIDE.md - #618
  • remove migration module - #617
  • Removed code-smell ruleset - #616
  • Remove CodeSmell RuleSet - #615
  • Remove migration module - #614
  • Allow checks on Kotlin script files (.kts) - #612
  • compliant and non-compliant code examples documentation - #610
  • Error message agrees with require condition - #609
  • False positive in ExceptionRaisedInUnexpectedLocation - #608
  • Update dependencies - #607
  • Checkout *.md, *.yml & *.html with LF line endings - #606
  • Allow –input to handle multiple paths - #605
  • update documentation after some merges to master - #604
  • README: Remove copy of default-detekt-config.yml - #603
  • HtmlOutputFormatTest tests assume Unix-style line endings - #602
  • add gradle task to assert config and documentation are generated up-to-date - #601
  • update CONTRIBUTING.md to take detekt-generator behavior into account - #600
  • ReturnCount augmented to ignore specified function names - #599
  • Add SpreadOperator to exclude-rules in test-pattern. - #598
  • update gradle to v4.4 - #597
  • DetektCli depends on kotlin-compiler-embeddable which pulls in older version of json-org-java - #596
  • Turn off comments over private function/property - #589 - #595
  • removes active mark for StringLiteralDuplication - #594
  • Replace default-detekt-config.yml with generated one - #593
  • TooManyFunctions description could be improved - #592
  • Automatically run detekt-generator on detekt-rules build task - #590
  • Add documentation to generate default config - #589
  • Add documentation in bugs rules - #588
  • Remove InterruptedException from TooGenericExceptionCaught rule - #587
  • InterruptedException is too generic - #586
  • detekt-generator code examples - #584
  • Add OutputReport implementation that generates an HTML report - #583
  • Fix my blogpost title in the README :) - #582
  • detekt-generator: content section - #579
  • README: Update description of the ‘output’ parameter for the Gradle plugin - #578
  • Output is a folder and not a file anymore - #577
  • add detekt-generator module to generate documentation and default config - #563
  • Add message to CodeSmell - #480
  • Generate default-detekt-config.yml according to rules - #189

See all issues at: RC6

Migration
  • We are now generating documentation for all rule sets. They are stored as markdown files and will later be hosted on the official detekt website.
  • rename MethodNameEqualsClassName to MemberNameEqualsClassName (rule checks also properties now)
  • CHANGELOG.md and MIGRATION.md are now merged. The changelog now has also a migration subsection.
  • Numbers are now allowed in class names (aligned to IntelliJ inspections) - ClassNaming-Rule
  • If you are using the text or xml output option of detekt, consider also the new html output format.
  • The --input cli property now supports multiple paths separated by a comma.
  • TooManyFunctions and SpreadOperator rules are turned off for test files per default.

RC5-6

  • update Kotlin to v1.1.61 - #573
  • rules-test-rc5 - #571
  • UnsafeCast: Fix in SpacingBetweenPackageImports, turn on rule, add present to baseline - #570
  • Rework naming rules to match intellij inspections - #569
  • 1.0.0-RC5-5 org.jetbrains.kotlin.psi.KtProperty cannot be cast to org.jetbrains.kotlin.psi.KtClassOrObject - #568
  • housekeeping_rules - #565

See all issues at: RC5-6

Migration
  • fixed a critical bug in SpacingBetweenPackageImports, please update if you use this rule.
  • Aligned naming conventions rules to meet intellij inspections.
    • ConstantNaming got removed
    • TopLevelPropertyNaming and ObjectPropertyNaming was added
    • there are now configuration parameters for private properties
  VariableNaming:
    active: true
    variablePattern: '[a-z][A-Za-z0-9]*'
    privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*'
  ObjectPropertyNaming:
    active: true
    propertyPattern: '[A-Za-z][_A-Za-z0-9]*'
  TopLevelPropertyNaming:
    active: true
    constantPattern: '[A-Z][_A-Z0-9]*'
    propertyPattern: '[a-z][A-Za-z\d]*'
    privatePropertyPattern: '(_)?[a-z][A-Za-z0-9]*'

RC5-5

  • Add –plugins option to gradle plugin - Fixes #545 - #561
  • Rewrite messages and issue description for TooManyFunctions rule - #552 - #560
  • Run built snapshot also on test sources - #559
  • TooManyFunctions message can be misleading - #552
  • Added UnnecessaryAbstractClass without body detection - #551
  • UnnecessaryAbstractClass: misses class without body - #550
  • Use newer extension syntax in example for Kotlin DSL and add in expli… - #549
  • improve message of PackageDeclarationStyle - #548
  • Update to Kotlin 1.1.60 - #546
  • Using plugin rulesets in Android project - #545

See all issues at: RC5-5

Migration
  • TooManyFunctions rule got a rework. Old property threshold was replaced with:
    • thresholdInFiles: 10
    • thresholdInClasses: 10
    • thresholdInInterfaces: 10
    • thresholdInObjects: 10
    • thresholdInEnums: 10

RC5-4

  • Testcase refactoring - #527 - #541
  • Build improvements - #539
  • Allow throwing exceptions in init blocks - closes #537 - #538
  • ExceptionRaisedInUnexpectedLocation in constructer - #537
  • UnnecessaryAbstractClass takes primary constructor vals into account - #535
  • UnnecessaryAbstractClass does not see member variables - #534

See all issues at: RC5-4

RC5-3

  • MaxLineLengthRule line number reporting issue - #526
  • Fixed #522 - CollapsibleIf must not have a if-else child - #525
  • Implemented #523 - open function option FunctionOnlyReturningConstant - #524

See all issues at: RC5-3

RC5-2

  • Enhancement #514 - #519
  • Test cases RC5 - #511
  • Prepend project name to findings path - #171 - #510
  • Do not apply rule filters on main sources - #509
  • WildcardImport should support regex exclusions - #506

See all issues at: RC5-2

Migration
  • rule filters which are defined in the test-pattern were applied to main sources too, this is now fixed.

RC5

  • Remove double check in condition - #505
  • Update README for failFast option - #502
  • Allow to suppress StringLiteralDuplication on class level - closes #442 - #494
  • Restrict Postfix operators to ++ and – - closes #491 - #493
  • If formatting rule - #489
  • README: update sample output from the tool - #488
  • Remove stale rules from config files - #487
  • Minor: Use toX instead of java.lang.x.parseX - #486
  • Yml config test - #484
  • don’t report UselessPostfixExpressions on fields in return expressions - #483
  • ignore “_” named variables for VariableNaming and VariableMinLength - #482
  • VariableNaming and VariableMinLength: Exclude simple Underscore from Rule - #481
  • Refactored all detekt-config tests - #478
  • Fix for #465 - #477
  • Rule:NestedClassVisibility update - #474
  • Added DetektYamlConfigTest - #472
  • Redundant modifier rule - #470
  • MethodNameEqualsClassName rule - #469
  • reword detekt timing message and use measureTimeMillis - #468
  • Processors test - #463
  • Added static declaration count to ComplexInterface - #461
  • Apply java-gradle-plugin to detekt-gradle-plugin - #460
  • Test pattern - #227 - #459
  • correcly handle imports used in KDoc tags in UnusedImports rule - #458
  • More false positive for unused imports - #457
  • Enum constant parameter flagged for MagicNumber - #455
  • remove default description of modifier order rule - #454
  • update gradle to v4.2.1 - #453
  • ModifierOrder has wrong description - #452
  • update kotlin to v1.1.51 - #450
  • Add AnnotationExcluder to be able to reuse exluding by annotation mechanism. - #447
  • Nested class, interface or enum shouldn’t be publicly visible - #446
  • Nested class, interface or enum shouldn’t be publicly visible - #444
  • RuleProviderTest and cleanup of test-cases - #443
  • Suppressing string duplication doesn’t work - #442
  • Complexity rules: ComplexInterface + MethodOverloading - #440
  • Fixed #435 - false-positive for UseDataClass rule - #439
  • Config refactoring - #436
  • FalsePositive for UseDataClass on enum and annotation classes - #435
  • DataClassContainsFunctions - allow conversion function - #434
  • Exception rules modification - #432
  • Update FunctionNaming regex to work for sentences - #425
  • Added SerialVersionUIDInSerializableClass rule - #424
  • Update “MagicNumber” to not mark “Named Arguments” as code smells - #415
  • Support idea tasks also for windows - closes #413 - #414
  • IDEA inspections does not work under Windows - #413
  • Use the default-config.yml as default configuration - #412
  • Get warning when rule is not defined - #407
  • Remove formatting module - #406
  • Add .editorconfig - #401
  • Add a Gitter chat badge to README.md - #400
  • Correct mccabe complexity calculation - closes #396 - #399
  • Update to Gradle 4.1 - #398
  • Open gitter for easier interaction with users - #395
  • Fixed #389 in ProtectedMemberInFinalClass rule - #392
  • False positive ProtectedMemberInFinalClass - #389
  • Ignore sealed classes for UseDataClass rule check - #387
  • Use case specific descriptions in UnnecessarySuperTypeDeclaration - #386
  • Loop rules - #385
  • Test improvement - #383
  • Add additional FileProcessListener event - #381
  • Unnecessary supertype declaration - #380
  • Address some IntelliJ lint & Kotlin compiler warnings - #378
  • Do not flag empty functions which are meant to be overridden - #376
  • Deprecate formatting - #326
  • Introduce config based way of skipping certain rules for test classes - #227

See all issues at: RC5

Migration
  • Formatting rule set was removed. Use the detektIdeaFormat task, KtLint or wait for the official kotlin format tool which will be released soon (Hadi mentioned it in a reply to a tweet somewhere).
  • McCabe calculation was corrected and can now be slightly higher which can result in unexpected ComplexMethod findings.
  • Instead of using a pattern like .*/test/.* to filter test sources, you can now specify a test-pattern inside a configuration. This allows to turn off specific rules or rule sets for test sources.

RC4-3 - Second bugfix release for RC4 with a bunch of new contributed rules!

  • UndocumentedPublicClass: Fix enum support - #375
  • add rule to forbid certain class names - #374
  • Tests are not executed anymore but skipped! - #373
  • Use failfast configuration in CI - #372
  • Added break and continue to unreachable code rule - #371
  • A few more exception rules - #370
  • Added UnnecessaryAbstractClass rule - #369
  • remove spaces in default-detekt-config.yml - #368
  • Advanced exception rules - #366
  • Added PackageDeclaration style rule - #364
  • Implement Data class rule - #354
  • Feature/data class rule - #353
  • Extend naming ruleset - #302
  • Data class rule - #263

See all issues at: RC4-3

RC4-2 - Bugfix release for RC4

  • Bugfix FunctionMaxLength typo - #367
  • Fixed protected member report in sealed class - #362
  • Renamed UselessIncrement to UselessPostfixExp - #360
  • Bugfix/variable max length const - #359
  • UndocumentedPublicClass: Add searchInInnerObject configuration property. - #358
  • fix link to default-detekt-config.yml in migration guide for RC4 - #357

See all issues at: RC4-2

RC4

  • Do not use reflection for toString methods - closes #349 - #351
  • Detekt Gradle plugin breaks the Gradle properties task - #349
  • Decouple KtTreeCompiler from Detektor - #341 - #348
  • fix README to mention the renamed –plugins instead of –rules - #346
  • Decouple KtTreeCompiler, KtCompiler from Detektor - #341
  • Reimplement thrown-/catched exception rules - #95 - #334
  • Reimplement throw-/catch-exception-rules as MultiRules - #332
  • remove unnecessary parentheses in the main codebase - #330
  • Added packagePattern option to config - #329
  • add rule to detect Unnecessary Parentheses - #328
  • PackagePattern in naming conventions - #327
  • align naming patterns for enum entries in rule + default config - #325
  • allow suppressing all - #324
  • Combine all empty block rules into one multi rule - #95 - #322
  • Refactored tests and increased coverage - #321
  • Refactor Naming rules and add Variable/Function length rules - #320
  • Added protected member in final class rule - #317
  • [Poll] Do people care about separated EmptyXXXBlock, ThrowXXX and CatchXXX rules? - #95

See all issues at: RC4

Migration
  • CatchXXX and ThrowXXX rules were reimplemented and combined into TooGenericExceptionCatched and TooGenericExceptionThrown rules. Own exceptions can be added to the list.
  • EmptyXXXBlock rules were reimplemented and can be turned off individually
  • The rule NamingConventions was reimplemented and now every case is separately configurable and new cases were added

See default-detekt-config.yml

RC3

  • Do not consider empty returns as OptionalReturnKeyword - #314
  • Added % to comment-source ratio output - #309
  • Add rules property for multirule - #308
  • Use function instead of method in descriptions and ids of CommentOver… - #307
  • update kotlin to v1.1.4 - #306
  • OptionalReturnKeyword: Fails with expressions - #304
  • Treat comment as non-empty block body - #303
  • Added StringLiteralDuplication rule - #300
  • Added naming rule for packages - #299
  • Update used detekt to RC2 - #298
  • Equals() smells - #297

See all issues at: RC3

Migration
  • MagicNumber rule has now different ignore properties

RC2

  • Remove magic numbers and other detekt issues - #295
  • Ignore based on checkstyle for MagicNumber - #289
  • Revert implementation configuration in cli module - #283
  • Run cli on ci - #282
  • Variables/Properties declaring numbers shouldn’t be flagged for MagicNumber - #280
  • Added UnnecessaryConversionTemporary rule - #279
  • More metrics - #277
  • MagicNumber rule throw report for null initialized variable - #276
  • Improve build setup - #275

See all issues at: RC2

Migration
  • Make sure to upgrade! RC2 fixes a number of MagicNumber’s issues and adds properties to make this rule more configurable.

RC1

  • Allow to override the output name of output reports - #272
  • Rewrite sample project featuring processors, reports and rule sets - #268
  • Update detekt-sample-ruleset - #257
  • Fix input flag for standalone gradle task in README - #256
  • Added rule for safe cast to config.yml - #254
  • LateInitUsage: One annotation match is enough to let the property be ignored. - #245
  • Exclude extensions by id or priority - #243
  • Plugins & Extensions - #242
  • Rule: ModifierOrder - #239
  • Added metrics for packages and kt files - #238
  • Added metrics for classes, methods and fields - #237
  • Fix –project mention in README. - #236
  • Use newest detekt with failfast profile in CI - #234
  • Added rule for safe cast instead of if-else-null - #233
  • Terminal Output customization - #171
  • Change Main.rules to something like ‘jars’ or ‘plugins’ - #134
  • FileProcessListener’s should be loaded through a ServiceLoader - #101

See all issues at: RC1

Migration
  • Attention: new MagicNumber and ReturnCount rules can let your CI fail
  • Sample project now reflects all possible custom extensions to detekt, see extensions section in README
  • --output points to a directory now. This is due the fact that many output reports can be generated at once
  • Each OutputReport specifies a file name and ending. The parameter --output-name can be used to override the default provided file name of the OutputReport. Unnecessary output reports for your project can be turned off in the configuration.

M13.2

  • Always use the ‘main’ profile as default even if ‘profile’ parameter set but a profile with name ‘main’ exists - #231
  • Fix DetektGenerateConfigTask to use –input instead of –project. - #230
  • Run Detekt on Detekt #212
  • Extend UndocumentedPublicClass with searchInNestedClass, searchInInnerClass & searchInInnerInterface properties. - #210

See all issues at: M13.2

M13.1

  • LateinitUsage: Add ignoreOnClassesPattern property. - #226
  • Implement ForbiddenComment Rule. - #225
  • Add Excludes to WildcardImport rule reusing logic from LateinitUsage - #224
  • Excluding specific imports from the WildcardImport rule - #223
  • Anonymous classes should not be checked for documentation - #221
  • Provide a test case for custom rule sets - #220
  • Update Detekt to 1.0.0.M13 and add usedDetektVersion to gradle.properties. - #218
  • Change gradle task parametr ‘rulesets’ to ‘ruleSets’ - #216
  • UndocumentedPublicClass for anonymous classes - #213
  • rename dept to debt - #211
  • LateInitUsage: Ignore this rule in tests - #207
  • change cli parameter –project (-p) to –input (-i) - #206
  • Meaning of Dept - #205
  • Add new line to each kotlin file. - #204
  • Fix unused import false positive in kdoc - closes#201 - #203
  • False positive UnusedImports - #201
  • Add Tests for WildcardImport and NamingConvention rules - #200
  • Allow package matching via excludeAnnotatedProperties in LateinitUsage Rule. - #199
  • UndocumentedPublicClass false positive with annotations - #194
  • Rule TodoComment - #182
  • Rule NewlineAtEndOfFile - #181
  • Fail fast approach / configuration - #179
  • Rule: SpreadOperator - #167
  • Not providing a detekt-closure or profile should not crash the gradle-plugin but instead just use the default profile - #166

See all issues at: M13.1

Migration
  • Misspelled class Dept was renamed to Debt, if you using custom rule sets, please rebuild it
  • CLI parameter --project was renamed to --input to match the input parameter of the gradle plugin

M13

  • Add missing unit test for Int.reached. - #191
  • Add failFast option to the configuration. - #186
  • Convert single line methods to Expression Bodys. - #185
  • Fix issue when default config should from the resources by the cli - #178
  • Rule: SpreadOperator - #177
  • Update readme, contributors, changelog, migration guide for M13 - #176
  • Rule: Expression with label - #175
  • Rule: Report unsafe call on nullable types - #174
  • Rule: Expression with label - #173
  • Rule: Report unsafe call on nullable types - #172
  • Fix off by one error in Int.reached regarding SmellThreshold. - #170
  • Set the group to verification on all gradle tasks. - #168
  • Fix a typo in CHANGELOG.md - #165
  • Update kotlin version to 1.1.3-2 - closes #124 - #164
  • Added missed brackets to repository name in readme - #163
  • Rule: Find usages of forEach on Ranges - #161
  • Running formatting checks without formatting the code on CI - #159
  • Remove lateinit usage in Main.kt - #156
  • Rule: Report forEach usages on Ranges - #155
  • More descriptions to for most rules - #154
  • Always show the absolute number of code smells - #152
  • Use the latest version in gradle-plugin as default - #151
  • Turn off auto correction for sonar analysis - #147
  • Fix AppVeyor badge in README.md - #146
  • README: Fix various issues with variables in code examples - #142
  • add descriptions to rules in style, empty, exceptions - #140
  • Remove lateinit in project property in Main class - #132
  • Should rule providers have their own package or live in the according package - #131
  • Issue descriptions for each rule (also displayed in Detekt way - sonar plugin) - #110

See all issues at: M13

M12.1 & M12.2 & M12.3 & M12.4

  • Convert Kotlin source code strings to Unix line endings - #137
  • Simplify reading resource files - #136
  • [WIP] Windows support - #135
  • M12.1 fails with “URISyntaxException: Illegal character in authority at index 7” under windows - #128
  • Rule to find lateinit usages - #127
  • Wrong link format in Changelog - #121
  • Setup appveyor for windows builds - #118
  • Duplicate main profile - #116
  • Referring to custom detekt.yml config results in InvalidPathExceptionon Windows - #115
  • MaxLineLength should allow excluding import and package statements - #111
  • Rule: Prohibit usage of lateinit - #106
  • Use the latest version in gradle-plugin as default - #151
  • False positive for EmptyFunctionBlock with overriden function - #151

See all issues at: M12.2

M12

  • Suppress for TooManyFunctions is not considered in detekt - #108
  • Update documentation and migration guide for M12 - #105
  • NoDocOverPublicClass always reported for objects - #104
  • Script to generate release notes from milestone - #102
  • Encapsulate common fields of Rule and Finding in Issue class - #97
  • Separate findings logic from rule logic - #93
  • Add support for composable configurations - #92
  • ClassCastException: java.lang.Integer cannot be cast to java.lang.String - #89
  • Baseline does not work anymore as expected due to inner restructure for the new output formats - #83
  • Prevent ClassCastExceptions in Configurations - #82
  • Migrate away from load() method in tests - #77
  • Support any common report file format - #66
  • Not all return keywords are removed when using ExpressionBodySyntax quickfix - #58
  • Rule: Max line length - #56
  • Rule: SingleExpression statements with multiple return paths - #45
  • Allow different naming conventions for tests - #24

See all issues at: M12

Migration
CLI
  • No break just extra notification that you can pass now more than one configuration file within the --config and --config-resource parameters

This allows overriding certain configuration parameters in the base configuration (left-most config)

Gradle Plugin
  • the detekt extension is now aware of configuration profiles
  • non default or ‘main’ profile, needs to be specified like gradle detektCheck -Ddetekt.profile=[profile-name]

Instead of writing something like

detekt {
    version = "1.0.0.M11"
    input = "$project.projectDir/src"
    filters = '.*/test/.*'
    config = "$project.projectDir/detekt-config.yml"
    output = "$project.projectDir/output.xml"
    idea {
        path = "$userHome/.idea"
        codeStyleScheme = "$userHome/.idea/idea-code-style.xml"
        inspectionsProfile = "$userHome/.idea/inspect.xml"
        mask = "*.kt,"
    }
}

you have to put a profile-closure around the parameters

detekt {
    profile("main") {
        version = "1.0.0.M11"
        input = "$project.projectDir/src"
        filters = '.*/test/.*'
        config = "$project.projectDir/detekt-config.yml"
        output = "$project.projectDir/output.xml"
    }
    profile("test") {
        filters = ".*/src/main/kotlin/.*"
        config = "$project.projectDir/detekt-test-config.yml"
    }
    idea {
        path = "$userHome/.idea"
        codeStyleScheme = "$userHome/.idea/idea-code-style.xml"
        inspectionsProfile = "$userHome/.idea/inspect.xml"
        mask = "*.kt,"
    }
}

This allows you too configure detekt-rules specific for each module. Also allowing to have different configurations for production or test code.

Renamings
  • NoDocOverPublicClass -> UndocumentedPublicClass
  • NoDocOverPublicMethod -> UndocumentedPublicFunction

Rename this id’s in your configuration

M11

  • False positive SpacingAfterKeyword - #71
  • Embedabble compiler - #70
  • Support for Android? Failed to apply plugin [id ‘com.android.application’] - #69
  • Add gradle task to integrate idea formatting/inspection - #67
  • Crash when detekt.yml is empty - #64
  • Add Support For GSK - #59
  • Decouple/Rewrite/Publish smell-baseline-format - #57
  • Export Config with --generate-config - #54
  • Support indentation formatting in different formats (X spaces, x spaces for tabs etc) - #53
  • NestedBlockDepth: Elif-Structure counts as two - #51
  • Generate default yaml configuration on cli flag - #48
  • Support @Suppress(“ALL”) - #47
  • [WIP] Formatting rework - #46
  • Rule: Expression-syntax line breaks - #36
  • Rule: Expression syntax - #35
  • Allow Indentation check to handle “align when multiline” option - #25
  • SpacingAroundCurlyBraces throw IndexOutOfFound when determinating Location.of(node) as LineAndColumn calculation is simple wrong (of Idea?) - #18

See all issues at: M11 See all issues at: Formatting

Migration
  • detekt task was renamed to detektCheck (gradle-plugin)
  • empty rule set was renamed to empty-blocks rule set

M10

  • detekt-gradle-plugin - #16
  • experimental migration module which can migrate imports- #30
  • NamingConventionViolation is now aware about backticks - contributed by Svyatoslav Chatchenko
  • cli and core module refactorings, jcenter publishing, travis ci
  • gradle-plugin version is not configurable, task configurations should be in afterEvaluate - #41
  • Add Contributing Guide - #37
  • NamingConventionViolation is now aware about backticks “`” - #34

See all issues at: M10 See all issues at: M10.1

Migration
  • code-smell rule set was renamed to complexity rule set (config)

M9

  • Support suppressing rules (@SuppressWarnings, @Suppress) - #6
  • Allow easier navigation in README - #24

See all issues at: M9

M8, M8.1

feature
  • Introduce complexity ruleset - #4
  • Provide a new screenshot showing detekt in action #13
  • Update Readme/Rulesets for changes in code-smell/complexity rulesets #14
  • NamingConventionViolation should allow customization #20
bugs fixed
  • Prevent division by zero (thx @olivierlemasle)

See all issues at: M8

M7

defect
  • Remove NoElseInWhenExpression rule #10
feature
  • As an user I want to give more weight to some rule sets than to others - #83
  • Integrate debug rule set provider into cli - #70
feedback
  • [Test] Analyze Kotlin project (30.000+ KtFiles) - #85
improvement
  • Consider other than BodyExpression expressions inside current rules - #1
release
  • As an user I want to get more often releases to try out the new stuff - #87
  • Update to kotlin 1.0.6 - #84
  • Update to kotlin 1.1.1 - #2
  • Get rid of hamkrest - #9

See all issues at: M7

M6

New features
  • allow to fail builds on code smell thresholds (configurable), see ‘Configure build failure thresholds’ in README
  • blacklist code smells which are false positives
  • generate a baseline whitelist of code smells if your project is already old and has many smells, so only new smells are shown in analysis (see ‘Code Smell baseline and ignore list’ in README)
Improvements
  • move formatting to own rule set project as formatting works great on my kotlin projects but line/column calculation from within PsiElements is wrong (!?)
  • OptionalUnit and -Semicolon should be auto correctable and moved to formatting
  • show progress while waiting for the analysis

See all issues at: https://gitlab.com/arturbosch/detekt/milestones/6

M5

  • Threat variables in object declarations as constants too - #67
  • Normalize file content prevents some exceptions inside Psi - #66
  • Fix an “Underestimated text length” problem inside Psi - #65
  • Filter top level members from LargeClass and EqualsWithHashCode rules, preventing NoSuchElementExceptions - #64

In this milestone the goal was to fully be able to analyze the Kotlin project. All rule sets (except formatting) successfully run now. Formatting needs some fixes as line and column values are sometimes not correctly determined by the AST.

One idea of mine is to threat formatting as an extern rule set and only allow auto correcting the source code without an report to skip line/column problem.

More issues: https://gitlab.com/arturbosch/detekt/milestones/5

M4

  • Rewrite UnusedImport-rule to fix deleting infix extension function imports - #60
  • Cli flag: –parallel to compile all kotlin files in parallel, use when your project has more than 1000+ files, detection is always parallel - #46
  • Cli flag: –format (–useTabs) to allow formatting of your source code without a detekt configuration file. All formatting rules are turned off except indentation with spaces if –useTabs is used - #54

More issues: https://gitlab.com/arturbosch/detekt/milestones/4

M3

  • exceptions rule set (Too generic Exceptions thrown/catched)
  • potential bugs rule set (EqualsWithHashCode, DuplicateCaseInWhen, ExplicitGarbageCollectionCall, NoElseInWhen)
  • Ported formatting rules of KtLint (Credits to Shyiko)

More issues: https://gitlab.com/arturbosch/detekt/milestones/3

M2

  • yaml configuration of rules
  • empty rule set (empty block statements)
  • include detekt in your projects

More issues: https://gitlab.com/arturbosch/detekt/milestones/2

M1

  • Command line interface
  • RuleSetProvider plugin system
  • code smell rule set
  • style rule set

More issues: https://gitlab.com/arturbosch/detekt/milestones/1