commit | 903cd77fc53f45a8f5745c089eef973f71b6fe53 | [log] [tgz] |
---|---|---|
author | Omer Strulovich <ostrulovich@fb.com> | Wed Feb 12 15:35:39 2020 -0800 |
committer | Facebook Github Bot <facebook-github-bot@users.noreply.github.com> | Wed Feb 12 15:38:15 2020 -0800 |
tree | 8f85001c48a2a6692bcc6832dae0668a5d54bc2d | |
parent | fc1caef24e4c27c4c65078f1d78dd42227d81119 [diff] |
More fixes for complicated KDoc cases Summary: This is a few edits of style that let us handle blank lines better. This fixes some style issues with tags (such as `param`), and lets us add asterisks properly when they are missing. Reviewed By: cgrushko Differential Revision: D19865214 fbshipit-source-id: 29ebb9e66856b63f6bf771fbbe1f1d517200c215
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