Edit

ktlint

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

Supported Version	Language	Website
0.36.0 [¹]	Kotlin (Java 12.0.2)	https://ktlint.github.io

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

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

Getting Started

To start using ktlint, enable it in Repository Settings, and put a configuration in sider.yml.

Using ktlint CLI

You can use ktlint CLI without any configuration, but we recommend to make a configuration.

Put the cli key in sider.yml to customize the execution of ktlint CLI.

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

Using Gradle integration

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

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

Sider runs ./gradlew in the repository with the specified task, and use the output as ktlint result. Essentially, it executes 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 use the output. Essentially, it executes 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	Description
root_dir	string	-	A root directory.
cli	hash	-	Settings for CLI execution.
cli.patterns	string, string[]	[]	File patterns to analyze.
cli.ruleset	string, string[]	[]	Ruleset URLs.
cli.disabled_rules	string, string[]	[]	Whether disable rules or not.
cli.experimental	boolean	false	--experimental option of ktlint.
gradle	hash	-	Settings for Gradle execution.
gradle.task	string	(required)	Task name of Gradle.
gradle.reporter	"checkstyle", "json", "plain"	(required)	Reporter name.
gradle.output	string	-	Output file path.
maven	hash	-	Settings for Maven execution.
maven.goal	string	(required)	Goal name of Maven.
maven.reporter	"checkstyle", "json", "plain"	(required)	Reporter name. Same as gradle.reporter.
maven.output	string	(required)	Output file path.

cli

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

Pattern(s) to specify the files to be analyzed by ktlint. If you omit the option, Sider analyzes all Kotlin files in your repository.

cli.ruleset

URL(s) to ktlint ruleset(s).

cli.disabled_rules

Name(s) of rule(s) which you want to disable.

cli.experimental

Whether enable the --experimental option or not.

gradle

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

For more details about the Gradle settings, see the official documentation.

gradle.task

A name of the Gradle task to execute ktlint.

gradle.reporter

A reporter name 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

A path to a file which contains ktlint output. If you omit the option, Sider reads the output from Gradle stdout.

maven

For example:

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

For more details about the Maven settings, see the official documentation.

maven.goal

A name of the Maven goal to execute ktlint.

maven.reporter

A reporter name of the output from the goal. For details, see gradle.reporter.

maven.output

A path to a file which contains ktlint output.