1.4.0

🆕 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

• Remove HEADER_KEYWORD & IMPL_KEYWORD - #2810, by @3flex

• Function signature rule ignores context receiver when on separate line - #2814, by @paul-dingemans

• Do not remove imports for which the fully qualified path is identical to the package name - #2822, by @paul-dingemans

• Fix indentation of a multiline parameter list inside a function literal for code style ktlint_official - #2823, by @paul-dingemans

• Do not insert a trailing comma in a multiline when-entry containing a guard - #2825, by @paul-dingemans

• Fix wrapping of expression body when max_line_length not set - #2833, by @paul-dingemans

📦 Dependencies

• Update dependency io.github.oshai:kotlin-logging-jvm to v7 - #2701, by @renovate[bot]

• Update dependency org.assertj:assertj-core to v3.26.3 - #2738, by @renovate[bot]

• Update mikepenz/release-changelog-builder-action action to v5 - #2756, by @renovate[bot]

• chore(deps): update plugin kotlinx-binary-compatibiltiy-validator to v0.16.3 - #2759, by @renovate[bot]

• fix(deps): update dependency org.slf4j:slf4j-simple to v2.0.16 - #2764, by @renovate[bot]

• Migrate to com.gradleup.shadow - #2763, by @Goooler

• chore(deps): update gradle/actions action to v4 - #2760, by @renovate[bot]

• chore(deps): update plugin com.gradle.develocity to v3.18.1 - #2792, by @renovate[bot]

• chore(deps): update dependency gradle to v8.10.2 - #2812, by @renovate[bot]

• chore(deps): update plugin shadow to v8.3.3 - #2820, by @renovate[bot]

• fix(deps): update dependency com.github.ajalt.clikt:clikt to v5.0.1 - #2828, by @renovate[bot]

• chore(deps): update kotlin monorepo to v2.0.21 - #2831, by @renovate[bot]

• fix(deps): update dependency org.ec4j.core:ec4j-core to v1.1.0 - #2832, by @renovate[bot]

• fix(deps): update dependency org.jetbrains.kotlin:kotlin-gradle-plugin to v2.1.0-beta2 - #2834, by @renovate[bot]

• fix(deps): update dependency dev.drewhamilton.poko:poko-gradle-plugin to v0.17.2 - #2837, by @renovate[bot]

• fix(deps): update dependency org.junit.jupiter:junit-jupiter to v5.11.3 - #2840, by @renovate[bot]

• chore(deps): update actions/checkout digest to 11bd719 - #2841, by @renovate[bot]

1.3.1

🔧 Fixes

• Add link for backing-property-naming, correct binary-expression-wrapping - #2704, by @rsmith20
• Do not insert a whitespace element as first or last child inside a composite element - #2715, by @paul-dingemans
• Do not rewrite a class to a single line signature in case it contains an EOL comment - #2716, by @paul-dingemans
• Fix false positive when anonymous function is used as value argument - #2718, by @paul-dingemans
• Fix suppression handling when 'formatter:on' not properly specified - #2719, by @paul-dingemans
• Fix false positive when primary constructor has no arguments and a secondary constructor exists - #2717, by @paul-dingemans
• Ignore suppressions for no-unused-imports rule - #2720, by @paul-dingemans
• Ignore suppressions in rule no-unused-imports - #2725, by @paul-dingemans
• Fix false alert Format was not able to resolve all violations which (theoretically) can be autocorrected - #2727, by @paul-dingemans
• Fix "unset" value for property ktlint_chain_method_rule_force_multiline_when_chain_operator_count_greater_or_equal_than - #2728, by @paul-dingemans

📦 Dependencies

• Update dependency gradle to v8.8 - #2680, by @renovate[bot]
• Update plugin com.gradle.develocity to v3.17.5 - #2697, by @renovate[bot]
• Update actions/checkout digest to 692973e - #2699, by @renovate[bot]
• Update dependency io.github.hakky54:logcaptor to v2.9.3 - #2707, by @renovate[bot]
• Update dependency org.junit.jupiter:junit-jupiter to v5.10.3 - #2721, by @renovate[bot]

💬 Other

• Remove sdkman - #2693, by @paul-dingemans

1.3.0

🆕 Features

• Support partial formatting - #2631, by @paul-dingemans

• Suppress property-name rule for ObjectPropertyName or PrivatePropertyName - #2643, by @paul-dingemans

• Let API Consumer decide whether a LintError has to be autocorrected, or not - #2671, by @paul-dingemans

• Promote experimental rules to non-experimental - #2674, by @paul-dingemans

  • backing-property-naming
  • binary-expression-wrapping
  • chain-method-continuation
  • class-signature
  • condition-wrapping
  • function-expression-body
  • function-literal
  • function-type-modifier-spacing
  • multiline-loop

🔧 Fixes

• Do not wrap operation reference after multiline string template - #2591, by @paul-dingemans

• Ignore max line length in case the line contains only a string template followed by a comma - #2598, by @paul-dingemans

• Ignore nested reference expressions in chain-method-continuation - #2606, by @paul-dingemans

• Prevent exception in binary-expression-wrapping rule - #2607, by @paul-dingemans

• Do not merge opening quotes of multiline string template with (single line) function signature - #2609, by @paul-dingemans

• Fix replacement of redundant curly braces - #2617, by @paul-dingemans

• Set and reset Locale to pass test for non-english contributor. - #2622, by @Jaehwa-Noh

• Fix unwanted whitespace between super class constructor and its argument list - #2630, by @tKe

• Fix typo's - #2641, by @paul-dingemans

• Handle trailing space on preceding line in call to lineLengthWithoutNewlinePrefix - #2644, by @paul-dingemans

• Fix KDoc for RuleSetProviderV3 - #2645, by @gumimin

• Fix not checking for spacing around binary operators inside unary expression - #2653, by @cflee

• Fix blank line before declarations rule code example - #2657, by @k-taro56

• Fixed [{ }] notation for issue #2675 - #2677, by @Jolanrensen

• Simplify default properties loading - #2679, by @Goooler

📦 Dependencies

• Update dependency org.jetbrains.dokka:dokka-gradle-plugin to v1.9.20 - #2590, by @renovate[bot]

• Update softprops/action-gh-release action to v2 - #2600, by @renovate[bot]

• Update dependency io.github.detekt.sarif4k:sarif4k to v0.6.0 - #2605, by @renovate[bot]

• Update dependency gradle to v8.7 - #2616, by @renovate[bot]

• Migrate to develocity plugin - #2625, by @Goooler

• Update dependency org.slf4j:slf4j-simple to v2.0.13 - #2632, by @renovate[bot]

• Update gradle/wrapper-validation-action action to v3 - #2633, by @renovate[bot]

• Update dependency io.github.oshai:kotlin-logging-jvm to v6.0.9 - #2634, by @renovate[bot]

• Update dependency com.github.ajalt.clikt:clikt to v4.4.0 - #2647, by @renovate[bot]

• Update kotlin monorepo to v1.9.24 - #2649, by @renovate[bot]

• Update plugin com.gradle.develocity to v3.17.4 - #2660, by @renovate[bot]

• Update dependency dev.drewhamilton.poko:poko-gradle-plugin to v0.15.3 - #2662, by @renovate[bot]

• Update actions/checkout digest to a5ac7e5 - #2664, by @renovate[bot]

• Update dependency org.assertj:assertj-core to v3.26.0 - #2669, by @renovate[bot]

1.2.1

🆕 Features

None

🔧 Fixes

• Mark new rules as experimental - #2579, by @paul-dingemans
• Fix null byte as default value for "--pattern-from-stdin" - #2580, by @paul-dingemans
• Fix handling of "--reporter" CLI parameter - #2581, by @paul-dingemans

1.2.0

🆕 Features

WARNING: The new rules have accidentally not been marked as experimental. This will be fixed in a bugfix!

• Break dependency between string-template-indent and multiline-expression-wrapping - #2505, by @paul-dingemans

• Allow string template to exceed max line length when it is the only element on a line - #2480, by @paul-dingemans

• Add configuration setting for ignoring argument-list-wrapping above treshold of argument - #2481, by @paul-dingemans
  NOTE: In code style ktlint_official this threshold is unset so that arguments are always wrapped. If this impacts your code too much, you can make it backward compatible by setting .editorconfig property ktlint_argument_list_wrapping_ignore_when_parameter_count_greater_or_equal_than to value 8. For other code styles this property is initialized with value 8 and as of that backward compatible by default.

• Ignore EOL comment that causes max_line_length to be exceeded, except in max-line-length rule - #2516, by @paul-dingemans

• Add new rule for disallowing KDoc at non-whitelisted locations - #2548, by @paul-dingemans

• Improve insert of suppression - #2546, by @paul-dingemans

• Ignore modifier of backing property in android_studio code style - #2552, by @paul-dingemans

• Add rule to check spacing around square brackets 'square-brackets-spacing' - #2555, by @paul-dingemans

• Add rule blank-line-between-when-conditions - #2564, by @paul-dingemans

🔧 Fixes

• Prevent IllegalArgumentException in argument-list-wrapping rule - #2500, by @paul-dingemans

• Ignore function which is returned as result in a function body - #2526, by @paul-dingemans

• Fix false positive newline expected before comment in enum - #2527, by @paul-dingemans

• Report violation when parameter list is preceded by a comment - #2541, by @paul-dingemans

• Ignore EOL comments in value-argument-comment and value-parameter-comment - #2551, by @paul-dingemans

• Do not indent string template starting at first position of line - #2553, by @paul-dingemans

• Prevent conflict when curly closing brace is followed by range (until) operator - #2554, by @paul-dingemans

• Run argument-list-wrapping after function-signature - #2568, by @paul-dingemans

• Ignore simple reference expressions in chain-method-continuation - #2569, by @paul-dingemans

📦 Dependencies

• chore(deps): update plugin org.gradle.toolchains.foojay-resolver-convention to v0.8.0 - #2503, by @renovate[bot]

• fix(deps): update dependency io.github.oshai:kotlin-logging-jvm to v6 - #2440, by @renovate[bot]

• Replace gradle/gradle-build-action@v3 with gradle/actions/setup-gradle@v3 - #2518, by @paul-dingemans

• chore(deps): update plugin kotlinx-binary-compatibiltiy-validator to v0.14.0 - #2522, by @renovate[bot]

• chore(deps): update gradle/wrapper-validation-action action to v2 - #2523, by @renovate[bot]

• chore(deps): update ffurrer2/extract-release-notes action to v2 - #2515, by @renovate[bot]

• chore(deps): update dependency gradle to v8.6 - #2531, by @renovate[bot]

• fix(deps): update dependency org.assertj:assertj-core to v3.25.3 - #2536, by @renovate[bot]

• fix(deps): update dependency org.junit.jupiter:junit-jupiter to v5.10.2 - #2534, by @renovate[bot]

• fix(deps): update dependency org.slf4j:slf4j-simple to v2.0.12 - #2538, by @renovate[bot]

• fix(deps): update dependency org.codehaus.janino:janino to v3.1.12 - #2559, by @renovate[bot]

💬 Other

• Simplify BOM exclude list - #2476, by @Goooler

• 2550 clikt - #2556, by @paul-dingemans

1.1.1

🆕 Features

None

🔧 Fixes

• Fix incorrect generateEditorConfig example in documentation - #2444, by @stay7

• Fix insert of suppression on binary expression - #2463, by @paul-dingemans

• Loosen dependency between chain-method-continuation and argument-list-wrapping - #2468, by @paul-dingemans

• Keep arrow when both parameter list and block of function literal are empty - #2469, by @paul-dingemans

• Improve wrapping of binary expressions - #2479, by @paul-dingemans

• Resolve conflict between parameter-list-spacing and parameter-list-wrapping - #2491, by @paul-dingemans

• Do not wrap binary expression value argument if it is already preceded by a newline - #2493, by @paul-dingemans

• Fix operator spacing - #2473, by @paul-dingemans

• Run argument-list-wrapping, class-signature and function-signature when comment rules are disabled - #2466, by @paul-dingemans

📦 Dependencies

• fix(deps): update kotlin monorepo to v1.9.22 - #2456, by @renovate[bot]

• chore(deps): update actions/setup-python action to v5 - #2417, by @renovate[bot]

• fix(deps): update dependency org.slf4j:slf4j-simple to v2.0.10 - #2470, by @renovate[bot]

• fix(deps): update dependency dev.drewhamilton.poko:poko-gradle-plugin to v0.15.2 - #2485, by @renovate[bot]

• fix(deps): update dependency org.assertj:assertj-core to v3.25.1 - #2486, by @renovate[bot]

1.1.0

🆕 Features

• Compile with java 21 instead of 20 - #2320, by @paul-dingemans

• Improve checking on backing property - #2346, by @paul-dingemans

• Add multiline-loop to complement multiline-if-else - #2298, by @hendraanggrian

• Add "UnusedImport" as @Suppress alias - #2357, by @paul-dingemans

• Allow backing property to be correlated to a public function - #2356, by @paul-dingemans

• Add helper function 'fromSnippetWithPath' to create a Code instance - #2359, by @paul-dingemans

• Support logging and exception throwing when loading baseline - #2362, by @paul-dingemans

• Allow factory methods to use generics, and to overload other factory … - #2366, by @paul-dingemans

• Remove dependencies on discouraged-comment-location rule - #2371, by @paul-dingemans

• Ignore imports for rangeUntil in no-unused-imports rule - #2376, by @paul-dingemans

• Ignore imports for assign in no-unused-imports rule - #2382, by @paul-dingemans

• Ignore invalid function names when importing from "junit.framework" - #2386, by @paul-dingemans

• Add experimental rules condition-wrapping and mixed-condition-operators - #2401, by @paul-dingemans

• Allow property, function and class name to be same as keyword wrapped with backticks - #2405, by @paul-dingemans

• Set offset of max-line-length violation to the last position at which a newline can be inserted to fix the violation - #2419, by @paul-dingemans

• Add support for API Consumers to add suppressions - #2428, by @paul-dingemans

• Disallow else-if (..) <statement> as single line construct - #2430, by @paul-dingemans

• Allow empty constructor for expected class declaration - #2431, by @paul-dingemans

• Disallow comments in try-catch-finally at unexpected locations - #2432, by @paul-dingemans

• Make ktlint.bat more environment agnostic - #2421, by @TWiStErRob

• Suppress property-naming rule via @Suppress("ConstPropertyName") - #2442, by @paul-dingemans

🔧 Fixes

• Remove obsolete configuration files - #2321, by @paul-dingemans

• De-indent the closing angle bracket of the type argument list and type parameter lists in ktlint_official code style - #2302, by @paul-dingemans

• docs: Fix artifact url of Maven Central Badge - #2327, by @guicamest

• Remove redundant arrow in function literal without parameters / fix documentation - #2365, by @paul-dingemans

• Move curly brace before all consecutive comments preceding that curly brace - #2375, by @paul-dingemans

• Prevent stack overflow exception when code provided via stdin can not be parsed as Kotlin, nor Kotlin script - #2380, by @paul-dingemans

• Fix searching from inside a hidden directory - #2377, by @kitterion

• Prevent unwanted joining of KDoc with preceding type-parameter-list - #2381, by @paul-dingemans

• Fix false positive violation in annotation rule - #2400, by @paul-dingemans

• Replace all function bodies with body expressions in a single run - #2395, by @paul-dingemans

• Fix offset for violation when final newline is missing - #2407, by @paul-dingemans

• Fix path to ktlint JAR file in ktlint.bat - #2408, by @paul-dingemans

• Simplify max-line-length implementation - #2410, by @paul-dingemans

• Remove deprecated cli parameters --experimental, --code-style, --disabled-rules - #2411, by @paul-dingemans

• Fix adding blank line between declaration and an annotated declaration which is preceded by comment - #2429, by @paul-dingemans

• Update CODE_OF_CONDUCT with correct path - #2437, by @OriginalMHV

📦 Dependencies

• fix(deps): update dependency org.jetbrains.dokka:dokka-gradle-plugin to v1.9.10 - #2323, by @renovate[bot]

• fix(deps): update dependency org.junit.jupiter:junit-jupiter to v5.10.1 - #2342, by @renovate[bot]

• fix(deps): update kotlin monorepo to v1.9.21 - #2374, by @renovate[bot]

• fix(deps): update dependency org.codehaus.janino:janino to v3.1.11 - #2387, by @renovate[bot]

• fix(deps): update dependency dev.drewhamilton.poko:poko-gradle-plugin to v0.15.1 - #2389, by @renovate[bot]

• chore(deps): update dependency gradle to v8.5 - #2392, by @renovate[bot]

• chore(deps): update actions/checkout digest to b4ffde6 - #2329, by @renovate[bot]

• chore(deps): update actions/setup-java action to v4 - #2393, by @renovate[bot]

• fix(deps): update dependency ch.qos.logback:logback-classic to v1.3.14 - #2406, by @renovate[bot]

• fix(deps): update dependency io.github.hakky54:logcaptor to v2.9.2 - #2409, by @renovate[bot]

• fix(deps): update dependency io.github.oshai:kotlin-logging-jvm to v5.1.4 - #2439, by @renovate[bot]

1.0.1

🆕 Features

• Add .editorconfig property ktlint_function_naming_ignore_when_annotated_with so that rule function-naming can be ignored based on annotations on that rule. See function-naming.

🔧 Fixes

• Update badge for Maven Central - #2245, by @Goooler

• Fix code style parameter in cli - #2241, by @paul-dingemans

• Anonymous function in assignment - #2263, by @paul-dingemans

• Fix indent of multiline object declaration inside class - #2266, by @paul-dingemans

• Do not replace function body with multiple exit points - #2273, by @paul-dingemans

• Ignore override of function in rule function-naming - #2274, by @paul-dingemans

• Suppress function-naming based on annotations - #2275, by @paul-dingemans

• Force blank line before object declaration - #2287, by @paul-dingemans

• Multiline expression wrapping - #2290, by @paul-dingemans

• Ignore function naming in Kotest classes - #2291, by @paul-dingemans

• Improve violation message in discouraged-comment-location - #2293, by @paul-dingemans

• Fix malformed AST when && or || is at start of line chain-wrapping - #2300, by @paul-dingemans

• Do not report false positives type-argument-list-spacing and type-parameter-list-spacing - #2303, by @paul-dingemans

• Fix chain method continuation containing higher order function call - #2305, by @paul-dingemans

📦 Dependencies

• Update dependency io.github.detekt.sarif4k:sarif4k to v0.5.0 - #2277, by @renovate[bot]

• Update dependency gradle to v8.4 - #2294, by @renovate[bot]

• Update actions/checkout action to v4 - #2225, by @renovate[bot]

• Update actions/checkout digest to 8ade135 - #2295, by @renovate[bot]

💬 Other

• Simple property assignments in KTS - #2123, by @Goooler

1.0.0

💔 Breaking changes

• Update and align Maven coordinates - #2195, by @paul-dingemans
  Be sure to update Maven coordinates below, to get latest changes!

  Old Maven coordinates	New Maven coordinates
  com.pinterest:ktlint	com.pinterest.ktlint:ktlint-cli
  com.pinterest.ktlint:ktlint-reporter-baseline	com.pinterest.ktlint:ktlint-cli-reporter-baseline
  com.pinterest.ktlint:ktlint-reporter-checkstyle	com.pinterest.ktlint:ktlint-cli-reporter-checkstyle
  com.pinterest.ktlint:ktlint-cli-reporter	com.pinterest.ktlint:ktlint-cli-reporter-core
  com.pinterest.ktlint:ktlint-reporter-format	com.pinterest.ktlint:ktlint-cli-reporter-format
  com.pinterest.ktlint:ktlint-reporter-html	com.pinterest.ktlint:ktlint-cli-reporter-html
  com.pinterest.ktlint:ktlint-reporter-json	com.pinterest.ktlint:ktlint-cli-reporter-json
  com.pinterest.ktlint:ktlint-reporter-plain	com.pinterest.ktlint:ktlint-cli-reporter-plain
  com.pinterest.ktlint:ktlint-reporter-plain-summary	com.pinterest.ktlint:ktlint-cli-reporter-plain-summary
  com.pinterest.ktlint:ktlint-reporter-sarif	com.pinterest.ktlint:ktlint-cli-reporter-sarif

• Add binary compatibility validator - #2131, by @mateuszkwiecinski

• Replace kotlin public data classes with Poko compiler plugin generated ones - #2136, by @mateuszkwiecinski
  As a part of public API stabilization, data classes are no longer used in the public API. As of that, functions like copy() or componentN() (used for destructuring declarations) are not available anymore.

• Promote experimental rules - #2218, by @paul-dingemans
  The rules below have been promoted to non-experimental rules:

  • blank-line-before-declaration
  • context-receiver-wrapping
  • discouraged-comment-location
  • enum-wrapping
  • function-naming
  • function-signature
  • if-else-bracing
  • multiline-expression-wrapping
  • if-else-wrapping
  • no-blank-line-in-list
  • no-consecutive-comments
  • no-empty-file
  • no-empty-first-line-in-class-body
  • no-single-line-block-comment
  • parameter-list-spacing
  • property-naming
  • statement-wrapping
  • string-template-indent
  • try-catch-finally-spacing
  • type-argument-list-spacing
  • type-parameter-list-spacing
  • unnecessary-parentheses-before-trailing-lambda

• Fix statement-wrapping and align rule classes - #2178, by @paul-dingemans
  Rule class MultilineExpressionWrapping has been renamed to MultilineExpressionWrappingRule. Rule class StatementWrapping has been renamed to StatementWrappingRule. RULE_ID constants below are moved to a different Java class at compile time. Each rule provided by Ktlint is to be accompanied by a RULE_ID constant that can be used in the VisitorModifier.RunAfter. Filenames did not comply with standard that it should end with Rule suffix.

  RULE ID	Old Java class name	New Java class name
  FUNCTION_EXPRESSION_BODY_RULE_ID	FunctionExpressionBodyKt	FunctionExpressionBodyRuleKt
  FUNCTION_LITERAL_RULE_ID	FunctionLiteralKt	FunctionLiteralRuleKt
  MULTILINE_EXPRESSION_WRAPPING_RULE_ID	MultilineExpressionWrappingKt	MultilineExpressionWrappingRuleKt
  NO_BLANK_LINE_IN_LIST_RULE_ID	NoBlankLineInListKt	NoBlankLineInListRuleKt
  NO_EMPTY_FILE_RULE_ID	(not applicable)	NoEmptyFileRuleKt

• Update to Kotlin 1.9 & remove TreeCopyHandler extension - #2113, by @paul-dingemans
  Class org.jetbrains.kotlin.com.intellij.treeCopyHandler is no longer registered as extension point for the compiler as this is not supported in Kotlin 1.9. Please test your custom rules. In case of unexpected exceptions during formatting of code, see #2044 for possible remediation.

🆕 Features

• Change default code style to ktlint_official - #2144, by @paul-dingemans

• Add new experimental rule class-signature - #2119, by @paul-dingemans

• Add new experimental rule function-expression-body - #2151, by @paul-dingemans

• Add new experimental rule chain-method-continuation - #2088, by @atulgpt

• Add new experimental rule function-literal - #2137, by @paul-dingemans

• Add new experimental rule function-type-modifier-spacing rule - #2216, by @t-kameyama

• Define EditorConfigOverride for dynamically loaded ruleset - #2194, by @paul-dingemans
  The EditorConfigOverride parameter of the KtlintRuleEngine can be defined using the factory method EditorConfigOverride.from(vararg properties: Pair<EditorConfigProperty<*>, *>). This requires the EditorConfigProperty's to be available at compile time. Some common EditorConfigProperty's are defined in ktlint-rule-engine-core which is loaded as transitive dependency of ktlint-rule-engine and as of that are available at compile.
  If an EditorConfigProperty is defined in a Rule that is only provided via a runtime dependency, it gets a bit more complicated. The ktlint-api-consumer example has now been updated to show how the EditorConfigProperty can be retrieved from the Rule.

• Move wrapping on semicolon from wrapping rule to statement-wrapping rule - #2222, by @paul-dingemans

🔧 Fixes

• Do not indent class body for classes having a long super type list - #2116, by @paul-dingemans

• Fix indent of explicit constructor - #2118, by @paul-dingemans

• Fix incorrect formatting of nested function literal - #2107, by @paul-dingemans

• Add property to disable ktlint for a glob in .editorconfig - #2108, by @paul-dingemans

• Fix spacing around colon in annotations - #2126, by @paul-dingemans

• Fix solving problems in 3 consecutive runs - #2132, by @paul-dingemans

• Fix indent parenthesized expression - #2127, by @paul-dingemans

• Fix indent of IS_EXPRESSION, PREFIX_EXPRESSION and POSTFIX_EXPRESSION - #2125, by @paul-dingemans

• Do not wrap a binary expression after an elvis operator - #2134, by @paul-dingemans

• Drop obsolete class LintError in ktlint-api-consumer - #2145, by @paul-dingemans

• Fix null pointer exception for if-else statement with empty THEN block - #2142, by @paul-dingemans

• Fix false positive in propert...

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)
• Prevent false negative on else branch when body contains only chained calls or binary expression (#2057)
• Fix indent when property value is wrapped to next line (#2095)

Changed

• Fix Java interoperability issues with RuleId and RuleSetId classes. Those classes were defined as value classes in 0.49.0 and 0.49.1. Although the classes were marked with @JvmInline it 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)
• Update dependency info.picocli:picocli to v4.7.4
• Update dependency org.junit.jupiter:junit-jupiter to v5.9.3
• Update Kotlin development version to 1.8.22 and Kotlin version to 1.8.22.
• Update dependency io.github.detekt.sarif4k:sarif4k to v0.4.0
• Update dependency org.jetbrains.dokka:dokka-gradle-plugin to v1.8.20
• Run format up to 3 times in case formatting introduces changes which also can be autocorrected (#2084)