Skip to main content
Version: 2.23

kotlin-parser

Internal tool for parsing Kotlin sources to identify dependencies

Backend: pants.backend.experimental.kotlin

Config section: [kotlin-parser]

Basic options​

None

Advanced options​

artifacts​

--kotlin-parser-artifacts="['<str>', '<str>', ...]"
PANTS_KOTLIN_PARSER_ARTIFACTS
pants.toml
[kotlin-parser]
artifacts = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "org.jetbrains.kotlin:kotlin-compiler:{version}",
  "org.jetbrains.kotlin:kotlin-stdlib:{version}",
  "com.google.code.gson:gson:2.9.0"
]

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 [kotlin-parser].version option.

jvm_options​

--kotlin-parser-jvm-options="['<str>', '<str>', ...]"
PANTS_KOTLIN_PARSER_JVM_OPTIONS
pants.toml
[kotlin-parser]
jvm_options = [
    '<str>',
    '<str>',
    ...,
]
default: []

List of JVM options to pass to kotlin-parser 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​

--kotlin-parser-lockfile=<str>
PANTS_KOTLIN_PARSER_LOCKFILE
pants.toml
[kotlin-parser]
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.1/src/python/pants/backend/kotlin/dependency_inference/kotlin_parser.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=kotlin-parser.

version​

--kotlin-parser-version=<str>
PANTS_KOTLIN_PARSER_VERSION
pants.toml
[kotlin-parser]
version = <str>
default: 1.6.20

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

Deprecated options​

None

None