Skip to main content
Version: 2.24 (prerelease)

experimental-bsp

pants experimental-bsp [args]

Setup repository for Build Server Protocol (https://build-server-protocol.github.io/).

Backend: pants.backend.experimental.bsp

Config section: [experimental-bsp]

Basic options​

groups_config_files​

--experimental-bsp-groups-config-files="[<file_option>, <file_option>, ...]"
PANTS_EXPERIMENTAL_BSP_GROUPS_CONFIG_FILES
pants.toml
[experimental-bsp]
groups_config_files = [
    <file_option>,
    <file_option>,
    ...,
]
default: []

A list of config files that define groups of Pants targets to expose to IDEs via Build Server Protocol.

Pants generally uses fine-grained targets to define the components of a build (in many cases on a file-by-file basis). Many IDEs, however, favor coarse-grained targets that contain large numbers of source files. To accommodate this distinction, the Pants BSP server will compute a set of BSP build targets to use from the groups specified in the config files set for this option. Each group will become one or more BSP build targets.

Each config file is a TOML file with a groups dictionary with the following format for an entry:

# The dictionary key is used to identify the group. It must be unique.
[groups.ID1]:
# One or more Pants address specs defining what targets to include in the group.
addresses = [
  "src/jvm::",
  "tests/jvm::",
]
# Filter targets to a specific resolve. Targets in a group must be from a single resolve.
# Format of filter is `TYPE:RESOLVE_NAME`. The only supported TYPE is `jvm`. RESOLVE_NAME must be
# a valid resolve name.
resolve = "jvm:jvm-default"
display_name = "Display Name" # (Optional) Name shown to the user in the IDE.
base_directory = "path/from/build/root" # (Optional) Hint to the IDE for where the build target should "live."

Pants will merge the contents of the config files together. If the same ID is used for a group definition, in multiple config files, the definition in the latter config file will take effect.

Advanced options​

runner_env_vars​

--experimental-bsp-runner-env-vars="['<str>', '<str>', ...]"
PANTS_EXPERIMENTAL_BSP_RUNNER_ENV_VARS
pants.toml
[experimental-bsp]
runner_env_vars = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "PATH"
]

Environment variables to set in the BSP runner script when setting up BSP in a repository. Entries are either strings in the form ENV_VAR=value to set an explicit value; or just ENV_VAR to copy the value from Pants' own environment when the experimental-bsp goal was run.

This option only takes effect when the BSP runner script is written. If the option changes, you must run pants experimental-bsp again to write a new copy of the BSP runner script.

Note: The environment variables passed to the Pants BSP server will be those set for your IDE and not your shell. For example, on macOS, the IDE is generally launched by launchd after clicking on a Dock icon, and not from the shell. Thus, any environment variables set for your shell will likely not be seen by the Pants BSP server. At the very least, on macOS consider writing an explicit PATH into the BSP runner script via this option.

server​

--[no-]experimental-bsp-server
PANTS_EXPERIMENTAL_BSP_SERVER
pants.toml
[experimental-bsp]
server = <bool>
default: False

Run the Build Server Protocol server. Pants will receive BSP RPC requests via the console. This should only ever be invoked via the IDE.

Deprecated options​

None

None