Deprecate TrailingComma as it's now split in two rules (#5423)

* Deprecate `TrailingComma` as it's now split in two rules * Add deprecation to DeprecatedPrinter
detekt · Oct 23, 2022 · 7697efd · 7697efd
1 parent 3b406e2
commit 7697efd
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/detekt-core/src/main/resources/deprecation.properties b/detekt-core/src/main/resources/deprecation.properties
@@ -13,6 +13,7 @@ style>UnnecessaryAbstractClass>excludeAnnotatedClasses=Use `ignoreAnnotated` ins
 style>UseDataClass>excludeAnnotatedClasses=Use `ignoreAnnotated` instead
 formatting>Indentation>continuationIndentSize=`continuationIndentSize` is ignored by KtLint and will have no effect
 formatting>ParameterListWrapping>indentSize=`indentSize` is ignored by KtLint and will have no effect
+formatting>TrailingComma=Rule is split between `TrailingCommaOnCallSite` and `TrailingCommaOnDeclarationSite` now.
 style>ForbiddenPublicDataClass=Rule migrated to `libraries` ruleset plugin
 style>LibraryCodeMustSpecifyReturnType=Rule migrated to `libraries` ruleset plugin
 style>LibraryEntitiesShouldNotBePublic=Rule migrated to `libraries` ruleset plugin
diff --git a/...erator/src/main/kotlin/io/gitlab/arturbosch/detekt/generator/printer/DeprecatedPrinter.kt b/...erator/src/main/kotlin/io/gitlab/arturbosch/detekt/generator/printer/DeprecatedPrinter.kt
@@ -37,6 +37,7 @@ private fun writeProperty(ruleSet: RuleSetPage, rule: Rule, configuration: Confi
 
 internal fun writeMigratedRules(): String {
     return """
+        formatting>TrailingComma=Rule is split between `TrailingCommaOnCallSite` and `TrailingCommaOnDeclarationSite` now.
         style>ForbiddenPublicDataClass=Rule migrated to `libraries` ruleset plugin
         style>LibraryCodeMustSpecifyReturnType=Rule migrated to `libraries` ruleset plugin
         style>LibraryEntitiesShouldNotBePublic=Rule migrated to `libraries` ruleset plugin