Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jlleitschuh/ktlint-gradle
A ktlint gradle plugin
https://github.com/jlleitschuh/ktlint-gradle
gradle gradle-plugin gradle-script-kotlin hacktoberfest kotlin ktlint linting
Last synced: 3 days ago
JSON representation
A ktlint gradle plugin
- Host: GitHub
- URL: https://github.com/jlleitschuh/ktlint-gradle
- Owner: JLLeitschuh
- License: mit
- Created: 2017-03-06T23:19:40.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T22:48:45.000Z (about 2 months ago)
- Last Synced: 2024-10-29T15:19:43.452Z (about 2 months ago)
- Topics: gradle, gradle-plugin, gradle-script-kotlin, hacktoberfest, kotlin, ktlint, linting
- Language: Kotlin
- Homepage:
- Size: 1.66 MB
- Stars: 1,467
- Watchers: 16
- Forks: 160
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Ktlint Gradle
**Provides a convenient wrapper plugin over the [ktlint](https://github.com/pinterest/ktlint) project.**
Latest plugin version: [12.1.2](/CHANGELOG.md#---20241125)
[](https://kotlinlang.slack.com/messages/CKS3XG0LS)
[](https://github.com/JLLeitschuh/ktlint-gradle/actions/workflows/build-and-check.yml)
[](https://ktlint.github.io/)
[](https://plugins.gradle.org/plugin/org.jlleitschuh.gradle.ktlint)
[](https://securityscorecards.dev/viewer/?uri=github.com/JLLeitschuh/ktlint-gradle)
This plugin creates convenient tasks in your Gradle project
that run [ktlint](https://github.com/pinterest/ktlint) checks or do code
auto format.
The 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.
## Table of content
- [Supported Kotlin plugins](#supported-kotlin-plugins)
- [How to use](#how-to-use)
- [Minimal support versions](#minimal-supported-versions)
- [Ktlint plugin](#ktlint-plugin)
- [Simple setup](#simple-setup)
- [Using legacy apply method](#using-legacy-apply-method)
- [How to apply to all subprojects](#applying-to-subprojects)
- [Baseline support](#baseline-support)
- [Testing KtLint snapshots](#testing-ktlint-snapshots)
- [Intellij IDEA plugin](#intellij-idea-only-plugin)
- [Simple setup](#idea-plugin-simple-setup)
- [Using legacy apply method](#idea-plugin-setup-using-legacy-apply-method)
- [Plugin configuration](#configuration)
- [Setting reports output directory](#setting-reports-output-directory)
- [Customer reporters](#custom-reporters)
- [Changing workers memory usage](#changing-workers-memory-usage)
- [Samples](#samples)
- [Task details](#tasks-added)
- [Main tasks](#main-tasks)
- [Additional tasks](#additional-helper-tasks)
- [FAQ](#faq)
- [Developers](#developers)
- [Importing the project](#importing)
- [Building the project](#building)
- [Links](#links)
## Supported Kotlin plugins
This plugin supports the following kotlin plugins:
- "kotlin"
- "kotlin-android"
- "kotlin-multiplatform"
- project kotlin script files
- "org.jetbrains.kotlin.js"
If you know any new Kotlin plugin that is not in this list - please,
open a [new issue](https://github.com/JLLeitschuh/ktlint-gradle/issues/new).
## How to use
### Minimal supported versions
This plugin was written using the new API available for the Gradle script Kotlin builds.
This API is available in new versions of Gradle.
Minimal supported [Gradle](https://www.gradle.org) version: `7.4`
Minimal supported [Kotlin](https://kotlinlang.org) version: `1.4`
Minimal supported [ktlint](https://github.com/pinterest/ktlint) version: `0.47.1`
Minimal supported [Android Gradle plugin](https://developer.android.com/build) version: `4.1.0`
### Ktlint plugin
#### Simple setup
Build script snippet for new plugin mechanism introduced in Gradle 2.1:
Groovy
```groovy
plugins {
id "org.jlleitschuh.gradle.ktlint" version ""
}
repositories {
// Required to download KtLint
mavenCentral()
}
```
Kotlin
```kotlin
plugins {
id("org.jlleitschuh.gradle.ktlint") version ""
}
repositories {
// Required to download KtLint
mavenCentral()
}
```
#### Using Version Catalog
To configure the plugin using a version catalog, first, add the following entries to your libs.versions.toml file:
```toml
[versions]
ktlint = ""
[plugins]
ktlint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlint" }
```
Next, apply it to your project:
Groovy
```groovy
plugins {
alias(libs.plugins.ktlint)
}
repositories {
// Required to download KtLint
mavenCentral()
}
```
Kotlin
```kotlin
plugins {
alias(libs.plugins.ktlint)
}
repositories {
// Required to download KtLint
mavenCentral()
}
```
#### Using legacy apply method
Build script snippet for use in all Gradle versions:
Groovy
```groovy
buildscript {
repositories {
maven {
url "https://plugins.gradle.org/m2/"
}
}
dependencies {
classpath "org.jlleitschuh.gradle:ktlint-gradle:"
}
}
repositories {
// Required to download KtLint
mavenCentral()
}
apply plugin: "org.jlleitschuh.gradle.ktlint"
```
Kotlin
```kotlin
buildscript {
repositories {
maven("https://plugins.gradle.org/m2/")
}
dependencies {
classpath("org.jlleitschuh.gradle:ktlint-gradle:")
}
}
repositories {
// Required to download KtLint
mavenCentral()
}
apply(plugin = "org.jlleitschuh.gradle.ktlint")
```
#### Applying to subprojects
Optionally apply plugin to all project modules:
Groovy
```groovy
subprojects {
apply plugin: "org.jlleitschuh.gradle.ktlint" // Version should be inherited from parent
repositories {
// Required to download KtLint
mavenCentral()
}
// Optionally configure plugin
ktlint {
debug = true
}
}
```
Kotlin
```kotlin
subprojects {
apply(plugin = "org.jlleitschuh.gradle.ktlint") // Version should be inherited from parent
repositories {
// Required to download KtLint
mavenCentral()
}
// Optionally configure plugin
configure {
debug.set(true)
}
}
```
#### Baseline support
Plugin supports KtLint baseline with following limitations:
- Format tasks ignore baseline. See [#1072](https://github.com/pinterest/ktlint/issues/1072) KtLint issue for more details.
- One baseline file is generated per one Gradle project (module).
Run task `ktlintGenerateBaseline` to generate a new baseline.
#### Testing KtLint snapshots
To test KtLint snapshots add following configuration into project build script (latest KtLint snapshot version name
you could find [here](https://github.com/pinterest/ktlint/blob/master/gradle.properties#L1)):
Groovy
```groovy
repositories {
maven {
url 'https://oss.sonatype.org/content/repositories/snapshots'
}
}
ktlint {
version = "0.41.0-SNAPSHOT"
}
```
Kotlin
```kotlin
repositories {
maven("https://oss.sonatype.org/content/repositories/snapshots")
}
ktlint {
version.set("0.41.0-SNAPSHOT")
}
```
### IntelliJ Idea Only Plugin
**Note:** This plugin is automatically applied by the main `ktlint` plugin.
This plugin just adds [special tasks](#additional-helper-tasks) that can generate IntelliJ IDEA codestyle
rules using ktlint.
#### Idea plugin simple setup
Build script snippet for new plugin mechanism introduced in Gradle 2.1:
```kotlin
plugins {
id("org.jlleitschuh.gradle.ktlint-idea") version ""
}
```
#### Idea plugin setup using legacy apply method
For all Gradle versions:
Use the same `buildscript` logic as [above](#simple-setup), but with this instead of the above suggested `apply` line. If you also want the GIT pre-commit gradle tasks, keep both `apply` variations.
```groovy
apply plugin: "org.jlleitschuh.gradle.ktlint-idea"
```
### Configuration
The following configuration block is _optional_.
If you don't configure this the defaults defined
in the [KtlintExtension](plugin/src/main/kotlin/org/jlleitschuh/gradle/ktlint/KtlintExtension.kt)
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.
Consult the [ktlint release notes](https://github.com/pinterest/ktlint/releases) for more information about the differences between ktlint versions.
Groovy
```groovy
import org.jlleitschuh.gradle.ktlint.reporter.ReporterType
ktlint {
version = "0.22.0"
debug = true
verbose = true
android = false
outputToConsole = true
outputColorName = "RED"
ignoreFailures = true
enableExperimentalRules = true
additionalEditorconfigFile = file("/some/additional/.editorconfig") // not supported with ktlint 0.47+
additionalEditorconfig = [ // not supported until ktlint 0.49
"max_line_length": "20"
]
disabledRules = ["final-newline"] // not supported with ktlint 0.48+
baseline = file("my-project-ktlint-baseline.xml")
reporters {
reporter "plain"
reporter "checkstyle"
reporter "sarif"
customReporters {
"csv" {
fileExtension = "csv"
dependency = project(":project-reporters:csv-reporter")
}
"yaml" {
fileExtension = "yml"
dependency = "com.example:ktlint-yaml-reporter:1.0.0"
}
}
}
kotlinScriptAdditionalPaths {
include fileTree("scripts/")
}
filter {
exclude("**/generated/**")
include("**/kotlin/**")
}
}
dependencies {
ktlintRuleset "com.github.username:rulseset:main-SNAPSHOT"
ktlintRuleset files("/path/to/custom/rulseset.jar")
ktlintRuleset project(":chore:project-ruleset")
}
```
or in kotlin script:
Kotlin
```kotlin
import org.jlleitschuh.gradle.ktlint.reporter.ReporterType
configure {
version.set("0.22.0")
debug.set(true)
verbose.set(true)
android.set(false)
outputToConsole.set(true)
outputColorName.set("RED")
ignoreFailures.set(true)
enableExperimentalRules.set(true)
additionalEditorconfigFile.set(file("/some/additional/.editorconfig")) // not supported with ktlint 0.47+
additionalEditorconfig.set( // not supported until ktlint 0.49
mapOf(
"max_line_length" to "20"
)
)
disabledRules.set(setOf("final-newline")) // not supported with ktlint 0.48+
baseline.set(file("my-project-ktlint-baseline.xml"))
reporters {
reporter(ReporterType.PLAIN)
reporter(ReporterType.CHECKSTYLE)
customReporters {
register("csv") {
fileExtension = "csv"
dependency = project(":project-reporters:csv-reporter")
}
register("yaml") {
fileExtension = "yml"
dependency = "com.example:ktlint-yaml-reporter:1.0.0"
}
}
}
kotlinScriptAdditionalPaths {
include(fileTree("scripts/"))
}
filter {
exclude("**/generated/**")
include("**/kotlin/**")
}
}
dependencies {
ktlintRuleset("com.github.username:rulseset:main-SNAPSHOT")
ktlintRuleset(files("/path/to/custom/rulseset.jar"))
ktlintRuleset(project(":chore:project-ruleset"))
}
```
#### Setting reports output directory
It is possible also to define different from default output directory for generated reports
(by default it is "build/reports/ktlint"):
Groovy
```groovy
tasks.withType(org.jlleitschuh.gradle.ktlint.tasks.GenerateReportsTask) {
reportsOutputDirectory = project.layout.buildDirectory.dir("other/location/$name")
}
```
Kotlin script
```kotlin
tasks.withType {
reportsOutputDirectory.set(
project.layout.buildDirectory.dir("other/location/$name")
)
}
```
#### Custom reporters
**Note**: If Ktlint custom reporter creates report output file internally, for example:
```kotlin
class CsvReporter(
private val out: PrintStream
) : Reporter {
override fun onLintError(file: String, err: LintError, corrected: Boolean) {
val line = "$file;${err.line};${err.col};${err.ruleId};${err.detail};$corrected"
out.println(line)
File("some_other_file.txt").write(line) // <-- Here!!!
}
}
```
"some_other_file.txt" won't be captured as task output. This may lead to the problem,
that task will always be not "UP_TO_DATE" and caching will not work.
#### Changing workers memory usage
By default, KtLint Gradle workers will use at most 256mb of heap size. For some projects it may be not enough,
but it is possible to change:
Groovy
```groovy
tasks.withType(org.jlleitschuh.gradle.ktlint.tasks.BaseKtLintCheckTask).configureEach {
it.workerMaxHeapSize.set("512m")
}
```
Kotlin script
```kotlin
tasks.withType {
workerMaxHeapSize.set("512m")
}
```
### Samples
This repository provides the following examples of how to set up this plugin:
- [android-app](/samples/android-app) - applies plugin to android application project
- [kotlin-gradle](/samples/kotlin-gradle) - applies plugin to plain Kotlin project that uses groovy in `build.gradle` files
- [kotlin-js](/samples/kotlin-js) - applies plugin to kotlin js project
- [kotlin-ks](/samples/kotlin-ks) - applies plugin to plain Kotlin project that uses Kotlin DSL in `build.gradle.kts` files
- [kotlin-multiplatform](/samples/kotlin-mpp) - applies plugin to Kotlin common multiplatform module
- [kotlin-multiplatform-android](/samples/kotlin-mpp-android) - applies plugin to Kotlin android multiplatform module
- [kotlin-rulesets-using](/samples/kotlin-rulesets-using) - adds custom [example](/samples/kotlin-rulesets-creating) ruleset
- [kotlin-reporter-using](/samples/kotlin-reporter-using) - adds custom [example](/samples/kotlin-reporter-creating) reporter
## Tasks Added
### Main tasks
This plugin adds following tasks to every project:
- `loadKtlintReporters` - preloads KtLint `Reporter`s
- `runKtlintCheckOverKotlinScripts` - runs actual lint check over project Kotlin script files
- `ktlintKotlinScriptCheck` - generates reports and prints issues into Gradle console based on lint check found errors.
This task execution depends on `loadKtlintReporters` and `runKtlintCheckOverKotlinScripts` tasks execution outputs
- `runKtlintFormatOverKotlinScripts` - tries to format according to the code style project Kotlin script files
- `ktlintKotlinScriptFormat` - generate reports and prints issues into Gradle console based on found non-formattable errors.
This task execution depends on `loadKtlintReporters` and `runKtlintFormatOverKotlinScripts` tasks execution outputs
- `ktlintCheck` - checks all `SourceSet`s and project Kotlin script files
- `ktlintFormat` - tries to format according to the code style all `SourceSet`s Kotlin files and project Kotlin script files
Then for each `SourceSet` plugin adds following tasks:
- `runKtlintCheckOver[source set name]SourceSet` - runs actual lint check on every Kotlin file in given `SourceSet`
- `ktlint[source set name]SourceSetCheck` - generates reports and prints issues into Gradle console based on lint check found errors.
This task execution depends on `loadKtlintReporters` and `runKtlintCheckOver[source set name]SourceSet` tasks execution outputs
- `runKtlintFormatOver[source set name]SourceSet` - tries to format according to the code style every Kotlin file in given `SourceSet`
- `ktlint[source set name]SourceSetFormat` - reformats files, generates reports and prints issues into Gradle console based on found non-formattable errors.
This task execution depends on `loadKtlintReporters` and `runKtlintFormatOver[source set name]SourceSet` tasks execution outputs
### Additional helper tasks
Following additional tasks are added:
- `ktlintApplyToIdea` - The task generates IntelliJ IDEA (or Android Studio) Kotlin
style files in the project `.idea/` folder. **Note** that this task will overwrite the existing style file.
- `ktlintApplyToIdeaGlobally` - The task generates IntelliJ IDEA (or Android Studio) Kotlin
style files in the user home IDEA
(or Android Studio) settings folder. **Note** that this task will overwrite the existing style file.
- `addKtlintCheckGitPreCommitHook` - adds [Git](https://www.git-scm.com/) `pre-commit` hook,
that runs ktlint check over staged files.
- `addKtlintFormatGitPreCommitHook` - adds [Git](https://www.git-scm.com/) `pre-commit` hook,
that runs ktlint format over staged files and adds fixed files back to commit.
All these additional tasks are always added **only** to the root project.
## FAQ
- Is it possible to not stop task execution if some of the subprojects tasks failed?
Yes. Just use gradle `--continue` option:
```shell
$ ./gradlew --continue ktlintCheck
```
- Can I mix old plugin and new plugin API setup in my project
(see [simple-setup](#simple-setup) and [using legacy apply method](#using-legacy-apply-method))?
No. These approaches are not equivalent to how they work. The problem that
the plugin may not find some of the kotlin plugins if both approaches are used
in the project configuration. Especially it is related to the Android plugin.
- Does plugin check change files incrementally?
Yes, check tasks support it. On the first run, the task will check all files in the source set, on
subsequent runs it will check only added/modified files.
Format tasks do not check files incrementally.
- I could not filter dynamically attached sources that are located outside of the project dir.
Gradle based filtering are only working for files located inside project (subproject) folder, see https://github.com/gradle/gradle/issues/3417
To filter files outside project dir, use:
```kotlin
exclude { element -> element.file.path.contains("generated/") }
```
- Running KtLint fails with strange exception (for example, check [#383](https://github.com/JLLeitschuh/ktlint-gradle/issues/383))
Ensure you are not pinning Kotlin version for "ktlint*" configurations added by plugin.
KtLint relies on Kotlin compiler to parse source files. Each version of KtLint are build using specific Kotlin version.
To exclude "ktlint*" Gradle configurations from Kotlin version pinning - use following approach:
```kotlin
configurations.all {
if (!name.startsWith("ktlint")) {
resolutionStrategy {
eachDependency {
// Force Kotlin to our version
if (requested.group == "org.jetbrains.kotlin") {
useVersion("1.3.72")
}
}
}
}
}
```
## Developers
### Importing
Import the [settings.gradle.kts](settings.gradle.kts) file into your IDE.
To enable the Android sample either define the `ANDROID_HOME` environmental variable or
add a `local.properties` file to the project root folder with the following content:
```properties
sdk.dir=
```
### Building
Building the plugin: `./plugin/gradlew build`
On how to run the current plugin snapshot check on sample projects: `./gradlew ktlintCheck`
### Running tests from [IDEA IDE](https://www.jetbrains.com/idea/)
To run tests in [IDEA IDE](https://www.jetbrains.com/idea/),
firstly you need to run following gradle task (or after any dependency change):
```bash
$ ./plugin/gradlew -p ./plugin pluginUnderTestMetadata
```
Optionally you can add this step test run configuration.
## Links
[Ktlint Gradle Plugin on the Gradle Plugin Registry](https://plugins.gradle.org/plugin/org.jlleitschuh.gradle.ktlint)