Edit

ktlint

This is BETA. The behavior of this tool might change.

Supported Version	Language	Website
0.37.2 ¹	Kotlin (Java 14.0.1)	https://ktlint.github.io

ktlint is a linter with built-in formatter for Kotlin programming language.

¹ You can use Gradle or Maven to install any version of ktlint, but note that the version may not compatible with Sider.

Getting Started

To start using ktlint, enable it in your repository settings, and put and configure your sider.yml to select one way from the followings:

• CLI
• Gradle
• Maven

Using CLI

You can use the ktlint CLI without any configuration, but we recommend making a configuration.

For example:

linter:
  ktlint:
    cli:
      patterns:
        - "src/**/*.kt"

Using Gradle Integration

If you have set up the Gradle integration for ktlint, you can use it as follows:

linter:
  ktlint:
    gradle:
      task: ktlint
      reporter: checkstyle

Sider runs ./gradlew in the repository with the specified task and uses the output result. Essentially, it is equivalent to run the following command:

$ ./gradlew <task>

The reporter option tells Sider which reporter is used by the Gradle task. Sider supports the default checkstyle, json, and plain reporters.

The option is available also with the Maven integration below.

Using Maven Integration

If you have set up the Maven integration for ktlint, you can use it.

linter:
  ktlint:
    maven:
      goal: "antrun:run@ktlint"
      reporter: checkstyle
      output: target/ktlint.xml

Sider runs mvn in the repository with the specified goal and uses the output result. Essentially, it is equivalent to run the following command:

$ mvn <goal>

Configuration

You can customize your ktlint analysis using sider.yml. The configuration for ktlint accepts one of the cli, gradle, and maven keys.

Name	Type	Default
root_dir	string	-
cli	hash	-
cli.patterns	string, string[]	[]
cli.ruleset	string, string[]	[]
cli.disabled_rules	string, string[]	[]
cli.experimental	boolean	false
gradle	hash	-
gradle.task	string	(required)
gradle.reporter	"checkstyle", "json", "plain"	(required)
gradle.output	string	-
maven	hash	-
maven.goal	string	(required)
maven.reporter	"checkstyle", "json", "plain"	(required)
maven.output	string	(required)

cli

This option allows you to configure the CLI execution. For example:

linter:
  ktlint:
    cli:
      patterns:
        - "src/**/*.kt"
        - "!src/**/*Test.kt"
      ruleset:
        - "https://example.com/custom/ruleset.jar"
      disabled_rules:
        - "no-wildcard-imports"
      experimental: true

cli.patterns

This option allows you to specify glob patterns of files to analyze. If omitted, Sider analyzes all Kotlin files in your repository.

cli.ruleset

This option allows you to specify URLs to rulesets you want to enable.

cli.disabled_rules

This option allows you to specify rule names you want to disable.

cli.experimental

This option allows you to specify whether enabling experimental rules or not.

gradle

This option allows you to configure the Gradle integration. For example:

linter:
  ktlint:
    gradle:
      task: ktlint
      reporter: checkstyle
      output: build/reports/ktlint/ktlintMainSourceSetCheck.xml

gradle.task

This option allows you to specify a Gradle task to execute ktlint.

gradle.reporter

This option allows you to specify a reporter of the output from the task.

We recommend using the json or checkstyle reporter for Sider integration. Because the plain reporter does not print any rule ID which is used to identify issues in Sider.

gradle.output

This option allows you to specify a file path that contains the output. If omitted, Sider reads the output from STDOUT.

maven

This option allows you to configure the Maven integration. For example:

linter:
  ktlint:
    maven:
      goal: "antrun:run@ktlint"
      reporter: checkstyle
      output: target/ktlint.xml

maven.goal

This option allows you to specify a Maven goal to execute ktlint.

maven.reporter

This option allows you to specify a reporter of the output from the goal. It has the same limitation as gradle.reporter.

maven.output

This option allows you to specify a file path that contains the output.