Skip to content

README.md

Latest commit

 

History

History
162 lines (109 loc) · 4.38 KB

README.md

File metadata and controls

162 lines (109 loc) · 4.38 KB
  • ✅ Centralized logic without Bazel module extensions

Directory Structure

├── BUILD.bazel
├── macros.bzl
└── README.md

Key Files

macros.bzl

Defines the main macro to use in projects:

def use_format_targets(fix_name = "format.fix", check_name = "format.check", languages = None):
    ...

This sets up:

  • format.fix — a multi-run rule that applies formatting tools
  • format.check — a test rule that checks formatting

The languages parameter selects which formatters are wired up. Supported values:

Language Formatter
python @aspect_rules_lint//format:ruff
rust @score_tooling//format_checker:rustfmt_with_policies
starlark @buildifier_prebuilt//:buildifier
yaml @aspect_rules_lint//format:yamlfmt
cpp @llvm_toolchain//:clang-format

When languages is omitted, every language except cpp is enabled. C++ is opt-in so that projects without C++ code do not depend on the LLVM toolchain.

MODULE.bazel

Declares this module and includes required dependencies:

module(name = "score_format_checker", version = "0.1.1")

bazel_dep(name = "aspect_rules_lint", version = "1.0.3")
bazel_dep(name = "buildifier_prebuilt", version = "7.3.1")
bazel_dep(name = "score_rust_policies", version = "0.0.2")

Usage

1️⃣ Declare the dependency in your project’s MODULE.bazel:

bazel_dep(name = "score_format_checker", version = "0.1.1")

# If using local source:
local_path_override(
    module_name = "score_format_checker",
    path = "../tooling/format",
)

# Explicit dependencies required by the macro
bazel_dep(name = "aspect_rules_lint", version = "1.0.3")
bazel_dep(name = "buildifier_prebuilt", version = "7.3.1")
bazel_dep(name = "score_rust_policies", version = "0.0.2")

2️⃣ In your project’s BUILD.bazel:

load("@score_format_checker//:macros.bzl", "use_format_targets")

use_format_targets()

This will register two Bazel targets:

  • bazel run //:format.fix — fixes format issues
  • bazel test //:format.check — fails on unformatted files

To control which formatters run, pass an explicit languages list:

# Only check Python and Starlark.
use_format_targets(languages = ["python", "starlark"])

3️⃣ In VS Code settings:

⚠️ First formatting run can be slow!

Add the following entry to .vscode/settings.json:

"rust-analyzer.rustfmt.overrideCommand": [
    "${workspaceFolder}/.vscode/rustfmt.sh"
]

Add .vscode/rustfmt.sh file with +x permissions:

#!/usr/bin/env bash

bazel run @score_tooling//format_checker:rustfmt_with_policies

Rust support

  • Default formatter label: @score_tooling//format_checker:rustfmt_with_policies, which wraps the upstream rustfmt binary with the shared rustfmt.toml policies from score_rust_policies.

C++ support

C++ formatting is opt-in. Enable it by adding cpp to the languages list:

use_format_targets(languages = ["python", "rust", "starlark", "yaml", "cpp"])
  • Formatter label: @llvm_toolchain//:clang-format, which requires the LLVM toolchain (toolchains_llvm) to be available in the consuming module.
  • clang-format runs with --style=file, so a .clang-format configuration file is expected in the repository tree.
  • Because enabling cpp introduces the LLVM dependency, it is excluded from the default language set.

Benefits

✅ Centralized formatting config with local file scope ✅ Consistent developer experience across repositories ✅ Easily pluggable in CI pipelines or Git pre-commit hooks