Skip to main content
Version: 2.23 (prerelease)

scala_sources

Generate a scala_source target for each file in the sources field.

Backend: pants.backend.experimental.scala.bsp

dependencies​

Iterable[str] | None
default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib', 'helloworld/main.py:lib', '3rdparty:reqs#django'].

This augments any dependencies inferred by Pants, such as by analyzing your imports. Use pants dependencies or pants peek on this target to get the final result.

See https://www.pantsbuild.org/2.23/docs/using-pants/key-concepts/targets-and-build-files for more about how addresses are formed, including for generated targets. You can also run pants list :: to find all addresses in your project, or pants list dir to find all addresses defined in that directory.

If the target is in the same BUILD file, you can leave off the BUILD file path, e.g. :tgt instead of helloworld/subdir:tgt. For generated first-party addresses, use ./ for the file path, e.g. ./main.py:tgt; for all other generated targets, use :tgt#generated_name.

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

description​

str | None
default: None

A human-readable description of the target.

Use pants list --documented :: to see all targets with descriptions.

experimental_provides_types​

Iterable[str] | None
default: None

Signals that the specified types should be fulfilled by these source files during dependency inference.

This allows for specific types within packages that are otherwise inferred as belonging to jvm_artifact targets to be unambiguously inferred as belonging to this first-party source.

If a given type is defined, at least one source file captured by this target must actually provide that symbol.

jdk​

str | None
default: None

The major version of the JDK that this target should be built with. If not defined, will default to [jvm].default_source_jdk.

main​

str | None
default: None

.-separated name of the JVM class containing the main() method to be called when executing this target. If not supplied, this will be calculated automatically, either by inspecting the existing manifest (for 3rd-party JARs), or by inspecting the classes inside the JAR, looking for a valid main method. If a value cannot be calculated automatically, you must supply a value for run to succeed.

overrides​

Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None
default: None

Override the field values for generated scala_sources targets.

Expects a dictionary of relative file paths and globs to a dictionary for the overrides. You may either use a string for a single path / glob, or a string tuple for multiple paths / globs. Each override is a dictionary of field names to the overridden value.

For example:

overrides={
    "Foo.scala": {"dependencies": [":files"]},
    "Bar.scala": {"skip_scalafmt": True},
    ("Foo.scala", "Bar.scala"): {"tags": ["linter_disabled"]},
}"

File paths and globs are relative to the BUILD file's directory. Every overridden file is validated to belong to this target's sources field.

If you'd like to override a field's value for every scala_sources target generated by this target, change the field directly on this target rather than using the overrides field.

You can specify the same file name in multiple keys, so long as you don't override the same field more than one time for the file.

resolve​

str | None
default: None

The resolve from [jvm].resolves to use when compiling this target.

If not defined, will default to [jvm].default_resolve.

scalac_plugins​

Iterable[str] | None
default: None

The names of Scala plugins that this source file requires.

The plugin must be defined by a corresponding scalac_plugin AND jvm_artifact target, and must be present in this target's resolve's lockfile.

If not specified, this will default to the plugins specified in [scalac].plugins_for_resolve for this target's resolve.

skip_scalafix​

bool
default: False
backend: pants.backend.experimental.scala.lint.scalafix

If true, don't run scalafix on this target's code.

skip_scalafmt​

bool
default: False
backend: pants.backend.experimental.scala.lint.scalafmt

If true, don't run scalafmt on this target's code.

sources​

Iterable[str] | None
default: ('*.scala', '!*Test.scala', '!*Spec.scala', '!*Suite.scala')

A list of files and globs that belong to this target.

Paths are relative to the BUILD file's directory. You can ignore files/globs by prefixing them with !.

Example: sources=['Example.scala', 'New*.scala', '!OldIgnore.scala']

tags​

Iterable[str] | None
default: None

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run pants --tag='integration_test' test :: to only run on targets with that tag.