summaryrefslogtreecommitdiffstats
path: root/vendor/wasm-bindgen-macro/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:41:35 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:41:35 +0000
commit7e5d7eea9c580ef4b41a765bde624af431942b96 (patch)
tree2c0d9ca12878fc4525650aa4e54d77a81a07cc09 /vendor/wasm-bindgen-macro/README.md
parentAdding debian version 1.70.0+dfsg1-9. (diff)
downloadrustc-7e5d7eea9c580ef4b41a765bde624af431942b96.tar.xz
rustc-7e5d7eea9c580ef4b41a765bde624af431942b96.zip
Merging upstream version 1.70.0+dfsg2.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/wasm-bindgen-macro/README.md')
-rw-r--r--vendor/wasm-bindgen-macro/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/vendor/wasm-bindgen-macro/README.md b/vendor/wasm-bindgen-macro/README.md
new file mode 100644
index 000000000..353829869
--- /dev/null
+++ b/vendor/wasm-bindgen-macro/README.md
@@ -0,0 +1,28 @@
+# `wasm-bindgen-macro`
+
+Implementation of the `#[wasm_bindgen]` attribute. See the `wasm-bindgen`
+documentation for more information about what this macro does.
+
+## Testing
+
+Testing of this macro is done through "ui tests" in the `ui-tests` subdirectory
+of this crate. Each Rust file in this folder is compiled with the `wasm_bindgen`
+crate, and the `*.stderr` file sitting next to it is the asserted output of the
+compiler. If the output matches, the test passes, and if the output doesn't
+match the test fails. Note that it is also considered a failure if a test
+actually compiles successfully.
+
+To add a test:
+
+* Create `ui-tests/my-awesome-test.rs`
+* Write an invalid `#[wasm_bindgen]` invocation, testing the error you're
+ generating
+* Execute `cargo test -p ui-tests`, the test will fail
+* From within the `ui-tests` folder, execute `./update-all-references.sh`. This
+ should create a `my-awesome-test.stderr` file.
+* Inspect `my-awesome-test.stderr` to make sure it looks ok
+* Rerun `cargo test -p ui-tests` and your tests should pass!
+
+Testing here is a work in progress, see
+[#601](https://github.com/rustwasm/wasm-bindgen/issues/601) for more
+information.