Skip to content

Commit d7c532c

Browse files
authored
Updated wasm_bindgen dependencies API (bazelbuild#1313)
* Updated wasm_bindgen dependencies API * Regenerate documentation
1 parent fb4d554 commit d7c532c

File tree

7 files changed

+98
-28
lines changed

7 files changed

+98
-28
lines changed

docs/BUILD.bazel

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,8 @@ PAGES = dict([
134134
name = "rust_wasm_bindgen",
135135
header_template = ":rust_wasm_bindgen.vm",
136136
symbols = [
137-
"rust_wasm_bindgen_repositories",
137+
"rust_wasm_bindgen_dependencies",
138+
"rust_wasm_bindgen_register_toolchains",
138139
"rust_wasm_bindgen_toolchain",
139140
"rust_wasm_bindgen",
140141
],

docs/WORKSPACE.bazel

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,15 @@ load("@rules_rust//proto:transitive_repositories.bzl", "rust_proto_transitive_re
2323

2424
rust_proto_transitive_repositories()
2525

26-
load("@rules_rust//wasm_bindgen:repositories.bzl", "rust_wasm_bindgen_repositories")
26+
load(
27+
"@rules_rust//wasm_bindgen:repositories.bzl",
28+
"rust_wasm_bindgen_dependencies",
29+
"rust_wasm_bindgen_register_toolchains",
30+
)
31+
32+
rust_wasm_bindgen_dependencies()
2733

28-
rust_wasm_bindgen_repositories()
34+
rust_wasm_bindgen_register_toolchains()
2935

3036
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
3137

docs/flatten.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@
4242
* [rust_toolchain_repository](#rust_toolchain_repository)
4343
* [rust_toolchain_repository_proxy](#rust_toolchain_repository_proxy)
4444
* [rust_wasm_bindgen](#rust_wasm_bindgen)
45-
* [rust_wasm_bindgen_repositories](#rust_wasm_bindgen_repositories)
45+
* [rust_wasm_bindgen_dependencies](#rust_wasm_bindgen_dependencies)
46+
* [rust_wasm_bindgen_register_toolchains](#rust_wasm_bindgen_register_toolchains)
4647
* [rust_wasm_bindgen_toolchain](#rust_wasm_bindgen_toolchain)
4748
* [rustfmt_aspect](#rustfmt_aspect)
4849
* [rustfmt_test](#rustfmt_test)
@@ -1707,22 +1708,39 @@ rust_test_suite(
17071708
| <a id="rust_test_suite-kwargs"></a>kwargs | Additional keyword arguments for the underyling [rust_test](#rust_test) targets. The <code>tags</code> argument is also passed to the generated <code>test_suite</code> target. | none |
17081709

17091710

1710-
<a id="#rust_wasm_bindgen_repositories"></a>
1711+
<a id="#rust_wasm_bindgen_dependencies"></a>
17111712

1712-
## rust_wasm_bindgen_repositories
1713+
## rust_wasm_bindgen_dependencies
17131714

17141715
<pre>
1715-
rust_wasm_bindgen_repositories(<a href="#rust_wasm_bindgen_repositories-register_default_toolchain">register_default_toolchain</a>)
1716+
rust_wasm_bindgen_dependencies()
17161717
</pre>
17171718

1718-
Declare dependencies needed for [rust_wasm_bindgen](#rust_wasm_bindgen).
1719+
Declare dependencies needed for the `rules_rust` [wasm-bindgen][wb] rules.
1720+
1721+
[wb]: https://github.com/rustwasm/wasm-bindgen
1722+
1723+
1724+
1725+
<a id="#rust_wasm_bindgen_register_toolchains"></a>
1726+
1727+
## rust_wasm_bindgen_register_toolchains
1728+
1729+
<pre>
1730+
rust_wasm_bindgen_register_toolchains(<a href="#rust_wasm_bindgen_register_toolchains-register_toolchains">register_toolchains</a>)
1731+
</pre>
1732+
1733+
Registers the default toolchains for the `rules_rust` [wasm-bindgen][wb] rules.
1734+
1735+
[wb]: https://github.com/rustwasm/wasm-bindgen
1736+
17191737

17201738
**PARAMETERS**
17211739

17221740

17231741
| Name | Description | Default Value |
17241742
| :------------- | :------------- | :------------- |
1725-
| <a id="rust_wasm_bindgen_repositories-register_default_toolchain"></a>register_default_toolchain | If True, the default [rust_wasm_bindgen_toolchain](#rust_wasm_bindgen_toolchain) (<code>@rules_rust//wasm_bindgen:default_wasm_bindgen_toolchain</code>) is registered. This toolchain requires a set of dependencies that were generated using [cargo raze](https://github.com/google/cargo-raze). These will also be loaded. | <code>True</code> |
1743+
| <a id="rust_wasm_bindgen_register_toolchains-register_toolchains"></a>register_toolchains | Whether or not to register toolchains. | <code>True</code> |
17261744

17271745

17281746
<a id="#rust_analyzer_aspect"></a>

docs/rust_wasm_bindgen.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
<!-- Generated with Stardoc: http://skydoc.bazel.build -->
22
# Rust Wasm Bindgen
33

4-
* [rust_wasm_bindgen_repositories](#rust_wasm_bindgen_repositories)
4+
* [rust_wasm_bindgen_dependencies](#rust_wasm_bindgen_dependencies)
5+
* [rust_wasm_bindgen_register_toolchains](#rust_wasm_bindgen_register_toolchains)
56
* [rust_wasm_bindgen_toolchain](#rust_wasm_bindgen_toolchain)
67
* [rust_wasm_bindgen](#rust_wasm_bindgen)
78

@@ -109,21 +110,38 @@ For additional information, see the [Bazel toolchains documentation][toolchains]
109110
| <a id="rust_wasm_bindgen_toolchain-bindgen"></a>bindgen | The label of a <code>wasm-bindgen-cli</code> executable. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | None |
110111

111112

112-
<a id="#rust_wasm_bindgen_repositories"></a>
113+
<a id="#rust_wasm_bindgen_dependencies"></a>
113114

114-
## rust_wasm_bindgen_repositories
115+
## rust_wasm_bindgen_dependencies
115116

116117
<pre>
117-
rust_wasm_bindgen_repositories(<a href="#rust_wasm_bindgen_repositories-register_default_toolchain">register_default_toolchain</a>)
118+
rust_wasm_bindgen_dependencies()
118119
</pre>
119120

120-
Declare dependencies needed for [rust_wasm_bindgen](#rust_wasm_bindgen).
121+
Declare dependencies needed for the `rules_rust` [wasm-bindgen][wb] rules.
122+
123+
[wb]: https://github.com/rustwasm/wasm-bindgen
124+
125+
126+
127+
<a id="#rust_wasm_bindgen_register_toolchains"></a>
128+
129+
## rust_wasm_bindgen_register_toolchains
130+
131+
<pre>
132+
rust_wasm_bindgen_register_toolchains(<a href="#rust_wasm_bindgen_register_toolchains-register_toolchains">register_toolchains</a>)
133+
</pre>
134+
135+
Registers the default toolchains for the `rules_rust` [wasm-bindgen][wb] rules.
136+
137+
[wb]: https://github.com/rustwasm/wasm-bindgen
138+
121139

122140
**PARAMETERS**
123141

124142

125143
| Name | Description | Default Value |
126144
| :------------- | :------------- | :------------- |
127-
| <a id="rust_wasm_bindgen_repositories-register_default_toolchain"></a>register_default_toolchain | If True, the default [rust_wasm_bindgen_toolchain](#rust_wasm_bindgen_toolchain) (<code>@rules_rust//wasm_bindgen:default_wasm_bindgen_toolchain</code>) is registered. This toolchain requires a set of dependencies that were generated using [cargo raze](https://github.com/google/cargo-raze). These will also be loaded. | <code>True</code> |
145+
| <a id="rust_wasm_bindgen_register_toolchains-register_toolchains"></a>register_toolchains | Whether or not to register toolchains. | <code>True</code> |
128146

129147

docs/symbols.bzl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ load(
8888
)
8989
load(
9090
"@rules_rust//wasm_bindgen:repositories.bzl",
91-
_rust_wasm_bindgen_repositories = "rust_wasm_bindgen_repositories",
91+
_rust_wasm_bindgen_dependencies = "rust_wasm_bindgen_dependencies",
92+
_rust_wasm_bindgen_register_toolchains = "rust_wasm_bindgen_register_toolchains",
9293
)
9394
load(
9495
"@rules_rust//wasm_bindgen:wasm_bindgen.bzl",
@@ -125,8 +126,9 @@ cargo_bootstrap_repository = _cargo_bootstrap_repository
125126
cargo_env = _cargo_env
126127

127128
rust_wasm_bindgen = _rust_wasm_bindgen
129+
rust_wasm_bindgen_dependencies = _rust_wasm_bindgen_dependencies
130+
rust_wasm_bindgen_register_toolchains = _rust_wasm_bindgen_register_toolchains
128131
rust_wasm_bindgen_toolchain = _rust_wasm_bindgen_toolchain
129-
rust_wasm_bindgen_repositories = _rust_wasm_bindgen_repositories
130132

131133
rust_repositories = _rust_repositories
132134
rust_repository_set = _rust_repository_set

examples/WORKSPACE.bazel

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,11 @@ load("@rules_rust//proto:transitive_repositories.bzl", "rust_proto_transitive_re
2929

3030
rust_proto_transitive_repositories()
3131

32-
load("@rules_rust//wasm_bindgen:repositories.bzl", "rust_wasm_bindgen_repositories")
32+
load("@rules_rust//wasm_bindgen:repositories.bzl", "rust_wasm_bindgen_dependencies", "rust_wasm_bindgen_register_toolchains")
3333

34-
rust_wasm_bindgen_repositories()
34+
rust_wasm_bindgen_dependencies()
35+
36+
rust_wasm_bindgen_register_toolchains()
3537

3638
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
3739

wasm_bindgen/repositories.bzl

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,10 @@ load("@bazel_tools//tools/build_defs/repo:utils.bzl", "maybe")
1818
load("//wasm_bindgen/raze:crates.bzl", "rules_rust_wasm_bindgen_fetch_remote_crates")
1919

2020
# buildifier: disable=unnamed-macro
21-
def rust_wasm_bindgen_repositories(register_default_toolchain = True):
22-
"""Declare dependencies needed for [rust_wasm_bindgen](#rust_wasm_bindgen).
21+
def rust_wasm_bindgen_dependencies():
22+
"""Declare dependencies needed for the `rules_rust` [wasm-bindgen][wb] rules.
2323
24-
Args:
25-
register_default_toolchain (bool, optional): If True, the default [rust_wasm_bindgen_toolchain](#rust_wasm_bindgen_toolchain)
26-
(`@rules_rust//wasm_bindgen:default_wasm_bindgen_toolchain`) is registered. This toolchain requires a set of dependencies
27-
that were generated using [cargo raze](https://github.com/google/cargo-raze). These will also be loaded.
24+
[wb]: https://github.com/rustwasm/wasm-bindgen
2825
"""
2926

3027
maybe(
@@ -34,7 +31,33 @@ def rust_wasm_bindgen_repositories(register_default_toolchain = True):
3431
urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/5.4.2/rules_nodejs-core-5.4.2.tar.gz"],
3532
)
3633

37-
# Load dependencies of the default toolchain and register it.
38-
if register_default_toolchain:
39-
rules_rust_wasm_bindgen_fetch_remote_crates()
34+
rules_rust_wasm_bindgen_fetch_remote_crates()
35+
36+
# buildifier: disable=unnamed-macro
37+
def rust_wasm_bindgen_register_toolchains(register_toolchains = True):
38+
"""Registers the default toolchains for the `rules_rust` [wasm-bindgen][wb] rules.
39+
40+
[wb]: https://github.com/rustwasm/wasm-bindgen
41+
42+
Args:
43+
register_toolchains (bool, optional): Whether or not to register toolchains.
44+
"""
45+
46+
if register_toolchains:
4047
native.register_toolchains(str(Label("//wasm_bindgen:default_wasm_bindgen_toolchain")))
48+
49+
# buildifier: disable=unnamed-macro
50+
def rust_wasm_bindgen_repositories(register_default_toolchain = True):
51+
"""Declare dependencies needed for [rust_wasm_bindgen](#rust_wasm_bindgen).
52+
53+
**Deprecated**: Use [rust_wasm_bindgen_dependencies](#rust_wasm_bindgen_depednencies) and [rust_wasm_bindgen_register_toolchains](#rust_wasm_bindgen_register_toolchains).
54+
55+
Args:
56+
register_default_toolchain (bool, optional): If True, the default [rust_wasm_bindgen_toolchain](#rust_wasm_bindgen_toolchain)
57+
(`@rules_rust//wasm_bindgen:default_wasm_bindgen_toolchain`) is registered. This toolchain requires a set of dependencies
58+
that were generated using [cargo raze](https://github.com/google/cargo-raze). These will also be loaded.
59+
"""
60+
61+
rust_wasm_bindgen_dependencies()
62+
63+
rust_wasm_bindgen_register_toolchains(register_toolchains = register_default_toolchain)

0 commit comments

Comments
 (0)