fork/rules_rust

git clone https://git.julia.blue/fork/rules_rust

UebelAndreAdded bzlmod support to all extension rules. (#3037)a7aba2d0

main
5.5 KiB231 linesraw
1load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
2load("@stardoc//stardoc:stardoc.bzl", "stardoc")
3load("//:page.bzl", "gen_header", "page")
4
5package(default_visibility = ["//visibility:private"])
6
7bzl_library(
8    name = "docs_deps",
9    srcs = [
10        "@bazel_tools//tools:bzl_srcs",
11    ],
12    deps = [
13        "@bazel_skylib//lib:paths",
14        "@bazel_skylib//lib:selects",
15        "@bazel_skylib//lib:structs",
16        "@bazel_skylib//rules:common_settings",
17    ],
18)
19
20bzl_library(
21    name = "all_docs",
22    deps = [
23        ":docs_deps",
24        "@rules_rust//cargo:bzl_lib",
25        "@rules_rust//crate_universe:bzl_lib",
26        "@rules_rust//rust:bzl_lib",
27        "@rules_rust_bindgen//:bzl_lib",
28        "@rules_rust_prost//:bzl_lib",
29        "@rules_rust_protobuf//:bzl_lib",
30        "@rules_rust_wasm_bindgen//:bzl_lib",
31    ],
32)
33
34PAGES = dict([
35    page(
36        name = "cargo",
37        symbols = [
38            "cargo_bootstrap_repository",
39            "cargo_build_script",
40            "cargo_dep_env",
41            "cargo_env",
42        ],
43    ),
44    page(
45        name = "rust",
46        symbols = [
47            "rust_binary",
48            "rust_library",
49            "rust_library_group",
50            "rust_static_library",
51            "rust_shared_library",
52            "rust_proc_macro",
53            "rust_test",
54            "rust_test_suite",
55            "error_format",
56            "extra_rustc_flag",
57            "extra_rustc_flags",
58            "capture_clippy_output",
59        ],
60    ),
61    page(
62        name = "providers",
63        symbols = [
64            "CrateInfo",
65            "DepInfo",
66            "StdLibInfo",
67        ],
68    ),
69    page(
70        name = "rust_analyzer",
71        header_template = ":rust_analyzer.vm",
72        symbols = [
73            "rust_analyzer_aspect",
74            "rust_analyzer_toolchain",
75        ],
76    ),
77    page(
78        name = "rust_clippy",
79        header_template = ":rust_clippy.vm",
80        symbols = [
81            "rust_clippy",
82            "rust_clippy_aspect",
83        ],
84    ),
85    page(
86        name = "rust_doc",
87        symbols = [
88            "rust_doc",
89            "rust_doc_test",
90        ],
91    ),
92    page(
93        name = "rust_fmt",
94        header_template = ":rust_fmt.vm",
95        symbols = [
96            "rustfmt_aspect",
97            "rustfmt_test",
98            "rustfmt_toolchain",
99        ],
100    ),
101    page(
102        name = "rust_repositories",
103        symbols = [
104            "rules_rust_dependencies",
105            "rust_analyzer_toolchain_repository",
106            "rust_register_toolchains",
107            "rust_repositories",
108            "rust_repository_set",
109            "rust_stdlib_filegroup",
110            "rust_toolchain_repository_proxy",
111            "rust_toolchain_repository",
112            "rust_toolchain_tools_repository",
113            "rust_toolchain",
114        ],
115    ),
116    page(
117        name = "settings",
118        symbols = [
119            "incompatible_flag",
120            "fail_when_enabled",
121        ],
122    ),
123])
124
125# Generate headers for each page
126[gen_header(page = p) for p in PAGES.values()]
127
128[
129    stardoc(
130        name = "%s_md" % k,
131        out = "%s.md" % k,
132        header_template = ":%s_gen_header_vm" % k,
133        input = ":symbols.bzl",
134        symbol_names = PAGES[k].symbols,
135        deps = [":all_docs"],
136    )
137    for k in PAGES.keys()
138]
139
140genrule(
141    name = "flatten_header_vm",
142    outs = ["flatten_header.vm"],
143    cmd = ">$@ echo '# Rust rules\n\n%s\n'" % "\n".join(
144        sorted(["* [{rule}](#{rule})".format(rule = v) for k in PAGES.keys() for v in PAGES[k].symbols]),
145    ),
146    output_to_bindir = True,
147)
148
149stardoc(
150    name = "flatten_md",
151    out = "flatten.md",
152    header_template = ":flatten_header_vm",
153    input = ":symbols.bzl",
154    symbol_names = sorted([symbol for k in PAGES.keys() for symbol in PAGES[k].symbols]),
155    deps = [":all_docs"],
156)
157
158stardoc(
159    name = "crate_universe_workspace",
160    out = "crate_universe.md",
161    input = "@rules_rust//crate_universe:docs_workspace.bzl",
162    deps = [":all_docs"],
163)
164
165stardoc(
166    name = "crate_universe_bzlmod",
167    out = "crate_universe_bzlmod.md",
168    input = "@rules_rust//crate_universe:docs_bzlmod.bzl",
169    deps = [":all_docs"],
170)
171
172# This target exists to avoid this issue:
173# https://github.com/bazelbuild/rules_cc/issues/279
174bzl_library(
175    name = "bindgen_lib",
176    srcs = [
177        "@com_google_protobuf//:bzl_srcs",
178        "@rules_cc//cc:bzl_srcs",
179    ],
180    deps = [
181        "@com_google_protobuf//bazel:cc_proto_library_bzl",
182        "@rules_cc//cc/common",
183        "@rules_cc//cc/toolchains:toolchain_rules",
184        "@rules_rust_bindgen//:bzl_lib",
185    ],
186)
187
188stardoc(
189    name = "rust_bindgen",
190    out = "rust_bindgen.md",
191    input = "@rules_rust_bindgen//:defs.bzl",
192    deps = [":bindgen_lib"],
193)
194
195stardoc(
196    name = "rust_protobuf",
197    out = "rust_protobuf.md",
198    input = "@rules_rust_protobuf//:defs.bzl",
199    deps = ["@rules_rust_protobuf//:bzl_lib"],
200)
201
202stardoc(
203    name = "rust_prost",
204    out = "rust_prost.md",
205    input = "@rules_rust_prost//:defs.bzl",
206    deps = ["@rules_rust_prost//:bzl_lib"],
207)
208
209stardoc(
210    name = "rust_wasm_bindgen",
211    out = "rust_wasm_bindgen.md",
212    input = "@rules_rust_wasm_bindgen//:defs.bzl",
213    deps = ["@rules_rust_wasm_bindgen//:bzl_lib"],
214)
215
216stardoc(
217    name = "rust_wasm_bindgen_rules_js",
218    out = "rust_wasm_bindgen_rules_js.md",
219    input = "@rules_rust_wasm_bindgen//rules_js:defs.bzl",
220    deps = ["@rules_rust_wasm_bindgen//rules_js:bzl_lib"],
221)
222
223sh_binary(
224    name = "update_docs",
225    srcs = ["update_docs.sh"],
226)
227
228sh_binary(
229    name = "test_docs",
230    srcs = ["test_docs.sh"],
231)