commit | c57cb64056325a76882a17fb489d7ae48ee72368 | [log] [tgz] |
---|---|---|
author | Omer Strulovich <ostrulovich@fb.com> | Thu Mar 05 08:59:26 2020 -0800 |
committer | Facebook Github Bot <facebook-github-bot@users.noreply.github.com> | Thu Mar 05 09:02:03 2020 -0800 |
tree | a52eb14581291a03dddd6825c6bc9f8c683c25f7 | |
parent | c57a9b2c95695a46cf1e4f3a4efb885f99b6b4c2 [diff] |
Do not add spaces after links if the next token is not a word Summary: Fixing issue #25 on github. To keep formatting more strict we will add spaces if the next token following a link looks like a word, but avoid space if it looks like punctuation. I wrote this before realizing sgrimm wrote another solution. So I incorporate his test cases (which were more exhaustive than mine) I do think this solution is better, since we delegate more to the tokenizer write, and it will be easier to generalize to other tokens later. Reviewed By: cgrushko Differential Revision: D20254206 fbshipit-source-id: 3aac00494c05f94fac98f25c35833aac49c33d93
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