commit | f336b31acedab859c477be50edd9390ed807f665 | [log] [tgz] |
---|---|---|
author | Omer Strulovich <ostrulovich@fb.com> | Sat Feb 08 09:02:14 2020 -0800 |
committer | Facebook Github Bot <facebook-github-bot@users.noreply.github.com> | Sat Feb 08 09:04:03 2020 -0800 |
tree | bca2c36081b06684898bfd2e5545d27baf636860 | |
parent | 788d9132bbc3e57f768d21fb241d1e173e426eda [diff] |
Adding a test for links in KDoc Summary: This test passes, but we used to fail it. So I'm adding it for the future. Reviewed By: cgrushko Differential Revision: D19796836 fbshipit-source-id: f9011f3fdf970e22ea3f4da20c7fc09c36750da5
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