Google Git
Sign in
android / platform / external / ktfmt / c71034f
commitc71034fd3318096eb45797a8e93bbc3e2f42f21e[log] [tgz]
authorfacebook-github-bot <facebook-github-bot@users.noreply.github.com>Thu Dec 19 15:25:56 2019 -0800
committerfacebook-github-bot <facebook-github-bot@users.noreply.github.com>Thu Dec 19 15:25:56 2019 -0800
tree4a389fde4292f6dea8fe3877096a7c93bb0534d4
Initial commit

fbshipit-source-id: 91b1d4a9703c0894565b21bf50d122e84ebe7ae6
26 files changed
tree: 4a389fde4292f6dea8fe3877096a7c93bb0534d4
  1. .github/
  2. core/
  3. .gitignore
  4. .gitmodules
  5. CODE_OF_CONDUCT.md
  6. CONTRIBUTING.md
  7. LICENSE
  8. pom.xml
  9. README.md
README.md

ktfmt

ktfmt is a program that pretty-prints (formats) Kotlin code, based on google-java-format.

Before

  private fun declareOne(      kind: DeclarationKind,      modifiers: KtModifierList? = null,      valOrVarKeyword: String? = null,      typeParameters: KtTypeParameterList? = null,
      receiver: KtTypeReference? = null,     name: String? = "",      type: KtTypeReference? = null,      op: String = "",      equals: String = "=",
      typeConstraintList: KtTypeConstraintList? = null,      initializer: PsiElement? = null,
      delegate: KtPropertyDelegate? = null,      trailing: String? = null
  ): Int {
//
}

After

private fun declareOne(
    kind: DeclarationKind,
    modifiers: KtModifierList? = null,
    valOrVarKeyword: String? = null,
    typeParameters: KtTypeParameterList? = null,
    receiver: KtTypeReference? = null,
    name: String? = "",
    type: KtTypeReference? = null,
    op: String = "",
    equals: String = "=",
    typeConstraintList: KtTypeConstraintList? = null,
    initializer: PsiElement? = null,
    delegate: KtPropertyDelegate? = null,
    trailing: String? = null
): Int {
  //
}

Using on the command-line

  • Make sure the 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)
  • Run mvn install
  • Run java -jar core/target/ktfmt-0.1-SNAPSHOT-jar-with-dependencies.jar

FAQ

ktfmt uses a 2-space indent; why not 4?

Two reasons -

  1. Many of our projects use a mixture of Kotlin and Java, and we found the back-and-forth in styles to be distracting.
  2. From a pragmatic standpoint, the formatting engine behind google-java-format uses more whitespace and newlines than other formatters. Using an indentation of 4 spaces quickly reaches the maximal column width.

Developer's Guide

Setup

  • Make sure the 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)
  • Open pom.xml in IntelliJ. Choose “Open as a Project”
  • The IntelliJ project will unfortunately be broken on import. To fix,
    • Turn off ErrorProne by removing the compiler parameters in IntelliJ at the bottom of “Settings -> Build, Execution, Deployment -> Compiler -> Java Compiler” (see https://github.com/google/google-java-format/issues/417)
    • Right click on “vendor/google-java-format/pom.xml” and choose “Add maven project”

Development

  • Currently, we mainly develop by adding tests to FormatterKtTest.kt.

License

Apache License 2.0