Skip to main content
Version: 2.25 (dev)

scalafmt

scalafmt (https://scalameta.org/scalafmt/)

Backend: pants.backend.experimental.scala.lint.scalafmt

Config section: [scalafmt]

Basic options​

skip​

--[no-]scalafmt-skip
PANTS_SCALAFMT_SKIP
pants.toml
[scalafmt]
skip = <bool>
default: False

If true, don't use scalafmt when running pants fmt and pants lint.

Advanced options​

artifacts​

--scalafmt-artifacts="['<str>', '<str>', ...]"
PANTS_SCALAFMT_ARTIFACTS
pants.toml
[scalafmt]
artifacts = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "org.scalameta:scalafmt-cli_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 [scalafmt].version option.

config_file_name​

--scalafmt-config-file-name=<str>
PANTS_SCALAFMT_CONFIG_FILE_NAME
pants.toml
[scalafmt]
config_file_name = <str>
default: .scalafmt.conf

Name of a config file understood by scalafmt (https://scalameta.org/scalafmt/docs/configuration.html). The plugin will search the ancestors of each directory in which Scala files are found for a config file of this name.

jvm_options​

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

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

--scalafmt-lockfile=<str>
PANTS_SCALAFMT_LOCKFILE
pants.toml
[scalafmt]
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.24.0.dev3/src/python/pants/backend/scala/lint/scalafmt/scalafmt.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 generate-lockfiles --resolve=scalafmt.

orphan_files_behavior​

--scalafmt-orphan-files-behavior=<OrphanFilepathConfigBehavior>
PANTS_SCALAFMT_ORPHAN_FILES_BEHAVIOR
pants.toml
[scalafmt]
orphan_files_behavior = <OrphanFilepathConfigBehavior>
one of: ignore, error, warn
default: error

Whether to ignore, error or show a warning when files are found that are not covered by the config file provided in [scalafmt].config_file_name setting.

version​

--scalafmt-version=<str>
PANTS_SCALAFMT_VERSION
pants.toml
[scalafmt]
version = <str>
default: 3.2.1

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

Deprecated options​

None

None