| commit | eee6dec4cb3bffa808daf358541ab16a6009836f | [log] [tgz] |
|---|---|---|
| author | Omer Strulovich <ostrulovich@fb.com> | Fri Oct 09 22:03:12 2020 -0700 |
| committer | Facebook GitHub Bot <facebook-github-bot@users.noreply.github.com> | Fri Oct 09 22:05:56 2020 -0700 |
| tree | b99e9d38f93705266504fe8dbc7a1aa68d968ae0 | |
| parent | 353dd41f543d0c568714aeab3ae0ad4f0c464ecb [diff] |
Handle ; between property and accessor Summary: See example in test. When a semicolon separates the accessor of a property we may not insert a newline. We could alternatively Reviewed By: hick209 Differential Revision: D24195894 fbshipit-source-id: 91e34262b42210c6aff660c136073a62ebb52002
ktfmt is a program that pretty-prints (formats) Kotlin code, based on google-java-format.
Note that ktfmt still has some rough edges which we're constantly working on fixing.
The minimum supported runtime version is JDK 11, released September 2018.
| Before Formatting | Formatted by ktfmt |
|---|---|
 |  |
For comparison, the same code formatted by ktlint and IntelliJ:
Formatted by ktlint | Formatted by IntelliJ |
|---|---|
 |  |
A ktfmt IntelliJ plugin is available from the plugin repository. To install it, go to your IDE's settings and select the Plugins category. Click the Marketplace tab, search for the ktfmt plugin, and click the Install button.
The plugin will be disabled by default. To enable it in the current project, go to File→Settings...→ktfmt Settings (or IntelliJ IDEA→Preferences...→Editor→ktfmt Settings on macOS) and check the Enable ktfmt checkbox. (A notification will be presented when you first open a project offering to do this for you.)
To enable it by default in new projects, use File→New Project Settings→Preferences for new Projects→Editor→ktfmt Settings.
When enabled, it will replace the normal Reformat Code action, which can be triggered from the Code menu or with the Ctrl-Alt-L (by default) keyboard shortcut.
Download the formatter and run it with:
java -jar /path/to/ktfmt-<VERSION>-jar-with-dependencies.jar [--dropbox-style] [files...]
--dropbox-style makes ktfmt use a block indent of 4 spaces instead of 2. See below for details.
Note: There is no configurability as to the formatter's algorithm for formatting (apart from --dropbox-style). This is a deliberate design decision to unify our code formatting on a single format.
On Gradle: https://github.com/diffplug/spotless/tree/main/plugin-gradle#ktfmt On Maven: https://github.com/diffplug/spotless/tree/main/plugin-maven#ktfmt
ktfmt vs ktlint vs IntelliJktfmt uses google-java-format's underlying engine, and as such, many items on google-java-format's FAQ apply to ktfmt as well.
In particular,
ktfmt ignores most existing formatting. It respects existing newlines in some places, but in general, its output is determinstic and is independent of the input code.ktfmt exposes no configuration options that govern formatting behavior. See https://github.com/google/google-java-format/wiki/FAQ#i-just-need-to-configure-it-a-bit-differently-how for the rationale.These two properties make ktfmt a good fit in large Kotlin code bases, where consistency is very important.
We created ktfmt because ktlint and IntelliJ sometime fail to produce nice-looking code that fits in 100 columns, as can be seen in the Demo section.
ktfmt uses a 2-space indent; why not 4? any way to change that?Two reasons -
However, we do offer an escape-hatch for projects that absolutely cannot make the move to ktfmt because of 2-space: the --dropbox-style flag changes block indents to 4-space.
pom.xml in IntelliJ. Choose “Open as a Project”FormatterKtTest.kt.mvn installjava -jar core/target/ktfmt-<VERSION>-jar-with-dependencies.jarSee RELEASING.md.
Apache License 2.0