Add rust-analyzer toolchains (#60)

Author: dzbarsky

.bazelrc

@@ -9,4 +9,8 @@ common --repo_env=BAZEL_NO_APPLE_CPP_TOOLCHAIN=1
 common --repo_contents_cache=~/bazel_repo_contents_cache
 common --disk_cache=~/bazel_cache
 
+common --@llvm//config:experimental_stub_libgcc_s
+common --enable_platform_specific_config
+common:linux --host_platform=//:local_gnu_platform
+
 common:remote --jobs=800

BUILD.bazel

@@ -17,3 +17,11 @@ license(
     kind = "@package_metadata//licenses/spdx:Apache-2.0",
     text = "LICENSE",
 )
+
+platform(
+    name = "local_gnu_platform",
+    parents = ["@platforms//host"],
+    constraint_values = [
+        "@llvm//constraints/libc:gnu.2.28",
+    ],
+)

MODULE.bazel

@@ -49,7 +49,7 @@ use_repo(
 bazel_dep(name = "bazel_lib", version = "3.0.0")
 bazel_dep(name = "bazel_features", version = "1.32.0")
 bazel_dep(name = "bazel_skylib", version = "1.4.1")
-bazel_dep(name = "package_metadata", version = "0.0.5")
+bazel_dep(name = "package_metadata", version = "0.0.7")
 bazel_dep(name = "platforms", version = "0.0.5")
 bazel_dep(name = "protobuf", version = "34.0.bcr.1", repo_name = "com_google_protobuf")
 bazel_dep(name = "rules_cc", version = "0.2.8")
@@ -61,6 +61,20 @@ tel = use_extension("@aspect_tools_telemetry//:extension.bzl", "telemetry")
 use_repo(tel, "aspect_tools_telemetry_report")
 
 crate = use_extension("//rs:extensions.bzl", "crate")
+crate.from_cargo(
+    name = "rrra",
+    cargo_lock = "//tools/rust_analyzer:Cargo.lock",
+    cargo_toml = "//tools/rust_analyzer:Cargo.toml",
+    platform_triples = [
+        "aarch64-apple-darwin",
+        "aarch64-pc-windows-msvc",
+        "aarch64-unknown-linux-gnu",
+        "x86_64-apple-darwin",
+        "x86_64-pc-windows-msvc",
+        "x86_64-unknown-linux-gnu",
+    ],
+    use_experimental_platforms = True,
+)
 crate.from_cargo(
     name = "rrprd",
     cargo_lock = "//rs/private/prost:Cargo.lock",
@@ -85,6 +99,7 @@ crate.annotation(
     crate = "protoc-gen-tonic",
     gen_binaries = ["protoc-gen-tonic"],
 )
+use_repo(crate, "rrra")
 use_repo(crate, "rrprd")
 
 rules_rust_prost = use_extension("//rs/experimental:rules_rust_prost.bzl", "rules_rust_prost")
@@ -94,3 +109,13 @@ bazel_dep(name = "rules_go", version = "0.59.0", dev_dependency = True)
 bazel_dep(name = "gazelle", version = "0.47.0", dev_dependency = True)
 bazel_dep(name = "bazel_skylib_gazelle_plugin", version = "1.8.2", dev_dependency = True)
 bazel_dep(name = "buildifier_prebuilt", version = "6.1.2", dev_dependency = True)
+
+register_toolchains(
+    "@default_rust_toolchains//:all",
+    dev_dependency = True,
+)
+
+register_toolchains(
+    "@llvm//toolchain:all",
+    dev_dependency = True,
+)

MODULE.bazel.lock

@@ -93,6 +93,18 @@ register_toolchains("@rust_toolchains//:all")
 
 In this mode, keep `use_experimental_platforms = False` (the default) in `crate.from_cargo(...)`.
 
+## rust-analyzer Integration
+
+`rust-analyzer` targets are accessible via either the legacy `@rules_rust` paths or `@rules_rs` paths.
+
+Example usage:
+
+```bzl
+bazel run @rules_rs//tools/rust_analyzer:gen_rust_project -- --help
+```
+
+See https://bazelbuild.github.io/rules_rust/rust_analyzer.html#vscode and the sections below that for more setup instructions.
+
 ## Dependency Resolution
 
 `rules_rs` uses its own `crate_universe` implementation through `crate.from_cargo`:
@@ -225,6 +237,7 @@ At minimum, set an explicit `--host_platform` that adds your ABI constraint on t
 `.bazelrc`:
 
 ```bazelrc
+common --enable_platform_specific_config
 common:linux --host_platform=//platforms:local_gnu
 common:windows --host_platform=//platforms:local_windows_msvc
 ```

README.md

@@ -31,9 +31,9 @@ def _rules_rust_impl(mctx):
 
     http_archive(
         name = "rules_rust",
-        integrity = "sha256-xT7zyL35CDK5b7iKdKL+WchslRZsnXDXuBMHiqVD0ps=",
-        strip_prefix = "rules_rust-7ed8a24a37be47378b8a266ae3016148b9cb5c49",
-        url = "https://github.com/hermeticbuild/rules_rust/archive/7ed8a24a37be47378b8a266ae3016148b9cb5c49.tar.gz",
+        integrity = "sha256-vZfWz/bMaLs3Q/xRtj0qEVqQa47Xwd2iK6GgYJZqgUU=",
+        strip_prefix = "rules_rust-e1ed0e436cb319700887823c7df421c5684bc6da",
+        url = "https://github.com/hermeticbuild/rules_rust/archive/e1ed0e436cb319700887823c7df421c5684bc6da.tar.gz",
         patches = patches,
         patch_strip = strip,
     )

rs/experimental/rules_rust.bzl

@@ -13,6 +13,18 @@ bzl_library(
     ],
 )
 
+bzl_library(
+    name = "declare_rust_analyzer_toolchains",
+    srcs = ["declare_rust_analyzer_toolchains.bzl"],
+    deps = [
+        ":toolchain_utils",
+        "//rs/experimental/platforms:triples",
+        "@rules_rust//rust:bzl_lib",
+        "@rules_rust//rust/platform:bzl_lib",
+        "@rules_rust//rust/private:bzl_lib",
+    ],
+)
+
 bzl_library(
     name = "declare_rustfmt_toolchains",
     srcs = ["declare_rustfmt_toolchains.bzl"],
@@ -33,7 +45,9 @@ bzl_library(
         "//rs/private:cargo_repository",
         "//rs/private:clippy_repository",
         "//rs/private:host_tools_repository",
+        "//rs/private:rust_analyzer_repository",
         "//rs/private:rust_repository_utils",
+        "//rs/private:rust_src_repository",
         "//rs/private:rustc_repository",
         "//rs/private:rustfmt_repository",
         "//rs/private:stdlib_repository",

rs/experimental/toolchains/BUILD.bazel

@@ -0,0 +1,72 @@
+load("@rules_rust//rust:toolchain.bzl", "rust_analyzer_toolchain")
+load("@rules_rust//rust/platform:triple.bzl", _parse_triple = "triple")
+load(
+    "@rules_rust//rust/private:repository_utils.bzl",
+    "includes_rust_analyzer_proc_macro_srv",
+)
+load("//rs/experimental/platforms:triples.bzl", "SUPPORTED_EXEC_TRIPLES")
+load("//rs/experimental/toolchains:toolchain_utils.bzl", "sanitize_version")
+
+def _channel(version):
+    if version.startswith("nightly"):
+        return "nightly"
+    if version.startswith("beta"):
+        return "beta"
+    return "stable"
+
+def _parse_version(version):
+    if "/" in version:
+        return version.split("/", 1)
+    return version, None
+
+def declare_rust_analyzer_toolchains(
+        *,
+        version,
+        rust_analyzer_version,
+        execs = SUPPORTED_EXEC_TRIPLES):
+    version_key = sanitize_version(version)
+    rust_analyzer_version_key = sanitize_version(rust_analyzer_version)
+    channel = _channel(version)
+    rust_analyzer_base_version, rust_analyzer_iso_date = _parse_version(rust_analyzer_version)
+
+    for triple in execs:
+        exec_triple = _parse_triple(triple)
+        triple_suffix = exec_triple.system + "_" + exec_triple.arch
+
+        rustc_repo_label = "@rustc_{}_{}//:".format(triple_suffix, rust_analyzer_version_key)
+        rust_analyzer_repo_label = "@rust_analyzer_{}_{}//:".format(triple_suffix, rust_analyzer_version_key)
+        rust_src_repo_label = "@rust_src_{}//lib/rustlib/src:rustc_srcs".format(rust_analyzer_version_key)
+
+        rust_analyzer_toolchain_name = "{}_{}_{}_rust_analyzer_toolchain".format(
+            exec_triple.system,
+            exec_triple.arch,
+            version_key,
+        )
+
+        rust_analyzer_toolchain_kwargs = dict(
+            name = rust_analyzer_toolchain_name,
+            rust_analyzer = "{}rust_analyzer".format(rust_analyzer_repo_label),
+            rustc = "{}rustc".format(rustc_repo_label),
+            rustc_srcs = rust_src_repo_label,
+            visibility = ["//visibility:public"],
+        )
+
+        if includes_rust_analyzer_proc_macro_srv(rust_analyzer_base_version, rust_analyzer_iso_date):
+            rust_analyzer_toolchain_kwargs["proc_macro_srv"] = "{}rust_analyzer_proc_macro_srv".format(rustc_repo_label)
+
+        rust_analyzer_toolchain(**rust_analyzer_toolchain_kwargs)
+
+        native.toolchain(
+            name = "{}_{}_rust_analyzer_{}".format(exec_triple.system, exec_triple.arch, version_key),
+            exec_compatible_with = [
+                "@platforms//os:" + exec_triple.system,
+                "@platforms//cpu:" + exec_triple.arch,
+            ],
+            target_compatible_with = [],
+            target_settings = [
+                "@rules_rust//rust/toolchain/channel:" + channel,
+            ],
+            toolchain = rust_analyzer_toolchain_name,
+            toolchain_type = "@rules_rust//rust/rust_analyzer:toolchain_type",
+            visibility = ["//visibility:public"],
+        )

rs/experimental/toolchains/declare_rust_analyzer_toolchains.bzl

@@ -12,6 +12,8 @@ load("//rs/experimental/toolchains:toolchain_utils.bzl", "sanitize_triple", "san
 load("//rs/private:cargo_repository.bzl", "cargo_repository")
 load("//rs/private:clippy_repository.bzl", "clippy_repository")
 load("//rs/private:host_tools_repository.bzl", "host_tools_repository")
+load("//rs/private:rust_analyzer_repository.bzl", "rust_analyzer_repository")
+load("//rs/private:rust_src_repository.bzl", "rust_src_repository")
 load("//rs/private:rustc_repository.bzl", "rustc_repository")
 load("//rs/private:rustfmt_repository.bzl", "rustfmt_repository")
 load("//rs/private:stdlib_repository.bzl", "stdlib_repository")
@@ -65,6 +67,10 @@ _TOOLCHAIN_TAG = tag_class(
             doc = "Rustfmt version (e.g. 1.86.0 or nightly/2025-04-03)",
             default = "",
         ),
+        "rust_analyzer_version": attr.string(
+            doc = "Rust-analyzer version (e.g. 1.86.0 or nightly/2025-04-03)",
+            default = "",
+        ),
         "edition": attr.string(
             doc = "Default edition to apply to toolchains.",
             default = _DEFAULT_EDITION,
@@ -106,17 +112,20 @@ def _toolchains_impl(mctx):
             name = _DEFAULT_TOOLCHAIN_REPO_NAME,
             version = _DEFAULT_RUSTC_VERSION,
             rustfmt_version = "",
+            rust_analyzer_version = "",
             edition = _DEFAULT_EDITION,
             extra_rustc_flags = {},
             extra_exec_rustc_flags = {},
         ))
 
     versions = set([])
     rustfmt_versions = set([])
+    rust_analyzer_versions = set([])
 
     for tag in version_tags:
         versions.add(tag.version)
         rustfmt_versions.add(tag.rustfmt_version or tag.version)
+        rust_analyzer_versions.add(tag.rust_analyzer_version or tag.version)
 
     existing_facts = getattr(mctx, "facts", {}) or {}
     pending_downloads = {}
@@ -165,6 +174,17 @@ def _toolchains_impl(mctx):
             for tool_name in ["rustc", "rustfmt"]:
                 _request_sha(tool_name, base_version, iso_date, exec_triple)
 
+    for version in rust_analyzer_versions:
+        base_version, iso_date = _parse_version(version)
+
+        _request_sha("rust-src", base_version, iso_date, None)
+
+        for triple in SUPPORTED_EXEC_TRIPLES:
+            exec_triple = _parse_triple(triple)
+
+            for tool_name in ["rustc", "rust-analyzer"]:
+                _request_sha(tool_name, base_version, iso_date, exec_triple)
+
     # Finish downloads and record facts.
     for archive_path, req in pending_downloads.items():
         req.token.wait()
@@ -182,7 +202,7 @@ def _toolchains_impl(mctx):
     host_arch = _normalize_arch_name(mctx.os.arch)
     host_cargo_repo = None
 
-    for version in versions | rustfmt_versions:
+    for version in versions | rustfmt_versions | rust_analyzer_versions:
         version_key = sanitize_version(version)
         base_version, iso_date = _parse_version(version)
 
@@ -249,6 +269,29 @@ def _toolchains_impl(mctx):
                 rustc_repo_build_file = "@rustc_{}_{}//:BUILD.bazel".format(triple_suffix, version_key),
             )
 
+    for version in rust_analyzer_versions:
+        version_key = sanitize_version(version)
+        base_version, iso_date = _parse_version(version)
+
+        rust_src_repository(
+            name = "rust_src_{}".format(version_key),
+            version = base_version,
+            iso_date = iso_date,
+            sha256 = _sha_for("rust-src", base_version, iso_date, None),
+        )
+
+        for triple in SUPPORTED_EXEC_TRIPLES:
+            exec_triple = _parse_triple(triple)
+            triple_suffix = exec_triple.system + "_" + exec_triple.arch
+
+            rust_analyzer_repository(
+                name = "rust_analyzer_{}_{}".format(triple_suffix, version_key),
+                triple = triple,
+                version = base_version,
+                iso_date = iso_date,
+                sha256 = _sha_for("rust-analyzer", base_version, iso_date, exec_triple),
+            )
+
     host_tools_repository(
         name = "rs_rust_host_tools",
         host_cargo_repo = host_cargo_repo,
@@ -264,10 +307,12 @@ def _toolchains_impl(mctx):
     for tag in version_tags:
         repo_name = tag.name
         rustfmt_version = tag.rustfmt_version or tag.version
+        rust_analyzer_version = tag.rust_analyzer_version or tag.version
         existing = repo_configs.get(repo_name)
         if existing and (
             existing.version != tag.version or
             (existing.rustfmt_version or existing.version) != rustfmt_version or
+            (existing.rust_analyzer_version or existing.version) != rust_analyzer_version or
             existing.edition != tag.edition or
             existing.extra_rustc_flags != tag.extra_rustc_flags or
             existing.extra_exec_rustc_flags != tag.extra_exec_rustc_flags
@@ -280,6 +325,7 @@ def _toolchains_impl(mctx):
                 name = repo_name,
                 version = tag.version,
                 rustfmt_version = rustfmt_version,
+                rust_analyzer_version = rust_analyzer_version,
                 edition = tag.edition,
                 extra_rustc_flags = tag.extra_rustc_flags,
                 extra_exec_rustc_flags = tag.extra_exec_rustc_flags,

rs/experimental/toolchains/module_extension.bzl

@@ -121,6 +121,27 @@ bzl_library(
     ],
 )
 
+bzl_library(
+    name = "rust_analyzer_repository",
+    srcs = ["rust_analyzer_repository.bzl"],
+    visibility = ["//rs:__subpackages__"],
+    deps = [
+        "//rs/private:rust_repository_utils",
+        "@rules_rust//rust/platform:bzl_lib",
+        "@rules_rust//rust/private:bzl_lib",
+    ],
+)
+
+bzl_library(
+    name = "rust_src_repository",
+    srcs = ["rust_src_repository.bzl"],
+    visibility = ["//rs:__subpackages__"],
+    deps = [
+        "@bazel_tools//tools/build_defs/repo:utils.bzl",
+        "@rules_rust//rust/private:bzl_lib",
+    ],
+)
+
 bzl_library(
     name = "rustc_repository",
     srcs = ["rustc_repository.bzl"],
@@ -148,6 +169,7 @@ bzl_library(
     srcs = ["toolchains_repository.bzl"],
     visibility = ["//rs:__subpackages__"],
     deps = [
+        "//rs/experimental/toolchains:declare_rust_analyzer_toolchains",
         "//rs/experimental/toolchains:declare_rustc_toolchains",
         "//rs/experimental/toolchains:declare_rustfmt_toolchains",
     ],