Nim rules for Bazel

Installation

rules_nim has not been yet published to BCR. Please add following git_override to your MODULE.bazel:

bazel_dep(name = "rules_nim")

git_override(
    module_name = "rules_nim",
    remote = "https://github.com/kczulko/rules_nim",
    commit = PUT_SPECIFIC_COMMIT_HERE,
)

# Nim toolchain registration - choose one of supported Nim versions.
nim = use_extension("@rules_nim//nim:extensions.bzl", "nim")
nim.toolchain(nim_version = "2.2.0")
use_repo(nim, "nim_toolchains")
register_toolchains("@nim_toolchains//:all")

Public API

Rules

• nim_module - Creates a module from a set of *.nim files.
• nim_cc_binary - Creates executable binary from a Nim code.
• nim_cc_library - Creates a cc_library target from a Nim code.
• nim_cc_test - Creates test executable from a Nim code.
• nimble_lock_update - Updates nimble.lock file with an integrity values.

Repository rules

• nimble_lock - Gets dependencies from nimble.lock (native Bazel repository cache support).
• nimble_install - Gets dependencies through running nimble executable (no caching).

Usage examples

Check the e2e examples directory: - nimble - Shows the usage of rules_nim for a nimble project. - numericalnim - Shows the usage of rules_nim for a numericalnim project. - nim_cc_binary - Simple example of nim_cc_binary usage. - nim_cc_library - Simple example of nim_cc_library usage. - nim_cc_test - Simple example of nim_cc_test usage. - c_invocation - Shows the backend C invocation in Nim. - nim_invocation_from_c - Shows the Nim invocation from C. - cross compilation - Shows cross-compilation example for aarch64 target platform.

Hermeticity

nim compiler tends to fully resolve symbolic links which may lead to a non-hermetic issues for a Bazel build definitions. To prevent such situations, it is highly recommended to enable --experimental_use_hermetic_linux_sandbox flag for a local build executions. See nimble e2e and its .bazelrc as the example.