Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cortinico/ktfmt-gradle
A Gradle plugin to apply ktfmt to your builds, and reformat you Kotlin source code like a glimpse 🧹🐘
https://github.com/cortinico/ktfmt-gradle
formatter formatting gradle gradle-plugin gradle-plugin-kotlin hacktoberfest kotlin kotlin-android kotlin-gradle ktfmt ktfmt-gradle lint linter reformat
Last synced: 3 months ago
JSON representation
A Gradle plugin to apply ktfmt to your builds, and reformat you Kotlin source code like a glimpse 🧹🐘
- Host: GitHub
- URL: https://github.com/cortinico/ktfmt-gradle
- Owner: cortinico
- License: mit
- Created: 2020-11-13T15:23:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-08T01:02:51.000Z (4 months ago)
- Last Synced: 2024-03-08T10:56:57.651Z (4 months ago)
- Topics: formatter, formatting, gradle, gradle-plugin, gradle-plugin-kotlin, hacktoberfest, kotlin, kotlin-android, kotlin-gradle, ktfmt, ktfmt-gradle, lint, linter, reformat
- Language: Kotlin
- Homepage:
- Size: 593 KB
- Stars: 129
- Watchers: 4
- Forks: 16
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-list - cortinico/ktfmt-gradle - A Gradle plugin to apply ktfmt to your builds, and reformat you Kotlin source code like a glimpse 🧹🐘 (Kotlin)
README
# ktfmt-gradle 🧹🐘
A wrapper to apply [ktfmt](https://github.com/facebookincubator/ktfmt) to your Gradle builds, and reformat you Kotlin
source code like a glimpse.
[](https://plugins.gradle.org/plugin/com.ncorti.ktfmt.gradle) [](https://github.com/cortinico/ktfmt-gradle/actions?query=workflow%3A%22Pre+Merge+Checks%22)  [](LICENSE) [](https://github.com/cortinico/kotlin-gradle-plugin-template/generate) [](http://twitter.com/cortinico)
## How to use 👣
**ktfmt-gradle** is distributed through [Gradle Plugin Portal](https://plugins.gradle.org/). To use it you need to add
the following dependency to your gradle files.
Please note that those code needs to be added the gradle file of the **module** where you want to reformat the code
(**not the top level** build.gradle[.kts] file).
If you're using the `plugin{}` blocks in your Gradle file:
```kotlin
plugins {
id("com.ncorti.ktfmt.gradle") version ""
}
```
If you're instead using the Groovy Gradle files and the old `buildscript` block:
```groovy
buildscript {
repositories {
maven { url "https://plugins.gradle.org/m2/" }
}
dependencies {
classpath "com.ncorti.ktfmt.gradle:plugin:"
}
}
apply plugin: "com.ncorti.ktfmt.gradle"
```
### Requirements
Please note that `ktfmt-gradle` relies on `ktfmt` hence the minimum supported JDK version is **11**.
Please also note the following requirements:
* **Kotlin 1.4+**. In order to reformat Kotlin 1.4 code, you need run on **Gradle to 6.8+** (This is due to Gradle 6.7 embedding Kotlin 1.3.x - See [#12660](https://github.com/gradle/gradle/issues/12660)).
* **Android**. `ktfmt-gradle` relies on features from **Android Gradle Plugin 4.1+**. So make sure you bump AGP before applying this plugin.
### Task
By default, `ktfmt-gradle` will add two Gradle tasks to your build:
- `ktfmtCheck` that will check if the code in your module is ktfmt-compliant
- `ktfmtFormat` that will reformat your code with ktfmt
Those two tasks will invoke `ktfmt` on the **whole module**. More specific tasks are avialable based on the module type.
#### Jvm/Js Modules
For Jvm/Js modules, the plugin will create a check/format task for **every source set**. For example, jvm modules will
have a `ktfmtCheckMain` and `ktfmtCheckTest` tasks for the `main` and `test` source sets.
#### Multiplatform Modules
Kotlin Multiplatform modules will have separate tasks for **every target/source set**. You will have tasks
like `ktfmtCheckCommonMain` and `ktfmtCheckCommonTest` and so on. If you target also Android, the tasks explained below
will be added as well.
#### Android Modules
Kotlin Android modules will also have separate tasks for **every source set**. Due to how source sets are handled on
Android, you can expect ktfmt tasks to follow the convention: `ktfmt[Check|Format][SourceSet][Variant]JavaSource`. For
example, the `ktfmtCheckAndroidTestDebugJavaSource`.
## Features 🎨
- 100% Kotlin-only plugin.
- **Parallel** file processing with Kotlin Coroutines.
- Supports **incremental** builds (i.e. checks tasks won't rerun if source is unchanged).
- Configurable thanks to the `ktfmt{}` block.
- Integrated with Jvm/Android/KMM modules.
## Configuring 🛠
You can configure the behavior of the `ktfmt` invocation with the `ktfmt` block in your `build.gradle.[kts]` file.
To enable different styles you can simply:
```kotlin
ktfmt {
// Dropbox style - 4 space indentation
dropboxStyle()
// Google style - 2 space indentation
googleStyle()
// KotlinLang style - 4 space indentation - From kotlinlang.org/docs/coding-conventions.html
kotlinLangStyle()
}
```
If you wish to have further control on the tool you can instead:
```kotlin
ktfmt {
// Breaks lines longer than maxWidth. Default 100.
maxWidth.set(80)
// blockIndent is the indent size used when a new block is opened, in spaces.
blockIndent.set(8)
// continuationIndent is the indent size used when a line is broken because it's too
continuationIndent.set(8)
// Whether ktfmt should remove imports that are not used.
removeUnusedImports.set(false)
}
```
## Using with a pre-commit hook 🎣
You can leverage the `--include-only` to let ktfmt-gradle run only on a specific subset of files.
To this you can register a simple task of type `KtfmtCheckTask` or `KtfmtFormatTask` in your `build.gradle.kts` as follows:
```kotlin
import com.ncorti.ktfmt.gradle.tasks.*
tasks.register("ktfmtPrecommit") {
source = project.fileTree(rootDir)
include("**/*.kt")
}
```
You can then invoke the task with `--include-only` and a comma separated list of relative path of files:
```
./gradlew ktfmtPrecommit --include-only=src/main/java/File1.kt:src/main/java/File2.kt
```
The task will execute only on the file you passed and will skip all the others.
## Contributing 🤝
Feel free to open a issue or submit a pull request for any bugs/improvements.
## License 📄
This project is licensed under the MIT License - see the [License](License) file for details