Ktlint Gradle

Provides a convenient wrapper plugin over the ktlint project.

This plugin can be applied to any project but only activates if that project has the kotlin plugin applied. The assumption being that you would not want to lint code you weren't compiling.

Warning

This uses/publishes with a beta version of gradle. I plan to fix this as soon as the newest version of gradle script kotlin is released with a stable version of kotlin.

How to use

Build script snippet for use in all Gradle versions:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "gradle.plugin.org.jlleitschuh.gradle:ktlint-gradle:1.0.2"
  }
}

apply plugin: "org.jlleitschuh.gradle.ktlint"

Build script snippet for new, incubating, plugin mechanism introduced in Gradle 2.1:

plugins {
  id "org.jlleitschuh.gradle.ktlint" version "1.0.2"
}

Configuration

The following configuration block is optional.

If you don't configure this the defaults defined in the KtlintExtension object will be used. The version of Ktlint used by default may change between patch versions of this plugin. If you don't want to inherit these changes then make sure you lock your version here.

ktlint {
    version = ""
    debug = true
    verbose = true
}

Tasks Added

This plugin adds two tasks to every source set: ktlint[source set name] and ktlint[source set name]Format. Additionally, a simple ktlint task has also been added that checks all of the source sets for that project. Similarly, a ktlintFormat task has been added that formats all of the source sets.

Developers

Building

./gradlew build

Future Development

Add support for linting *.kts for gradle script kotlin builds.

Links

Ktlint Gradle Plugin on the Gradle Plugin Registry

jeremymailen / ktlint-gradle