Skip to main content
Version: 2.23 (prerelease)

scrooge

The Scrooge Thrift IDL compiler (https://twitter.github.io/scrooge/).

Backend: pants.backend.experimental.codegen.thrift.scrooge.scala

Config section: [scrooge]

Basic options​

None

Advanced options​

artifacts​

--scrooge-artifacts="['<str>', '<str>', ...]"
PANTS_SCROOGE_ARTIFACTS
pants.toml
[scrooge]
artifacts = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "com.twitter:scrooge-generator_2.13:{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 [scrooge].version option.

jvm_options​

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

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

--scrooge-lockfile=<str>
PANTS_SCROOGE_LOCKFILE
pants.toml
[scrooge]
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.0rc2/src/python/pants/backend/codegen/thrift/scrooge/scrooge.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=scrooge.

version​

--scrooge-version=<str>
PANTS_SCROOGE_VERSION
pants.toml
[scrooge]
version = <str>
default: 21.12.0

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

Deprecated options​

None

None