wasm_bindgen_cli/
wasm_bindgen.rs

1use anyhow::{bail, Error};
2use clap::{Parser, ValueEnum};
3use std::ffi::OsString;
4use std::path::PathBuf;
5use wasm_bindgen_cli_support::{Bindgen, EncodeInto};
6
7#[derive(Debug, Clone, ValueEnum)]
8#[clap(rename_all = "kebab-case")]
9enum Target {
10    Bundler,
11    Web,
12    Nodejs,
13    NoModules,
14    Deno,
15    ExperimentalNodejsModule,
16    Module,
17}
18
19#[derive(Debug, Parser)]
20#[command(
21    name = "wasm-bindgen",
22    version,
23    about,
24    after_help = "Additional documentation: https://wasm-bindgen.github.io/wasm-bindgen/reference/cli.html"
25)]
26struct Args {
27    input: PathBuf,
28    #[arg(
29        long,
30        value_name = "TARGET",
31        value_enum,
32        default_value_t = Target::Bundler,
33        help = "What type of output to generate",
34        group = "target-group"
35    )]
36    target: Target,
37    #[arg(long, value_name = "DIR", help = "Output directory")]
38    out_dir: PathBuf,
39    #[arg(
40        long,
41        help = "Hint that JS should only be compatible with a browser",
42        group = "target-group"
43    )]
44    browser: bool,
45    #[arg(long, help = "Don't emit a *.d.ts file", conflicts_with = "typescript")]
46    no_typescript: bool,
47    #[arg(long, help = "Don't emit imports in generated JavaScript")]
48    omit_imports: bool,
49    #[arg(
50        long,
51        value_name = "VAR",
52        help = "Set a custom output filename (Without extension. Defaults to crate name)"
53    )]
54    out_name: Option<String>,
55    #[arg(long, help = "Include otherwise-extraneous debug checks in output")]
56    debug: bool,
57    #[arg(long, help = "Don't demangle Rust symbol names")]
58    no_demangle: bool,
59    #[arg(
60        long,
61        value_name = "VAR",
62        help = "Name of the global variable to initialize"
63    )]
64    no_modules_global: Option<String>,
65    #[arg(long, help = "Remove the debugging `name` section of the file")]
66    remove_name_section: bool,
67    #[arg(long, help = "Remove the telemetry `producers` section")]
68    remove_producers_section: bool,
69    #[arg(long, help = "Keep exports synthesized by LLD")]
70    keep_lld_exports: bool,
71    #[arg(long, help = "Keep debug sections in Wasm files")]
72    keep_debug: bool,
73    #[arg(
74        long,
75        help = "Write DWARF debug info to a separate `*_bg.debug.wasm` file (implies `--keep-debug`)"
76    )]
77    split_debug_info: bool,
78    #[arg(
79        long,
80        value_name = "URL",
81        requires = "split_debug_info",
82        help = "URL of the split debug info file, recorded in the main Wasm file\n\
83                (defaults to the file name of the debug info file)"
84    )]
85    debug_info_url: Option<String>,
86    #[arg(
87        long,
88        value_name = "MODE",
89        help = "Whether or not to use TextEncoder#encodeInto",
90        value_parser = ["test", "always", "never"]
91    )]
92    encode_into: Option<String>,
93    #[arg(
94        long,
95        help = "Don't add WebAssembly fallback imports in generated JavaScript"
96    )]
97    omit_default_module_path: bool,
98    #[arg(
99        long,
100        help = "Split linked modules out into their own files. Recommended if possible.\n\
101                If a bundler is used, it needs to be set up accordingly."
102    )]
103    split_linked_modules: bool,
104    #[arg(
105        long,
106        help = "Emit `Uint8Array<ArrayBuffer>`-style generic typed array return types\n\
107                in generated TypeScript. Requires TypeScript 5.7 or later."
108    )]
109    ts_typed_array_buffers: bool,
110    #[arg(
111        long = "experimental-reset-state-function",
112        help = "Generate __wbg_reset_state function for Wasm reinitialization (experimental)"
113    )]
114    generate_reset_state: bool,
115    #[arg(
116        long = "force-enable-abort-handler",
117        help = "Enable abort handler even if building with panic=abort. Does nothing when panic=unwind."
118    )]
119    force_enable_abort_handler: bool,
120    // The options below are deprecated. They're still parsed for backwards compatibility,
121    // but we don't want to show them in `--help` to avoid distracting users.
122    #[arg(long, hide = true)]
123    #[deprecated(note = "implied default, only `--no-typescript` is needed")]
124    typescript: bool,
125    #[arg(long, hide = true, group = "target-group")]
126    #[deprecated(note = "use `Args::target` instead")]
127    nodejs: bool,
128    #[arg(long, hide = true, group = "target-group")]
129    #[deprecated(note = "use `Args::target` instead")]
130    web: bool,
131    #[arg(long, hide = true, group = "target-group")]
132    #[deprecated(note = "use `Args::target` instead")]
133    no_modules: bool,
134    #[arg(long, hide = true)]
135    #[deprecated(note = "runtime-detected")]
136    #[allow(dead_code)]
137    weak_refs: bool,
138    #[arg(long, hide = true)]
139    #[deprecated(note = "automatically inferred from the Wasm features")]
140    reference_types: bool,
141}
142
143pub fn run_cli_with_args<I, T>(args: I) -> anyhow::Result<()>
144where
145    I: IntoIterator<Item = T>,
146    T: Into<OsString> + Clone,
147{
148    let args = match Args::try_parse_from(args) {
149        Ok(a) => a,
150        Err(e) => match e.kind() {
151            // Passing --version and --help should not result in a failure.
152            clap::error::ErrorKind::DisplayHelp | clap::error::ErrorKind::DisplayVersion => {
153                print!("{e}");
154                return Ok(());
155            }
156            _ => bail!(e),
157        },
158    };
159    rmain(&args)
160}
161
162fn rmain(args: &Args) -> Result<(), Error> {
163    let mut b = Bindgen::new();
164    match &args.target {
165        Target::Bundler => b.bundler(true)?,
166        Target::Web => b.web(true)?,
167        Target::NoModules => b.no_modules(true)?,
168        Target::Nodejs => b.nodejs(true)?,
169        Target::Deno => b.deno(true)?,
170        Target::ExperimentalNodejsModule => b.nodejs_module(true)?,
171        Target::Module => b.module(true)?,
172    };
173    #[allow(deprecated)]
174    b.input_path(&args.input)
175        .nodejs(args.nodejs)?
176        .web(args.web)?
177        .browser(args.browser)?
178        .no_modules(args.no_modules)?
179        .debug(args.debug)
180        .demangle(!args.no_demangle)
181        .keep_lld_exports(args.keep_lld_exports)
182        .keep_debug(args.keep_debug)
183        .split_debug_info(args.split_debug_info)
184        .remove_name_section(args.remove_name_section)
185        .remove_producers_section(args.remove_producers_section)
186        .typescript(!args.no_typescript)
187        .omit_imports(args.omit_imports)
188        .omit_default_module_path(args.omit_default_module_path)
189        .split_linked_modules(args.split_linked_modules)
190        .ts_typed_array_buffers(args.ts_typed_array_buffers)
191        .reference_types(args.reference_types)
192        .reset_state_function(args.generate_reset_state)
193        .force_enable_abort_handler(args.force_enable_abort_handler);
194
195    if let Some(ref url) = args.debug_info_url {
196        b.debug_info_url(url);
197    }
198    if let Some(ref name) = args.no_modules_global {
199        b.no_modules_global(name)?;
200    }
201    if let Some(ref name) = args.out_name {
202        b.out_name(name);
203    }
204
205    if let Some(mode) = &args.encode_into {
206        let mode = match mode.as_str() {
207            "test" => EncodeInto::Test,
208            "always" => EncodeInto::Always,
209            "never" => EncodeInto::Never,
210            // clap guarantees
211            _ => unreachable!(),
212        };
213        b.encode_into(mode);
214    }
215
216    b.generate(&args.out_dir)
217}
wasm_bindgen_cli/wasm_bindgen.rs

wasm_bindgen_cli/
wasm_bindgen.rs
