Fix Scalafmt default_config docs for WORKSPACE
#1734
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Makes it clear that `WORKSPACE` users must use a target `Label` string with the `default_config` option for the `scalafmt` argument of `scala_toolchains`. Notes that the specified config file must exist within a package, including but not limited to having a `BUILD` file in the repository root. --- @gergelyfabian noticed this while building gergelyfabian/bazel-scala-example after bazel-contrib#1730 landed. This isn't fixable in code. With this call: ```py scala_toolchains( # Other toolchains... scalafmt = {"default_config": ".scalafmt.conf"}, ) ``` - `scala_toolchains` looks for the file under `external/.scalafmt.conf`. - Updating `scala_toolchains` to wrap `default_config` in a `Label` makes it relative to `@rules_scala//scala`. This because `scala_toolchains` resides in `@rules_scala//scala:toolchains.bzl`. - `native.package_relative_label` is only available when called from a `BUILD` file. Hence `default_config` values under `WORKSPACE` must be valid target labels. The problem doesn't exist under Bzlmod; plain file paths will work fine, so long as a `BUILD` file exists at the repository root.
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Makes it clear that
WORKSPACEusers must use a targetLabelstring with thedefault_configoption for thescalafmtargument ofscala_toolchains. Notes that the specified config file must exist within a package, including but not limited to having aBUILDfile in the repository root.Motivation
@gergelyfabian noticed this while building gergelyfabian/bazel-scala-example after #1730 landed.
This isn't fixable in code. With this call:
scala_toolchainslooks for the file underexternal/.scalafmt.conf.Updating
scala_toolchainsto wrapdefault_configin aLabelmakes it relative to@rules_scala//scala. This becausescala_toolchainsresides in@rules_scala//scala:toolchains.bzl.native.package_relative_labelis only available when called from aBUILDfile.Hence
default_configvalues underWORKSPACEmust be valid target labels.The problem doesn't exist under Bzlmod; plain file paths will work fine, so long as a
BUILDfile exists at the repository root.