commit | 3a7a096146773ac8656a8ecc8dd14e4037246c64 | [log] [tgz] |
---|---|---|
author | Carmi Grushko <carmi@fb.com> | Mon Mar 23 08:34:50 2020 -0700 |
committer | Facebook GitHub Bot <facebook-github-bot@users.noreply.github.com> | Mon Mar 23 08:37:37 2020 -0700 |
tree | 687426a5035d11b1f73f72314c6101f743dbcef7 | |
parent | b653d420916ce39864e58a525aa3a97e30888e8f [diff] |
Sort imports Summary: Anything but imports and whitespace is not allowed between imports, and causes a parsing error. In particular, this makes ktfmt not support comments between import directives (comments after are fine). This is done by getting the imports, sorting them, and then overwriting the original code string in the appropriate area. This means that all whitespace is lost even before it arrives at the formatter, but that's fine, because the formatter ignores whitespace anyway. Partially addresses Issue 17. Reviewed By: strulovich Differential Revision: D20583202 fbshipit-source-id: f9c7ae2b48ca6b6a480fa514791ac79134cacbc7
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.
Before Formatting | Formatted by ktfmt |
---|---|
For comparison, the same code formatted by ktlint
and IntelliJ:
Formatted by ktlint | Formatted by IntelliJ |
---|---|
vendor/google-java/format
submodule is populated. Either clone with submodules (git pull --recurse-submodules https://github.com/facebookincubator/ktfmt.git
) or populate the submodule after cloning (git submodule update --init
)mvn install
java -jar core/target/ktfmt-0.1-SNAPSHOT-jar-with-dependencies.jar
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?Two reasons -
vendor/google-java/format
submodule is populated. Either clone with submodules (git pull --recurse-submodules https://github.com/facebookincubator/ktfmt.git
) or populate the submodule after cloning (git submodule update --init
)pom.xml
in IntelliJ. Choose “Open as a Project”FormatterKtTest.kt
.Apache License 2.0