Use ktfmt for formatting #571
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
* Make ktlint plugin required again, but set to manual * Make ktlint not used for formatting in IDE * Make ktfmt plugin required, used for formatting in IDE * Make pre-push run config use ktfmt * Add ktfmt Gradle plugin * ktfmt uses kotlinlang style both in IDE and Gradle
Also sets a minimum version for the ktfmt plugin that supports custom styles, and stores our style.
rock3r
added
cleanup
hamen
approved these changes
Sep 3, 2024
* Reformat everything with ktfmt * Don't nag about ktlint suppressions in .editorconfig * Suppress ktlint checks that clash with ktfmt * Disable MergeSarifTask for now * Disable upload-sarif CI step for now
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 switches our formatting both in Gradle and in the IDE to ktfmt.
Ktfmt has minimal configuration, and we use these settings:
This is the closest possible to our existing style, minimizing change.
We decided to move from ktlint to ktfmt for formatting because, even tho the latter does not always produce the nicest looking code, it is at least deterministic across machines and OSes. This should eliminate issues where different team members get different formatting for the same code, which has been particularly annoying recently.
Important
This PR does not contain the actual reformatting. A follow-up is coming with the reformatting. This PR will briefly make main red until that is also merged.
This PR also disables ktlint's formatter in the IDE, and marks ktfmt, Kotlin, and KDoc formatter plugins as required. Lastly, this PR also upgrades the Kotlinter Gradle plugin.