Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zhouzhi3859/wasm-module-webpack-plugin


https://github.com/zhouzhi3859/wasm-module-webpack-plugin

babel wasm webassembly webpack

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README 

        
# WASM Module Webpack Plugin

![](https://img.shields.io/badge/version-3.0.0-green.svg?)

![npm](https://img.shields.io/npm/dw/wasm-module-webpack-plugin.svg)

[![](https://img.shields.io/badge/nodejs->=12.0-green.svg?)](https://nodejs.org/en/)

[![](https://img.shields.io/badge/npm->=5.4-blue.svg)](https://www.npmjs.com/)

[![](https://img.shields.io/badge/webpack->=5.0-blue.svg)](https://webpack.js.org/)

[![](https://img.shields.io/badge/babel->=7.0-blue.svg)](https://babeljs.io/)

![](https://img.shields.io/badge/license-MIT-000000.svg)

[![Build Status](https://www.travis-ci.org/zhouzhi3859/wasm-module-webpack-plugin.svg?branch=master)](https://www.travis-ci.org/zhouzhi3859/wasm-from-emscripten-result-loader)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8ec7e8848e91492aa96c885b72090314)](https://www.codacy.com/manual/zhouzhi3859/wasm-module-webpack-plugin?utm_source=github.com&utm_medium=referral&utm_content=zhouzhi3859/wasm-module-webpack-plugin&utm_campaign=Badge_Grade)



[![NPM](https://nodei.co/npm/wasm-module-webpack-plugin.png)](https://nodei.co/npm/wasm-module-webpack-plugin/)



[中文文档](https://github.com/zhouzhi3859/wasm-module-webpack-plugin/blob/master/README.zh-CN.md)



Load module which have wasm file into javascript with a zero bloat.



## Installation

1 Run `npm i wasm-module-webpack-plugin --save-dev`. If you want use with webpack4, switch to old version 2.0.1



2 Require method from wasm-module-webpack-plugin

```js

const WasmModuleWebpackPlugin = require('wasm-module-webpack-plugin');

```



3 Add this object to the `rules` section of your webpack build:

```js

{

  test: /\.m?js$/,

  // exclude: /(node_modules|bower_components)/, // Do not set {exclude}

  include: [ '{your_code_dir}', path.join(process.cwd(), './node_modules/{wasm_module_name}') ],

  use: {

    loader: 'babel-loader',

    options: {

      presets: ['@babel/preset-env'],

      plugins: [

      '@babel/plugin-syntax-dynamic-import',

      // '@babel/plugin-transform-runtime', // Do not use plugin-transform-runtime

       WasmModuleWebpackPlugin.BabelPlugin

     ]

    }

  }

}

```

NOTE: Do not use it with [@babel/plugin-transform-runtime](https://www.npmjs.com/package/@babel/plugin-transform-runtime)



4 Add this object to the `plugins` section of your webpack build:

```js

plugins: [

  new WasmModuleWebpackPlugin.WebpackPlugin()

]

```

## Example

You can also view a complete working example on github [here](https://github.com/zhouzhi3859/wasm-module-webpack-plugin/tree/master/example).



## MIT License



Copyright 2018 zhi.zhou



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.