Bump com.pinterest.ktlint:ktlint-cli-reporter from 0.49.1 to 0.51.0-FINAL

[dependabot]

Bumps com.pinterest.ktlint:ktlint-cli-reporter from 0.49.1 to 0.51.0-FINAL.

Release notes

Sourced from com.pinterest.ktlint:ktlint-cli-reporter's releases.

0.50.0

Deprecation of ktlint-enable and ktlint-disable directives

The ktlint-disable and ktlint-enable directives are no longer supported. Ktlint rules can now only be suppressed using the @Suppress or @SuppressWarnings annotations. 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-suppression rule can not be disabled via the .editorconfig nor via @Suppress or @SuppressWarnings annotations.

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.treeCopyHandler extension 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 manipulating ASTNodes there seems to be no impact. When, manipulating PsiElements, some functions consistently result in a runtime exception.

Based on the refactoring of the rules as provided by ktlint-ruleset-standard in Ktlint 0.49.x the suggested refactoring is as follows:

• Replace LeafElement.replaceWithText(String) with LeafElement.rawReplaceWithText(String).
• Replace PsiElement.addAfter(PsiElement, PsiElement) with AstNode.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 the PsiElement.addAfter(PsiElement, PsiElement).
• Replace PsiElement.replace(PsiElement) with a sequence of AstNode.addChild(AstNode, AstNode) and AstNode.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.treeCopyHandler is 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.treeCopyHandler using a flag. This flag is available in the Ktlint CLI and in the KtlintRuleEngine. 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 the KtlintRuleEngine directly, have to set property enableKotlinCompilerExtensionPoint to false.

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.treeCopyHandler is 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

• Add new experimental rule binary-expression-wrapping. This rule wraps a binary expression in case the max line length is exceeded (#1940)
• Add flag to disable extension point org.jetbrains.kotlin.com.intellij.treeCopyHandler to analyse impact on custom rules #1981
• Add new experimental rule no-empty-file for all code styles. A kotlin (script) file may not be empty (#1074)
• Add new experimental rule statement-wrapping which ensures function, class, or other blocks statement body doesn't start or end at starting or ending braces of the block (#1938)
• Add new experimental rule blank-line-before-declaration. This rule requires a blank line before class, function or property declarations (#1939)
• Wrap multiple statements on same line wrapping (#1078)
• Add new rule ktlint-suppression to replace the ktlint-disable and ktlint-enable directives with annotations. This rule can not be disabled via the .editorconfig (#1947)
• Inform user about using --format option of KtLint CLI when finding a violation that can be autocorrected (#1071)

Removed

• Code which was deprecated in 0.49.x is removed. Consult changelog of 0.49.x` released for more information. Summary of removed code:

Fixed

• Do not flag a (potential) mutable extension property in case the getter is annotated or prefixed with a modifier property-naming (#2024)
• Do not merge an annotated expression body with the function signature even if it fits on a single line (#2043)
• Ignore property with name serialVersionUID in property-naming (#2045)
• Prevent incorrect reporting of violations in case a nullable function type reference exceeds the maximum line length parameter-list-wrapping (#1324)

... (truncated)

Changelog

Sourced from com.pinterest.ktlint:ktlint-cli-reporter's changelog.

Changelog

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

[1.4.0] - 2024-10-24

🆕 Features

• Suppress backing-property-naming on @Suppress("PropertyName") - #2741, by @​paul-dingemans

• Check that code can still be parsed after a format - #2742, by @​paul-dingemans

• Support suppressing backing-property-naming via ObjectPropertyName - #2751, by @​Goooler

• Ignore properties starting with _ in backing-property-naming rule - #2753, by @​paul-dingemans

• Suppress backing-property-naming rule with @Suppress("LocalVariableName") - #2785, by @​paul-dingemans

• Do not repeat formatting if file is unchanged - #2805, by @​paul-dingemans

• Add new rule when-entry-bracing - #2829, by @​paul-dingemans

• Add .editorconfig property ij_kotlin_indent_before_arrow_on_new_line - #2838, by @​paul-dingemans

• Add CLI option --stdin-path to provide a virtual file location for stdin - #2836, by @​adecker89

• Add property .editorconfig property ktlint_enum_entry_name_casing - #2839, by @​paul-dingemans

🔧 Fixes

• Prevent line separators to be changed from CRLF to LF - #2752, by @​paul-dingemans

• fix: don't remove arrow from lambdas that are when/if leaf nodes - #2758, by @​tKe

• Fix false positive in no-semi rule for enum class without enum entries - #2774, by @​paul-dingemans

• Prevent conflict between multiline-expression-wrapping and function-signature - #2775, by @​paul-dingemans

• Ignore max_line_length property unless max-line-length rule is enabled - #2783, by @​paul-dingemans

• Fix false positive in class-signature when EOL comment is between a class annotation and other class modifier - #2786, by @​paul-dingemans

• Fix globs ending with ** - #2787, by @​paul-dingemans

• Return exit code 1 in case violations have been found but file is unchanged - #2803, by @​paul-dingemans

• Ignore missing whitespace after trailing comma in single line parameter value list - #2806, by @​paul-dingemans

... (truncated)

Commits

• See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)