1.1.0 • Published 2 years ago
esbuild-plugin-wasm-pack v1.1.0
esbuild-plugin-wasm-pack
An esbuild plugin that runs wasm-pack before each build.
Requirements
- node >=0.10.0
- esbuild >= 0.11.15
- rust/cargo
- wasm-pack
*Make sure you have wasm-pack installed and in your PATH.*
Installation
npm install --save-dev esbuild-plugin-wasm-packor
yarn add --dev esbuild-plugin-wasm-packUsage
Simply add it to your esbuild plugins list
// build.ts
import esbuild from 'esbuild';
import wasmpack from 'esbuild-plugin-wasm-pack';
esbuild.build({
...
plugins: [
wasmpack({
// options (see below)
})
]
...
});Configuration
The configuration options match the arguments to wasm-pack build.
| Option | Type | Default Value | Description |
|---|---|---|---|
logLevel | string | "info" | The maximum level of messages that should be logged by wasm-pack.Possible values: info, warn, error |
profile | string | "dev" | Sets the build profileOptions:dev - Create a development build. Enables debug info and disables optimizations.profiling - Create a profiling build. Enables optimizations and debug info.release - Create a release build. Enables optimizations and disables debug info. |
noTypescript | boolean | false | By default a *.d.ts file is generated for the generated JS file. This flag will disable generating this TypeScript file. |
mode | string | "normal" | Sets steps to be run.Possible values: no-install, normal, force |
outDir | string | "pkg" | Sets the output directory with a relative path. |
outName | string | <package name> | Sets the output file names. Defaults to package name. |
scope | string | - | The npm scope to use in package.json, if any. |
target | string | "bundler" | Sets the target environment.Possible values: bundler, nodejs, web, no-modules |
path | string | - | The path to the Rust crate. If not set, searches up the path from the current directory. |
extraOptions | string[] | [] | A list of extra options to pass to cargo build. |
extraPackOptions | string[] | [] | A list of extra options to pass to wasm-pack |
wasmPackPath | string | - | Overrides the path to the wasm-pack executable. This can also be set via the WASM_PACK_PATH environment variable. |
License
This project is licensed under the MIT License - see the LICENSE.md file for details.