ktfmt

https://facebook.github.io/ktfmt/
Admin
ktfmt is a non-customizable Kotlin code formatter that produces consistent and reproducible...
Tokens:631
Snippets:7
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example Kotlin Code for Formatting

Source: https://facebook.github.io/ktfmt/index.html

A sample Kotlin class used to demonstrate the formatting capabilities of ktfmt.

```kotlin
/**
* Formats the given Javadoc comment, which must start with /** and end with */. The output will
* start and end with the same characters.
*/
class Handler : RequestHandler<APIGatewayProxyRequestEvent, String> {
override fun handleRequest(event: APIGatewayProxyRequestEvent, context: Context?): String {
for ((i, item) in items.withIndex()) {
if (needDot) {
// fillMode is bla bla
val fillMode =
if (unconsumedPrefixes.isNotEmpty() && i <= unconsumedPrefixes.peekFirst()) {
prefixFillMode /* bla bla */
} else {
Doc.FillMode.UNIFIED
}
builder.breakOp(fillMode, "", ZERO, Optional.of(nameTag))
builder.token((item as KtQualifiedExpression).operationSign.value)
}
emitSelectorUpToParenthesis(item)
if (unconsumedPrefixes.isNotEmpty() && i == unconsumedPrefixes.peekFirst()) {
builder.close()
unconsumedPrefixes.removeFirst()

```

--------------------------------

### Run ktfmt via Command Line

Source: https://facebook.github.io/ktfmt/index.html

Download the ktfmt JAR and execute it directly using the Java runtime.

```bash
$ wget https://repo1.maven.org/maven2/com/facebook/ktfmt/0.62/ktfmt-0.62-with-dependencies.jar
$ java -jar ktfmt-0.62-with-dependencies.jar [--kotlinlang-style] [files...]
```

--------------------------------

### Configure ktfmt with Spotless in Gradle

Source: https://facebook.github.io/ktfmt/index.html

Use the Spotless plugin to integrate ktfmt into a Gradle project.

```kotlin
# build.gradle.kts
plugins { id("com.diffplug.spotless") }

// version and style are optional
spotless { kotlin { ktfmt('0.62').kotlinlangStyle() } }
```

--------------------------------

### Configure ktfmt with Spotless in Maven

Source: https://facebook.github.io/ktfmt/index.html

Add ktfmt configuration to the pom.xml file for Maven projects.

```xml
# pom.xml
<configuration>
  <kotlin>
    <ktfmt>
      <version>0.62</version>
    </ktfmt>
  </kotlin>
</configuration>
```

--------------------------------

### Configure ktfmt with ktfmt-gradle plugin

Source: https://facebook.github.io/ktfmt/index.html

Use the dedicated ktfmt-gradle plugin for simpler integration in Gradle projects.

```kotlin
# build.gradle.kts
plugins { id("com.ncorti.ktfmt.gradle") }

ktfmt { kotlinLangStyle() }
```
Tokens:
Raw