Skip to content

Fix Scalafmt default_config docs for WORKSPACE #1734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2025
Merged

Fix Scalafmt default_config docs for WORKSPACE #1734

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/phase_scalafmt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,18 +72,21 @@ bazel run <TARGET>.format-test
to check the format (without modifying source code).

The extension provides a default configuration. To use a custom configuration,
pass its path or target Label to the toolchain configuration:
pass its path or target `Label` string to the toolchain configuration. The file
must exist within a package; the following examples presume a `BUILD` file
exists in the repository root:

```py
# MODULE.bazel
scala_deps.scalafmt(
default_config = "path/to/my/custom/scalafmt.conf",
default_config = "path/to/my/custom/.scalafmt.conf",
)

# WORKSPACE
scala_toolchains(
# Other toolchains settings...
scalafmt = {"default_config": "path/to/my/custom/scalafmt.conf"},
# This _must_ be a target Label under WORKSPACE.
scalafmt = {"default_config": "//:path/to/my/custom/.scalafmt.conf"},
)
```

Expand Down