Skip to main content
Version: 2.23 (prerelease)

java-parser


Internal tool for parsing JVM sources to identify dependencies

Backend: pants.backend.experimental.java

Config section: [java-parser]

Basic options

None

Advanced options

artifacts

--java-parser-artifacts="['<str>', '<str>', ...]"
PANTS_JAVA_PARSER_ARTIFACTS
pants.toml
[java-parser]
artifacts = [
'<str>',
'<str>',
...,
]
default:
[
  "com.fasterxml.jackson.core:jackson-databind:2.12.4",
  "com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.12.4",
  "com.github.javaparser:javaparser-symbol-solver-core:3.25.5"
]

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

jvm_options

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

List of JVM options to pass to java-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

--java-parser-lockfile=<str>
PANTS_JAVA_PARSER_LOCKFILE
pants.toml
[java-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.0rc3/src/python/pants/backend/java/dependency_inference/java_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=java-parser.

version

--java-parser-version=<str>
PANTS_JAVA_PARSER_VERSION
pants.toml
[java-parser]
version = <str>
default: None

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

Deprecated options

None

None