https://github.com/wasm-tool/wasm-pack-plugin

webpack plugin for Rust
https://github.com/wasm-tool/wasm-pack-plugin

bindgen rust wasm

Last synced: 4 days ago
JSON representation

webpack plugin for Rust

• Host: GitHub
• URL: https://github.com/wasm-tool/wasm-pack-plugin
• Owner: wasm-tool
• License: mit
• Created: 2018-07-28T14:39:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-23T08:44:25.000Z (10 months ago)
• Last Synced: 2025-01-18T22:39:56.600Z (11 days ago)
• Topics: bindgen, rust, wasm
• Language: JavaScript
• Homepage:
• Size: 135 KB
• Stars: 315
• Watchers: 5
• Forks: 70
• Open Issues: 59
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @wasm-tool/wasm-pack-plugin

> webpack plugin for Rust

## Installation

With npm:

```sh

npm install --save-dev @wasm-tool/wasm-pack-plugin

```

Or with Yarn:

```sh

yarn add --dev @wasm-tool/wasm-pack-plugin

```

### `wasm-pack`

We expect `wasm-pack` to be in your `$PATH`. See [installation here](https://rustwasm.github.io/wasm-pack/installer).

The minimum required `wasm-pack` version is `0.8.0`

## Linting

This project uses the `prettier` with default configuration. Fo manually format the code run the `lint:fix` script.

## Usage

Add the loader in your `webpack.config.js`:

```js

const path = require('path')

const WasmPackPlugin = require('@wasm-tool/wasm-pack-plugin')

module.exports = {

    // ...

    plugins: [

        new WasmPackPlugin({

            crateDirectory: path.resolve(__dirname, 'crate'),

            // Check https://rustwasm.github.io/wasm-pack/book/commands/build.html for

            // the available set of arguments.

            //

            // Optional space delimited arguments to appear before the wasm-pack

            // command. Default arguments are `--verbose`.

            args: '--log-level warn',

            // Default arguments are `--typescript --target browser --mode normal`.

            extraArgs: '--no-typescript',

            // Optional array of absolute paths to directories, changes to which

            // will trigger the build.

            // watchDirectories: [

            //   path.resolve(__dirname, "another-crate/src")

            // ],

            // The same as the `--out-dir` option for `wasm-pack`

            // outDir: "pkg",

            // The same as the `--out-name` option for `wasm-pack`

            // outName: "index",

            // If defined, `forceWatch` will force activate/deactivate watch mode for

            // `.rs` files.

            //

            // The default (not set) aligns watch mode for `.rs` files to Webpack's

            // watch mode.

            // forceWatch: true,

            // If defined, `forceMode` will force the compilation mode for `wasm-pack`

            //

            // Possible values are `development` and `production`.

            //

            // the mode `development` makes `wasm-pack` build in `debug` mode.

            // the mode `production` makes `wasm-pack` build in `release` mode.

            // forceMode: "development",

            // Controls plugin output verbosity, either 'info' or 'error'.

            // Defaults to 'info'.

            // pluginLogLevel: 'info'

        }),

    ],

    // ...

}

```

and then import your `pkg` folder from `wasm-pack`:

```js

import('./path/to/your/pkg').then((module) => {

    module.run()

})

```