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
default: False
If true, don't use scalafmt when running pants fmt and pants lint.
Advanced options¶
version¶
--scalafmt-version=<str>
PANTS_SCALAFMT_VERSION
default: 3.2.1
Version string for the tool. This is available for substitution in the [scalafmt].artifacts option by including the string {version}.
artifacts¶
--scalafmt-artifacts="['<str>', '<str>', ...]"
PANTS_SCALAFMT_ARTIFACTS
default:
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.
lockfile¶
--scalafmt-lockfile=<str>
PANTS_SCALAFMT_LOCKFILE
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.18.0.dev6/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 jvm-generate-lockfiles --resolve=scalafmt.
jvm_options¶
--scalafmt-jvm-options="['<str>', '<str>', ...]"
PANTS_SCALAFMT_JVM_OPTIONS
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.
Deprecated options¶
None