Update dependency com.pinterest:ktlint to v0.51.0-FINAL #11
Conversation
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferencesCodacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more Footnotes
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #11 +/- ##
=======================================
Coverage 88.88% 88.88%
=======================================
Files 2 2
Lines 9 9
Branches 1 1
=======================================
Hits 8 8
Misses 1 1 ☔ View full report in Codecov by Sentry. |
This PR contains the following updates:
0.49.0->0.51.0-FINALRelease Notes
pinterest/ktlint (com.pinterest:ktlint)
v0.50.0Compare Source
Deprecation of ktlint-enable and ktlint-disable directives
The
ktlint-disableandktlint-enabledirectives are no longer supported. Ktlint rules can now only be suppressed using the@Suppressor@SuppressWarningsannotations. A new rule,internal:ktlint-suppression, is provided to replace the directives with annotations.API consumers do not need to provide this rule, but it does no harm when done.
The
internal:ktlint-suppressionrule can not be disabled via the.editorconfignor via@Suppressor@SuppressWarningsannotations.Custom Rule Providers need to prepare for Kotlin 1.9
In Kotlin 1.9 the extension points of the embedded kotlin compiler will change. Ktlint only uses the
org.jetbrains.kotlin.com.intellij.treeCopyHandlerextension point. This extension is not yet supported in 1.9, neither is it documented (#KT-58704). Without this extension point it might happen that your custom rules will throw exceptions during runtime. See #1981.In Ktlint, 7 out of 77 rules needed small and sometimes bigger changes to become independent of the extension point
org.jetbrains.kotlin.com.intellij.treeCopyHandler. The impact on your custom rules may vary dependent on the way the autocorrect has been implemented. When manipulatingASTNodes there seems to be no impact. When, manipulatingPsiElements, some functions consistently result in a runtime exception.Based on the refactoring of the rules as provided by
ktlint-ruleset-standardin Ktlint0.49.xthe suggested refactoring is as follows:LeafElement.replaceWithText(String)withLeafElement.rawReplaceWithText(String).PsiElement.addAfter(PsiElement, PsiElement)withAstNode.addChild(AstNode, AstNode). Note that this method inserts the new node (first) argument before the second argument node and as of that is not a simple replacement of thePsiElement.addAfter(PsiElement, PsiElement).PsiElement.replace(PsiElement)with a sequence ofAstNode.addChild(AstNode, AstNode)andAstNode.removeChild(AstNode).Be aware that your custom rules might use other functions which also throw exceptions when the extension point
org.jetbrains.kotlin.com.intellij.treeCopyHandleris no longer supported.In order to help you to analyse and fix the problems with your custom rules, ktlint temporarily supports to disable the extension point
org.jetbrains.kotlin.com.intellij.treeCopyHandlerusing a flag. This flag is available in the Ktlint CLI and in theKtlintRuleEngine. By default, the extension point is enabled like it was in previous versions of ktlint.At least you should analyse the problems by running your test suits by running ktlint and disabling the extension point. Next you can start with fixing and releasing the updated rules. All rules in this version of ktlint have already been refactored and are not dependent on the extension point anymore. In Ktlint CLI the flag is to be activated with parameter
--disable-kotlin-extension-point. API Consumers that use theKtlintRuleEnginedirectly, have to set propertyenableKotlinCompilerExtensionPointtofalse.At this point in time, it is not yet decided what the next steps will be. Ktlint might drop the support of the extension points entirely. Or, if the extension point
org.jetbrains.kotlin.com.intellij.treeCopyHandleris fully supported at the time that ktlint will be based on kotlin 1.9 it might be kept. In either case, the flag will be dropped in a next version of ktlint.Added
binary-expression-wrapping. This rule wraps a binary expression in case the max line length is exceeded (#1940)org.jetbrains.kotlin.com.intellij.treeCopyHandlerto analyse impact on custom rules #1981no-empty-filefor all code styles. A kotlin (script) file may not be empty (#1074)statement-wrappingwhich ensures function, class, or other blocks statement body doesn't start or end at starting or ending braces of the block (#1938). Note, although this rule is added in this release, it is never executed except in unit tests.blank-line-before-declaration. This rule requires a blank line before class, function or property declarations (#1939)wrapping(#1078)ktlint-suppressionto replace thektlint-disableandktlint-enabledirectives with annotations. This rule can not be disabled via the.editorconfig(#1947)--formatoption of KtLint CLI when finding a violation that can be autocorrected (#1071)Removed
0.49.xis removed. Consult changelog of 0.49.x` released for more information. Summary of removed code:Fixed
property-naming(#2024)serialVersionUIDinproperty-naming(#2045)parameter-list-wrapping(#1324)elsebranch when body contains only chained calls or binary expression (#2057)Changed
RuleIdandRuleSetIdclasses. Those classes were defined as value classes in0.49.0and0.49.1. Although the classes were marked with@JvmInlineit seems that it is not possible to uses those classes from Java base API Consumers like Spotless. The classes have now been replaced with data classes (#2041)info.picocli:picoclitov4.7.4org.junit.jupiter:junit-jupitertov5.9.31.8.22and Kotlin version to1.8.22.io.github.detekt.sarif4k:sarif4ktov0.4.0org.jetbrains.dokka:dokka-gradle-plugintov1.8.20v0.49.1Compare Source
Added
Removed
Fixed
--code-style=android_studioin Ktlint CLI identical to deprecated parameter--android(#1982)no-consecutive-blank-lines(#1987).editorconfigpropertyktlint_function_signature_rule_force_multiline_when_parameter_count_greater_or_equal_thanwhen usingktlint_officialcode stylefunction-signature(#1977)indent(#1993)indent(#1976)ktlint_officialcode style to keep formatting of other code styles consistent with0.48.xand beforeindent(#1971)no-single-line-block-commentfromcomment-wrappingrule. Theno-single-line-block-commentrule is added as experimental rule to thektlint_officialcode style, but it can be enabled explicitly for the other code styles as well. (#1980)Changed
Baselinefromktlint-clitoktlint-cli-reporter-baselineso that Baseline functionality is reusable for API Consumers.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 this update again.
This PR was generated by Mend Renovate. View the repository job log.