Kotlinter Gradle
Painless Gradle plugin for linting and formatting Kotlin source files using the awesome ktlint engine.
It aims to be easy to set up with zero required configuration and behaves as you'd expect out of the box.
It's also fast because it integrates the ktlint engine directly with Gradle's incremental build and uses the Worker API to parallelize work.
Installation
Available on the Gradle Plugins Portal: https://plugins.gradle.org/plugin/org.jmailen.kotlinter
Single module
Kotlin
```kotlin plugins { id("org.jmailen.kotlinter") version "4.4.1" } ```Groovy
```groovy plugins { id "org.jmailen.kotlinter" version "4.4.1" } ```Multi-module and Android
Kotlin
Root `build.gradle.kts` ```kotlin plugins { id("org.jmailen.kotlinter") version "4.4.1" apply false } ``` Each module `build.gradle.kts` with Kotlin source ```kotlin plugins { id("org.jmailen.kotlinter") } ```Groovy
Root `build.gradle` ```groovy plugins { id 'org.jmailen.kotlinter' version "4.4.1" apply false } ``` Each module `build.gradle` with Kotlin source ```groovy plugins { id 'org.jmailen.kotlinter' } ```Compatibility
| kotlinter version | min kotlin version | max kotlin version | min gradle version |
|---|---|---|---|
| 4.2.0+ | 1.9.20 | - | 8.4 |
| 4.0.0+ | 1.9.0 | - | 7.6 |
| 3.14.0+ | 1.8.0 | 1.8.22 | 7.6 |
| 3.11.0+ | 1.7.0 | 1.7.22 | 7.0 |
| 3.10.0+ | 1.6.20 | 1.6.21 | 7.0 |
| 3.7.0+ | 1.5.31 | 1.6.10 | 7.0 |
| 3.5.0+ | 1.5.0 | 1.5.30 | 6.8 |
| 3.0.0+ | 1.4.0 | 1.4.30 | 6.8 |
| 2.0.0+ | 1.3.0 | 1.3.30 | - |
Features
- Supports Kotlin Gradle plugins:
- Supports
.ktand.ktsfiles - Standalone
LintTaskandFormatTasktypes for defining custom tasks - Incremental build support and fast parallelization with Gradle Worker API
- Configures from
.editorconfigwhen available - Configurable reporters
Tasks
When your project uses one of the supported Kotlin Gradle plugins, Kotlinter adds these tasks:
formatKotlin: format Kotlin source code according to ktlint rules or warn when auto-format not possible.
lintKotlin: report Kotlin lint errors and by default fail the build.
Also check becomes dependent on lintKotlin.
Granular tasks are added for each source set in the project: formatKotlinSourceSet and lintKotlinSourceSet.
Git Hooks
Kotlinter can install a hook to run pre-push (installKotlinterPrePushHook). The hook runs lintKotlin and, if there are errors, formatKotlin and exits non-zero leaving changed files to be committed.
You must apply the kotlinter plugin to your root project to make this task available. If using git worktree you must install the hook from the parent git directory.
To install the hook automatically when someone runs the build, add this to your root project build.gradle.kts:
Kotlin
```kotlin tasks.check { dependsOn("installKotlinterPrePushHook") } ```Groovy
```groovy tasks.named('check') { dependsOn 'installKotlinterPrePushHook' } ```Configuration
Options are configured in the kotlinter extension. Defaults shown (you may omit the configuration block entirely if you want these defaults).
Kotlin
```kotlin kotlinter { failBuildWhenCannotAutoFormat = false ignoreFailures = false reporters = arrayOf("checkstyle", "plain") } ```Groovy
```groovy kotlinter { failBuildWhenCannotAutoFormat = false ignoreFailures = false reporters = ['checkstyle', 'plain'] } ```Setting failBuildWhenCannotAutoFormat to true will configure the formatKotlin task to fail the build when auto-format is not able to fix a lint error. This is overrided by setting ignoreFailures to true.
Options for reporters: checkstyle, html, json, plain, sarif
Reporters behave as described at: https://github.com/pinterest/ktlint
Editorconfig
Kotlinter will configure itself using an .editorconfig file if one is present.
This configuration includes code style and linting rules.
See KtLint configuration for details.
Customizing Tasks
The formatKotlinSourceSet and lintKotlinSourceSet tasks inherit from SourceTask
so you can customize includes, excludes, and source.
Kotlin
```kotlin tasks.withTypeGroovy
```groovy tasks.named("lintKotlinMain") { source = source - fileTree("$buildDir/generated") } ```Note that exclude paths are relative to the package root.
Custom Tasks
If you aren't using autoconfiguration from a supported plugin or otherwise need to handle additional source code, you can create custom tasks:
Kotlin
```kotlin import org.jmailen.gradle.kotlinter.tasks.LintTask import org.jmailen.gradle.kotlinter.tasks.FormatTask tasks.registerGroovy
```groovy import org.jmailen.gradle.kotlinter.tasks.LintTask import org.jmailen.gradle.kotlinter.tasks.FormatTask tasks.register('ktLint', LintTask) { group 'verification' source files('src') reports = [ 'plain': file('build/lint-report.txt'), 'json' : file('build/lint-report.json') ] } tasks.register('ktFormat', FormatTask) { group 'formatting' source files('src/test') report = file('build/format-report.txt') } ```Custom ktlint version
If you need to use a different version of ktlint you can override the dependency.
Kotlin or Groovy
```kotlin buildscript { configurations.classpath { resolutionStrategy { force( "com.pinterest.ktlint:ktlint-rule-engine:1.2.1", "com.pinterest.ktlint:ktlint-rule-engine-core:1.2.1", "com.pinterest.ktlint:ktlint-cli-reporter-core:1.2.1", "com.pinterest.ktlint:ktlint-cli-reporter-checkstyle:1.2.1", "com.pinterest.ktlint:ktlint-cli-reporter-json:1.2.1", "com.pinterest.ktlint:ktlint-cli-reporter-html:1.2.1", "com.pinterest.ktlint:ktlint-cli-reporter-plain:1.2.1", "com.pinterest.ktlint:ktlint-cli-reporter-sarif:1.2.1", "com.pinterest.ktlint:ktlint-ruleset-standard:1.2.1" ) } } } ```Alternatively, if you have a custom build convention plugin that utilizes kotlinter, you can enforce a newer KtLint version through a platform directive: