fluencelabs/wasm-bindgen
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasm-bindgen synced 2025-05-14 14:51:20 +00:00
Code Issues Projects Releases Wiki Activity
wasm-bindgen/guide/src/reference/cli.md

71 lines
2.0 KiB
Markdown
Raw Normal View History

guide: Clean up title and URL of CLI reference section
2018-08-03 15:34:35 -07:00
# The `wasm-bindgen` Command Line Interface
guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`.
2018-06-19 11:08:54 -07:00
guide: Overhaul the CLI reference content * Add missing documentation for a couple existing flags. * Make each flag its own header, so it gets an anchor, and can be permalinked to. * Streamline some content and descriptions.
2018-08-03 16:05:14 -07:00
The `wasm-bindgen` command line tool has a number of options available to it to
tweak the JavaScript that is generated. The most up-to-date set of flags can
always be listed via `wasm-bindgen --help`.
guide: Note that `wasm-pack` is preferred over using the `wasm-bindgen` CLI directly
2018-08-03 16:38:42 -07:00
> Note: usually, one should use a [`wasm-pack`-based workflow][wasm-pack] rather
> than running the `wasm-bindgen` command line tool by hand.
[wasm-pack]: https://github.com/rustwasm/wasm-pack
guide: Overhaul the CLI reference content * Add missing documentation for a couple existing flags. * Make each flag its own header, so it gets an anchor, and can be permalinked to. * Streamline some content and descriptions.
2018-08-03 16:05:14 -07:00
## Usage
```
wasm-bindgen [options] ./target/wasm32-unknown-unknown/release/crate.wasm
```
## Options
### `--out-dir DIR`
The target directory to emit the JavaScript bindings, TypeScript definitions,
processed `.wasm` binary, etc...
Replace target flags with `--target` This commit deprecates the `--web`, `--no-modules`, and `--nodejs` flags in favor of one `--target` flag. The motivation for this commit is to be consistent between `wasm-bindgen` and `wasm-pack` so documentation for one is applicable for the other (so we don't have to document everywhere what the translation is between flags). Additionally this should make it a bit easier to add new targets (if necessary) in the future as it won't add to the proliferation of flags. For now the old flags (like `--web`) continue to be accepted, but they'll be removed during the next set of breaking changes for `wasm-bindgen`.
2019-03-19 11:25:13 -07:00
### `--target`
guide: Overhaul the CLI reference content * Add missing documentation for a couple existing flags. * Make each flag its own header, so it gets an anchor, and can be permalinked to. * Streamline some content and descriptions.
2018-08-03 16:05:14 -07:00
Replace target flags with `--target` This commit deprecates the `--web`, `--no-modules`, and `--nodejs` flags in favor of one `--target` flag. The motivation for this commit is to be consistent between `wasm-bindgen` and `wasm-pack` so documentation for one is applicable for the other (so we don't have to document everywhere what the translation is between flags). Additionally this should make it a bit easier to add new targets (if necessary) in the future as it won't add to the proliferation of flags. For now the old flags (like `--web`) continue to be accepted, but they'll be removed during the next set of breaking changes for `wasm-bindgen`.
2019-03-19 11:25:13 -07:00
This flag indicates what flavor of output what `wasm-bindgen` should generate.
For example it could generate code to be loaded in a bundler like Webpack, a
native web page, or Node.js. For a full list of options to pass this flag, see
the section on [deployment]
Switch the `--browser` argument to `--web` This commit reverts part of the implementation of [RFC 6]. That RFC specified that the `--browser` flag was going to be repurposed for the new "natively loadable as ES module output", but unfortunately the breakage is far broader than initially expected. It turns out that `wasm-pack` passes `--browser` by default which means that a change to break `--browser` would break all historical versions of `wasm-pack` which is a bit much for now. To solve this the `--browser` flag is going back to what it represents on the current released version of `wasm-bindgen` (optimize away some node.js checks in a few places for bundler-style output) and a new `--web` flag is being introduced as the new deployment strategy. [RFC 6]: https://github.com/rustwasm/rfcs/pull/6 Closes #1318
2019-03-07 07:33:40 -08:00
[deployment]: deployment.html
Replace target flags with `--target` This commit deprecates the `--web`, `--no-modules`, and `--nodejs` flags in favor of one `--target` flag. The motivation for this commit is to be consistent between `wasm-bindgen` and `wasm-pack` so documentation for one is applicable for the other (so we don't have to document everywhere what the translation is between flags). Additionally this should make it a bit easier to add new targets (if necessary) in the future as it won't add to the proliferation of flags. For now the old flags (like `--web`) continue to be accepted, but they'll be removed during the next set of breaking changes for `wasm-bindgen`.
2019-03-19 11:25:13 -07:00
### `--no-modules-global VAR`
guide: Overhaul the CLI reference content * Add missing documentation for a couple existing flags. * Make each flag its own header, so it gets an anchor, and can be permalinked to. * Streamline some content and descriptions.
2018-08-03 16:05:14 -07:00
Replace target flags with `--target` This commit deprecates the `--web`, `--no-modules`, and `--nodejs` flags in favor of one `--target` flag. The motivation for this commit is to be consistent between `wasm-bindgen` and `wasm-pack` so documentation for one is applicable for the other (so we don't have to document everywhere what the translation is between flags). Additionally this should make it a bit easier to add new targets (if necessary) in the future as it won't add to the proliferation of flags. For now the old flags (like `--web`) continue to be accepted, but they'll be removed during the next set of breaking changes for `wasm-bindgen`.
2019-03-19 11:25:13 -07:00
When `--target no-modules` is used this flag can indicate what the name of the
global to assign generated bindings to.
guide: Overhaul the CLI reference content * Add missing documentation for a couple existing flags. * Make each flag its own header, so it gets an anchor, and can be permalinked to. * Streamline some content and descriptions.
2018-08-03 16:05:14 -07:00
Switch the `--browser` argument to `--web` This commit reverts part of the implementation of [RFC 6]. That RFC specified that the `--browser` flag was going to be repurposed for the new "natively loadable as ES module output", but unfortunately the breakage is far broader than initially expected. It turns out that `wasm-pack` passes `--browser` by default which means that a change to break `--browser` would break all historical versions of `wasm-pack` which is a bit much for now. To solve this the `--browser` flag is going back to what it represents on the current released version of `wasm-bindgen` (optimize away some node.js checks in a few places for bundler-style output) and a new `--web` flag is being introduced as the new deployment strategy. [RFC 6]: https://github.com/rustwasm/rfcs/pull/6 Closes #1318
2019-03-07 07:33:40 -08:00
For more information about this see the section on [deployment]
guide: Overhaul the CLI reference content * Add missing documentation for a couple existing flags. * Make each flag its own header, so it gets an anchor, and can be permalinked to. * Streamline some content and descriptions.
2018-08-03 16:05:14 -07:00
### `--typescript`
Output a TypeScript declaration file for the generated JavaScript bindings. This
is on by default.
### `--no-typescript`
By default, a `*.d.ts` TypeScript declaration file is generated for the
generated JavaScript bindings, but this flag will disable that.
### `--debug`
Generates a bit more JS and wasm in "debug mode" to help catch programmer
errors, but this output isn't intended to be shipped to production.
### `--no-demangle`
When post-processing the `.wasm` binary, do not demangle Rust symbols in the
"names" custom section.
### `--keep-debug`
When post-processing the `.wasm` binary, do not strip DWARF debug info custom
sections.
Switch the `--browser` argument to `--web` This commit reverts part of the implementation of [RFC 6]. That RFC specified that the `--browser` flag was going to be repurposed for the new "natively loadable as ES module output", but unfortunately the breakage is far broader than initially expected. It turns out that `wasm-pack` passes `--browser` by default which means that a change to break `--browser` would break all historical versions of `wasm-pack` which is a bit much for now. To solve this the `--browser` flag is going back to what it represents on the current released version of `wasm-bindgen` (optimize away some node.js checks in a few places for bundler-style output) and a new `--web` flag is being introduced as the new deployment strategy. [RFC 6]: https://github.com/rustwasm/rfcs/pull/6 Closes #1318
2019-03-07 07:33:40 -08:00
### `--browser`
When generating bundler-compatible code (see the section on [deployment]) this
indicates that the bundled code is always intended to go into a browser so a few
checks for Node.js can be elided.
Reference in New Issue Copy Permalink