https://github.com/toyobayashi/emwrap

Node.js CLI tool for wrapping emscripten glue code to module
https://github.com/toyobayashi/emwrap

Last synced: 2 days ago
JSON representation

Node.js CLI tool for wrapping emscripten glue code to module

• Host: GitHub
• URL: https://github.com/toyobayashi/emwrap
• Owner: toyobayashi
• Created: 2021-11-10T09:48:31.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-20T04:38:32.000Z (about 2 years ago)
• Last Synced: 2024-10-11T20:58:34.144Z (27 days ago)
• Language: JavaScript
• Size: 56.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# emwrap

Node.js CLI tool for wrapping emscripten glue code to module.

Support module type:

* `umd` (default, support browser ``, Node.js and bundler)

* `cjs` (support Node.js and CommonJS bundler)

* `esm` (support browser `<script type="module">` and ES module bundler, if using pthread, bundle umd instead)

* `mjs` (support Node.js runtime only, all js emitted by emscripten need to rename .mjs suffix via `--output`)

```bash

npm install -g @tybys/emwrap

```

```

emwrap [--name=myWasmLib]

       [--module=<umd | esm | cjs | mjs>]

       [--minify]

       [--weixin]

       [--worker]

       [--output=/path/to/output.js]

       [--script=/path/to/script.js]

       [--initscript=/path/to/script.js]

       [--exports=UTF8ToString,stringToUTF8]

       /path/to/emscripten/glue.js

```

`--weixin`: Support `WXWebAssembly` in WeChat miniprogram environment, pthread and workers are not supported.

## Usage

Note: you should avoid passing `-sMODULARIZE=1` or `-o mjs` extension to `emcc` / `em++`.

### UMD

You can use [`--js-transform`](https://emscripten.org/docs/tools_reference/emcc.html#emcc-minify) option:

```bash

emcc -o glue.js -O3 --js-transform "emwrap --name=myWasmLib" main.c

```

Windows:

```bat

emcc -o glue.js -O3 --js-transform "emwrap.cmd --name=myWasmLib" main.c

```

or in two steps:

```bash

emcc -o glue.js -O3 main.c

emwrap --name=myWasmLib --minify glue.js

```

Browser `<script>`:

```html

<script src="glue.js">

  myWasmLib.default().then(function (ctx) {

    var Module = ctx.Module;

    Module.myfunction();

  });

```

Webpack:

```js

import init from './glue.js'

// const init = require('./glue.js').default

init().then(({ Module }) => { Module.myfunction() })

```

Make sure to set `node.__dirname: false` or `node: false` in your webpack configuration.

```js

module.exports = {

  node: {

    __dirname: false,

    __filename: false

  }

  // or

  // node: false

}

```

### ES Module

```bash

emcc -o glue.js -O3 main.c

emwrap --module=esm --minify glue.js

```

```html

  import init from './glue.js'

  init().then(({ Module }) => { Module.myfunction() })

```

Webpack is ok as well.

### Override Emscripten [`Module`](https://emscripten.org/docs/api_reference/module.html) options

Pass options to the default exported `init` function:

```js

init({

  locateFile (path, dir) {

    if (/\.worker\.m?js$/.test(path)) {

      return 'your/custom/worker/js/path'

    } else {

      return 'your/custom/wasm/path'

    }

  },

  mainScriptUrlOrBlob: 'import/main/js/path/from/worker'

}).then(({ Module }) => {

  // ...

})

```

### CMake

```bash

npm install -D @tybys/emwrap

```

```cmake

add_custom_command(TARGET yourtarget POST_BUILD

  COMMAND npx emwrap "--name=umdname" "$"

  # COMMAND node "./other-script.js"

)

```