ext-fmt/support/bazel
2024-01-10 15:52:54 -08:00
..
.bazelversion Extend Bazel build support to bzlmod (#3792) 2024-01-09 11:27:44 -08:00
BUILD.bazel Bazel support: Switch to globbing to collect header files 2024-01-10 15:52:54 -08:00
MODULE.bazel Extend Bazel build support to bzlmod (#3792) 2024-01-09 11:27:44 -08:00
README.md Extend Bazel build support to bzlmod (#3792) 2024-01-09 11:27:44 -08:00
WORKSPACE.bazel Add basic support for Bazel (#2505) 2021-09-24 13:17:26 -07:00

Bazel support

To get Bazel working with {fmt} you can copy the files BUILD.bazel, MODULE.bazel, WORKSPACE.bazel, and .bazelversion from this folder (support/bazel) to the root folder of this project. This way {fmt} gets bazelized and can be used with Bazel (e.g. doing a bazel build //... on {fmt}).

Using {fmt} as a dependency

Using Bzlmod

The Bazel Central Registry provides support for {fmt}.

For instance, to use {fmt} add to your MODULE.bazel file:

bazel_dep(name = "fmt", version = "10.2.1")

For a live-at-head approach, you can copy the contents of this repository and move the Bazel-related build files to the root folder of this project as described above and make use of local_path_override, e.g.:

local_path_override(
    module_name = "fmt",
    path = "../third_party/fmt",
)

WORKSPACE system

The following minimal example shows how to use {fmt} as a dependency within a Bazel project, that uses the traditional, repository-focused WORKSPACE system. Note that in the long term Bazel will only support Bzlmod.

The following file structure is assumed:

example
├── BUILD.bazel
├── main.cpp
└── WORKSPACE.bazel

main.cpp:

#include "fmt/core.h"

int main() {
  fmt::print("The answer is {}\n", 42);
}

The expected output of this example is The answer is 42.

WORKSPACE.bazel:

load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")

git_repository(
    name = "fmt",
    branch = "master",
    remote = "https://github.com/fmtlib/fmt",
    patch_cmds = [
        "mv support/bazel/.bazelversion .bazelversion",
        "mv support/bazel/BUILD.bazel BUILD.bazel",
        "mv support/bazel/WORKSPACE.bazel WORKSPACE.bazel",
    ],
    # Windows-related patch commands are only needed in the case MSYS2 is not installed.
    # More details about the installation process of MSYS2 on Windows systems can be found here:
    # https://docs.bazel.build/versions/main/install-windows.html#installing-compilers-and-language-runtimes
    # Even if MSYS2 is installed the Windows related patch commands can still be used.
    patch_cmds_win = [
        "Move-Item -Path support/bazel/.bazelversion -Destination .bazelversion",
        "Move-Item -Path support/bazel/BUILD.bazel -Destination BUILD.bazel",
        "Move-Item -Path support/bazel/WORKSPACE.bazel -Destination WORKSPACE.bazel",
    ],
)

In the WORKSPACE file, the {fmt} GitHub repository is fetched. Using the attribute patch_cmds the files BUILD.bazel, WORKSPACE.bazel, and .bazelversion are moved to the root of the {fmt} repository. This way the {fmt} repository is recognized as a bazelized workspace.

BUILD.bazel:

cc_binary(
    name = "Demo",
    srcs = ["main.cpp"],
    deps = ["@fmt"],
)

The BUILD file defines a binary named Demo that has a dependency to {fmt}.

To execute the binary you can run bazel run //:Demo.