Skip to main content
Version: 2.22

jarjar

The Jar Jar Abrams tool (https://github.com/eed3si9n/jarjar-abrams)

Backend: pants.backend.experimental.java

Config section: [jarjar]

Basic options​

misplaced_class_strategy​

--jarjar-misplaced-class-strategy=<MisplacedClassStrategy>
PANTS_JARJAR_MISPLACED_CLASS_STRATEGY
pants.toml
[jarjar]
misplaced_class_strategy = <MisplacedClassStrategy>
one of: fatal, skip, omit, move
default: None

The strategy to use when processing class files that are in the wrong package.

skip_manifest​

--[no-]jarjar-skip-manifest
PANTS_JARJAR_SKIP_MANIFEST
pants.toml
[jarjar]
skip_manifest = <bool>
default: False

Skip the processing of the JAR manifest.

Advanced options​

artifacts​

--jarjar-artifacts="['<str>', '<str>', ...]"
PANTS_JARJAR_ARTIFACTS
pants.toml
[jarjar]
artifacts = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "com.eed3si9n.jarjar:jarjar-assembly:{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 [jarjar].version option.

jvm_options​

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

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

--jarjar-lockfile=<str>
PANTS_JARJAR_LOCKFILE
pants.toml
[jarjar]
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.22.1/src/python/pants/jvm/shading/jarjar.default.lockfile.txt 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=jarjar.

version​

--jarjar-version=<str>
PANTS_JARJAR_VERSION
pants.toml
[jarjar]
version = <str>
default: 1.8.1

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

Deprecated options​

None

None