Skip to main content
Version: 2.23 (prerelease)

ktlint

Ktlint, the anti-bikeshedding Kotlin linter with built-in formatter (https://ktlint.github.io/)

Backend: pants.backend.experimental.kotlin.lint.ktlint

Config section: [ktlint]

Basic options​

skip​

--[no-]ktlint-skip
PANTS_KTLINT_SKIP
pants.toml
[ktlint]
skip = <bool>
default: False

If true, don't use Ktlint when running pants fmt and pants lint.

Advanced options​

artifacts​

--ktlint-artifacts="['<str>', '<str>', ...]"
PANTS_KTLINT_ARTIFACTS
pants.toml
[ktlint]
artifacts = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "com.pinterest:ktlint:{version}"
]

Artifact requirements for this tool using specified as either the address of a jvm_artifact target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version). For Maven coordinates, the string {version} version will be substituted with the value of the [ktlint].version option.

jvm_options​

--ktlint-jvm-options="['<str>', '<str>', ...]"
PANTS_KTLINT_JVM_OPTIONS
pants.toml
[ktlint]
jvm_options = [
    '<str>',
    '<str>',
    ...,
]
default: []

List of JVM options to pass to ktlint JVM processes.

Options set here will be added to those set in [jvm].global_options. Please check the documentation for the jvm subsystem to see what values are accepted here.

lockfile​

--ktlint-lockfile=<str>
PANTS_KTLINT_LOCKFILE
pants.toml
[ktlint]
lockfile = <str>
default: <default>

Path to a lockfile used for installing the tool.

Set to the string <default> to use a lockfile provided by Pants, so long as you have not changed the --version option. See https://github.com/pantsbuild/pants/blob/release_2.23.0rc3/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.

To use a custom lockfile, set this option to a file path relative to the build root, then run pants jvm-generate-lockfiles --resolve=ktlint.

version​

--ktlint-version=<str>
PANTS_KTLINT_VERSION
pants.toml
[ktlint]
version = <str>
default: 0.45.2

Version string for the tool. This is available for substitution in the [ktlint].artifacts option by including the string {version}.

Deprecated options​

None

None