Update Ktlint to v1 (major) #1729
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
renovate
bot
force-pushed
the
renovate/major-ktlint
branch
from
23293e9
to
27899f6
Compare
renovate
bot
force-pushed
the
renovate/major-ktlint
branch
from
27899f6
to
a4cfff6
Compare
renovate
bot
force-pushed
the
renovate/major-ktlint
branch
from
a4cfff6
to
c0a34d9
Compare
- supported artifact names changes - logging upgrades - disabled tests which fails with repeatable run - fixed test for comment when ASTNode.copy() is called
Edited/Blocked NotificationRenovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR. You can manually request rebase by checking the rebase/retry box above. ⚠ Warning: custom changes will be lost. |
Codecov Report
@@ Coverage Diff @@
## master #1729 +/- ##
============================================
- Coverage 78.21% 74.76% -3.46%
+ Complexity 2324 2270 -54
============================================
Files 126 126
Lines 8223 8230 +7
Branches 2073 2072 -1
============================================
- Hits 6432 6153 -279
- Misses 876 1163 +287
+ Partials 915 914 -1
|
JUnit Tests (macOS, EnricoMi/publish-unit-test-result-action@v2) 164 files ±0 164 suites ±0 5m 32s ⏱️ +8s Results for commit 5579d78. ± Comparison against base commit 84e380d. This pull request skips 33 tests.♻️ This comment has been updated with latest results. |
JUnit Tests (Windows, EnricoMi/publish-unit-test-result-action@v2) 164 files ±0 164 suites ±0 5m 15s ⏱️ - 1m 33s Results for commit 5579d78. ± Comparison against base commit 84e380d. This pull request skips 40 tests.♻️ This comment has been updated with latest results. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.49.1->1.0.00.49.1->1.0.00.49.1->1.0.0⚠ Dependency Lookup Warnings ⚠
Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information.
Release Notes
pinterest/ktlint (com.pinterest.ktlint:ktlint-cli-ruleset-core)
v1.0.0Compare Source
💔 Breaking changes
Update and align Maven coordinates - #2195, by @paul-dingemans
Be sure to update Maven coordinates below, to get latest changes!
Add binary compatibility validator - #2131, by @mateuszkwiecinski
Replace kotlin public
data classes with Poko compiler plugin generated ones - #2136, by @mateuszkwiecinskiAs a part of public API stabilization, data classes are no longer used in the public API. As of that, functions like
copy()orcomponentN()(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:
Fix statement-wrapping and align rule classes - #2178, by @paul-dingemans
Rule class
MultilineExpressionWrappinghas been renamed toMultilineExpressionWrappingRule. Rule classStatementWrappinghas been renamed toStatementWrappingRule.RULE_IDconstants below are moved to a different Java class at compile time. Each rule provided by Ktlint is to be accompanied by aRULE_IDconstant that can be used in theVisitorModifier.RunAfter. Filenames did not comply with standard that it should end withRulesuffix.FUNCTION_EXPRESSION_BODY_RULE_IDFUNCTION_LITERAL_RULE_IDMULTILINE_EXPRESSION_WRAPPING_RULE_IDNO_BLANK_LINE_IN_LIST_RULE_IDNO_EMPTY_FILE_RULE_IDUpdate to Kotlin 1.9 & remove TreeCopyHandler extension - #2113, by @paul-dingemans
Class
org.jetbrains.kotlin.com.intellij.treeCopyHandleris 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-dingemansAdd new experimental rule
class-signature- #2119, by @paul-dingemansAdd new experimental rule
function-expression-body- #2151, by @paul-dingemansAdd new experimental rule
chain-method-continuation- #2088, by @atulgptAdd new experimental rule
function-literal- #2137, by @paul-dingemansAdd new experimental rule
function-type-modifier-spacingrule - #2216, by @t-kameyamaDefine
EditorConfigOverridefor dynamically loaded ruleset - #2194, by @paul-dingemansThe
EditorConfigOverrideparameter of theKtlintRuleEnginecan be defined using the factory methodEditorConfigOverride.from(vararg properties: Pair<EditorConfigProperty<*>, *>). This requires theEditorConfigProperty's to be available at compile time. Some commonEditorConfigProperty's are defined inktlint-rule-engine-corewhich is loaded as transitive dependency ofktlint-rule-engineand as of that are available at compile.If an
EditorConfigPropertyis defined in aRulethat is only provided via a runtime dependency, it gets a bit more complicated. Thektlint-api-consumerexample has now been updated to show how theEditorConfigPropertycan be retrieved from theRule.Move wrapping on semicolon from
wrappingrule tostatement-wrappingrule - #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-dingemansFix 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 property-naming - #2141, by @paul-dingemans
Store relative path of file in baseline file - #2147, by @paul-dingemans
Fix url of build status badge - #2162, by @paul-dingemans
Update CONTRIBUTING.md - #2163, by @oshai
Fix statement-wrapping and align rule classes - #2178, by @paul-dingemans
Fix alignment of type constraints after
wherekeyword in function - #2180, by @paul-dingemansFix wrapping of multiline postfix expression - #2184, by @paul-dingemans
Do not wrap expression after a spread operator - #2193, by @paul-dingemans
Do not remove parenthesis after explicit class constructor without arguments - #2226, by @paul-dingemans
Fix conflict between rules due to annotated super type call - #2227, by @paul-dingemans
Fix indentation of super type list of class in case it is preceded by a comment - #2228, by @paul-dingemans
Super type list starting with an annotation having a parameters - #2230, by @paul-dingemans
Do not wrap values in a single line enum when it is preceded by a comment or an annotation - #2229, by @paul-dingemans
📦 Dependencies
Update dependency org.codehaus.janino:janino to v3.1.10 - #2110, by @renovate[bot]
Update dependency com.google.jimfs:jimfs to v1.3.0 - #2112, by @renovate[bot]
Update dependency org.junit.jupiter:junit-jupiter to v5.10.0 - #2148, by @renovate[bot]
Update dependency io.github.oshai:kotlin-logging-jvm to v5.1.0 - #2174, by @renovate[bot]
Update dependency dev.drewhamilton.poko:poko-gradle-plugin to v0.15.0 - #2173, by @renovate[bot]
Update plugin org.gradle.toolchains.foojay-resolver-convention to v0.7.0 - #2187, by @renovate[bot]
Update dependency gradle to v8.3 - #2186, by @renovate[bot]
Update kotlin monorepo to v1.9.10 - #2197, by @renovate[bot]
Update dependency info.picocli:picocli to v4.7.5 - #2215, by @renovate[bot]
Update dependency org.jetbrains.dokka:dokka-gradle-plugin to v1.9.0 - #2221, by @renovate[bot]
Update dependency org.slf4j:slf4j-simple to v2.0.9 - #2224, by @renovate[bot]
💬 Other
Setup toolchains, compile project with Java 20 only, run test on various Java versions - #2120, by @mateuszkwiecinski
Add release-changelog-builder-action to temporary workflow - #2196, by @paul-dingemans
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.20Configuration
📅 Schedule: Branch creation - "before 4am on Monday" (UTC), 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 these updates again.
This PR has been generated by Mend Renovate. View repository job log here.