|
|
# 📦✨ wasm-pack
|
|
|
> Your favorite rust -> wasm workflow tool!
|
|
|
|
|
|
[](https://travis-ci.org/rustwasm/wasm-pack)
|
|
|
[](https://ci.appveyor.com/project/ashleygwilliams/wasm-pack-071k0)
|
|
|
|
|
|
|
|
|
This tool seeks to be a one-stop shop for building and working with rust-
|
|
|
generated WebAssembly that you would like to interop with JavaScript, in the
|
|
|
browser or with Node.js. `wasm-pack` helps you build and publish rust-generated
|
|
|
WebAssembly to the npm registry to be used alongside any other javascript
|
|
|
package in workflows that you already use, such as [webpack] or [greenkeeper].
|
|
|
|
|
|
[bundler-support]: https://github.com/rustwasm/team/blob/master/goals/bundler-integration.md#details
|
|
|
[webpack]: https://webpack.js.org/
|
|
|
[greenkeeper]: https://greenkeeper.io/
|
|
|
|
|
|
This project is a part of the [rust-wasm] group. You can find more info by
|
|
|
visiting that repo!
|
|
|
|
|
|
[rust-wasm]: https://github.com/rustwasm/team
|
|
|
|
|
|
|
|
|
|
|
|
## 🔮 Prerequisities
|
|
|
|
|
|
This project requires Rust 1.30.0 or later.
|
|
|
|
|
|
- [Development Environment](https://rustwasm.github.io/wasm-pack/book/prerequisites/index.html)
|
|
|
- [Installation](https://rustwasm.github.io/wasm-pack/installer)
|
|
|
- [Project Setup](https://rustwasm.github.io/wasm-pack/book/project-setup/index.html)
|
|
|
|
|
|
## 🎙️ Commands
|
|
|
|
|
|
- [`init` (⚠️ DEPRECATED)](https://rustwasm.github.io/wasm-pack/book/commands/init.html): This command has been deprecated since release `0.5.0`, in favor of `build`. `0.4.2` and previous use this command.
|
|
|
- [`build`](https://rustwasm.github.io/wasm-pack/book/commands/build.html): Generate an npm wasm pkg from a rustwasm crate
|
|
|
- [`pack` and `publish`](https://rustwasm.github.io/wasm-pack/book/commands/pack-and-publish.html): Create a tarball of your rustwasm pkg and/or publish to a registry
|
|
|
|
|
|
## 📝 Logging
|
|
|
|
|
|
We generate a `wasm-pack.log` file if `wasm-pack` errors on you, and you can
|
|
|
customize the log verbosity using the verbosity flag.
|
|
|
|
|
|
| Verbosity | Result |
|
|
|
| ------------- |-----------------------------------------------------|
|
|
|
| -v | All Info, Warn, and Errors are logged |
|
|
|
| -vv | All Debug, Info, Warn, and Errors are logged |
|
|
|
| -vvv | All Trace, Debug, Info, Warn, and Errors are logged |
|
|
|
|
|
|
## 👯 Contributing
|
|
|
|
|
|
Read our [guide] on getting up and running for developing `wasm-pack`, and
|
|
|
check out our [contribution policy].
|
|
|
|
|
|
[guide]: https://rustwasm.github.io/wasm-pack/book/contributing.html
|
|
|
[contribution policy]: CONTRIBUTING.md
|
|
|
|
|
|
## ⚡ Quickstart Guide
|
|
|
|
|
|
1. Write a crate in Rust.
|
|
|
2. Add `wasm-bindgen` to your `Cargo.toml`:
|
|
|
|
|
|
```toml
|
|
|
[lib]
|
|
|
crate-type = ["cdylib"]
|
|
|
|
|
|
[dependencies]
|
|
|
wasm-bindgen = "0.2"
|
|
|
```
|
|
|
3. Add this to the top of your `src/lib.rs`:
|
|
|
|
|
|
```rust
|
|
|
extern crate wasm_bindgen;
|
|
|
|
|
|
use wasm_bindgen::prelude::*;
|
|
|
```
|
|
|
|
|
|
4. Annotate your public functions with `#[wasm_bindgen]`, for example:
|
|
|
|
|
|
```rust
|
|
|
#[wasm_bindgen]
|
|
|
extern {
|
|
|
pub fn alert(s: &str);
|
|
|
}
|
|
|
|
|
|
#[wasm_bindgen]
|
|
|
pub fn greet(name: &str) {
|
|
|
alert(&format!("Hello, {}!", name));
|
|
|
}
|
|
|
```
|
|
|
|
|
|
5. Install this tool: `cargo install wasm-pack`
|
|
|
6. Run `wasm-pack build`, optionally, pass a path to a dir or a scope (see above for details)
|
|
|
7. This tool generates files in a `pkg` dir
|
|
|
8. To publish to npm, run `wasm-pack publish`. You may need to login to the
|
|
|
registry you want to publish to. You can login using `wasm-pack login`.
|
|
|
|
