gem-hunter
Language: JavaScript
A rollup plugin that compile Rust code into WebAssembly modules
tl;dr -- see examples
This is a rollup plugin that loads Rust code so it can be interop with Javascript base project. Currently, the Rust code will be compiled as:
rustup default 1.28.0 rustup target add wasm32-unknown-unknown
This module requires a minimum of Node v8.9.0, Rollup v0.64.0, and Rust in [nightly channel][].
To begin, you'll need to install rollup-plugin-rust:
npm install rollup-plugin-rust --save-devThen add the plugin to your rollup config. For example:
rollup.config.js
import rust from "rollup-plugin-rust"; export default [ { input: "src/main.js", output: { file: "dist.index.js", format: "esm" }, plugins: [rust()] } ];
lib.rs
#[no_mangle] pub fn add(a: i32, b: i32) -> i32 { a + b }
index.js
import wasm from "lib.rs"; export async function increment(a) { const { instance } = await wasm; return instance.exports.add(1, a); }
And run rollup via your preferred method.
export
How wasm code would be exported. This options is identical with option export in webassembly-loader. (see examples)
// in your rollup.config.js { plugins: [rust({ export: "instance" })]; }
target
Stringwasm32-unknown-unknownThe Rust target to use. Currently it only support wasm related target
// in your rollup.config.js { plugins: [rust({ target: "wasm32-unknown-emscripten" })]; }
release
BooleantrueWhether to compile the Rust code in debug or release mode.
// in your rollup.config.js { plugins: [rust({ release: false })]; // preserve debug symbol }
include
Array<string> or string['**/*.rs']A single file, or array of files, to include when compiling.
// in your rollup.config.js { plugins: [ rust({ include: ["src/**/*.rs", "test/**/*.rs"] }) ]; }
exclude
Array<string> or string['node_modules/**', 'target/**']A single file, or array of files, to exclude when linting.
// in your rollup.config.js { plugins: [ rust({ exclude: ["**/node_modules/**", "**/target/**", "**/__caches__/**"] }) ]; }
See the test cases and example projects in fixtures and examples for more insight.
TL;DRlib.rs
#[no_mangle] pub fn add(a: i32, b: i32) -> i32 { a + b }
Cargo.toml
[package] name = "adder" version = "0.1.0" authors = ["Full Name <email@site.domain>"] [lib] crate-type = ["cdylib"] path = "lib.rs"
import wasmCode from "./lib.rs"; WebAssembly.compile(wasmCode).then(module => { const instance = new WebAssembly.Instance(module); console(instance.exports.add(1, 2)); // 3 });
import wasmModule from "./lib.rs"; const instance = new WebAssembly.Instance(wasmModule); console(instance.exports.add(1, 2)); // 3
import wasm from "./lib.rs"; console(wasm.exports.add(1, 2)); // 3
extern { fn hook(c: i32); } #[no_mangle] pub fn add(a: i32, b: i32) -> i32 { hook(a + b) }
import wasmInstantiate from "./lib.rs"; wasmInstantiate(importObject | undefined).then(({ instance, module }) => { console(instance.exports.add(1, 2)); // 3 // create different instance, extra will be called in different environment const differentInstance = new WebAssembly.Instance(module, { env: { hook: result => result * 2 } }); console(differentInstance.exports.add(1, 2)); // 6 });
import wasmInstantiate from "./lib.rs"; wasmInstantiate(importObject | undefined).then(instance => { console(instance.exports.add(1, 2)); // 3 });
import wasmInstantiate from "./lib.rs"; wasmCompile(importObject | undefined).then(module => { const differentInstance = new WebAssembly.Instance(module); console(differentInstance.exports.add(1, 2)); // 3 });