commit | 1e478138f1a6c274751e92317314e0072f8989ea | [log] [tgz] |
---|---|---|
author | Carmi Grushko <carmi@fb.com> | Mon Apr 13 13:51:59 2020 -0700 |
committer | Facebook GitHub Bot <facebook-github-bot@users.noreply.github.com> | Mon Apr 13 13:54:12 2020 -0700 |
tree | 3328a4d8ec46c53bee316415b789abb2096eaf4f | |
parent | 59239c6582892ce6e4afac4334f3fd444bb8848f [diff] |
Update README.md now that we have releases, and detail the release process Reviewed By: strulovich Differential Revision: D20995039 fbshipit-source-id: d6442d9208b31864e4cf0f870baa2f0fca3485a3
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 |
---|---|
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-format
). This is a deliberate design decision to unify our code formatting on a single format.
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.
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
.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-<VERSION>-jar-with-dependencies.jar
See RELEASING.md.
Apache License 2.0