Skip to main content
Version: 2.11 (deprecated)

scalapb

The ScalaPB protocol buffer compiler (https://scalapb.github.io/).

Backend: pants.backend.experimental.codegen.protobuf.scala

Config section: [scalapb]

Basic options​

jvm_plugins​

--scalapb-jvm-plugins="['<str>', '<str>', ...]"
PANTS_SCALAPB_JVM_PLUGINS
pants.toml
[scalapb]
jvm_plugins = [
  '<str>',
  '<str>',
  ...,
]
default: []

A list of JVM-based protoc plugins to invoke when generating Scala code from protobuf files. The format for each plugin specifier is NAME=ARTIFACT where NAME is the name of the plugin and ARTIFACT is either the address of a jvm_artifact target or the colon-separated Maven coordinate for the plugin's jar artifact.

For example, to invoke the fs2-grpc protoc plugin, the following option would work: --scalapb-jvm-plugins=fs2=org.typelevel:fs2-grpc-codegen_2.12:2.3.1. (Note: you would also need to set --scalapb-runtime-dependencies appropriately to include the applicable runtime libraries for your chosen protoc plugins.)

runtime_dependencies​

--scalapb-runtime-dependencies="[<target_option>, <target_option>, ...]"
PANTS_SCALAPB_RUNTIME_DEPENDENCIES
pants.toml
[scalapb]
runtime_dependencies = [
  <target_option>,
  <target_option>,
  ...,
]
default: []

A list of addresses to jvm_artifact targets for the runtime dependencies needed for generated Scala code to work. For example, ['3rdparty/jvm:scalapb-runtime']. These dependencies will be automatically added to every protobuf_sources target. At the very least, this option must be set to a jvm_artifact for the com.thesamet.scalapb:scalapb-runtime_SCALAVER:0.11.6 runtime library.

Advanced options​

artifacts​

--scalapb-artifacts="['<str>', '<str>', ...]"
PANTS_SCALAPB_ARTIFACTS
pants.toml
[scalapb]
artifacts = [
  '<str>',
  '<str>',
  ...,
]
default: 
[
  "com.thesamet.scalapb:scalapbc_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 [scalapb].version option.

lockfile​

--scalapb-lockfile=<str>
PANTS_SCALAPB_LOCKFILE
pants.toml
[scalapb]
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.11.1/src/python/pants/backend/codegen/protobuf/scala/scalapbc.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 /home/josh/work/scie-pants/dist/pants jvm-generate-lockfiles --resolve=scalapb.

version​

--scalapb-version=<str>
PANTS_SCALAPB_VERSION
pants.toml
[scalapb]
version = <str>
default: 0.11.6

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

Deprecated options​

None

None