Struct Dist 

#[non_exhaustive]
pub struct Dist {

    pub quiet: bool,
    pub jobs: Option<String>,
    pub profile: Option<String>,
    pub release: bool,
    pub features: Vec<String>,
    pub all_features: bool,
    pub no_default_features: bool,
    pub verbose: bool,
    pub color: Option<String>,
    pub frozen: bool,
    pub locked: bool,
    pub offline: bool,
    pub ignore_rust_version: bool,
    pub example: Option<String>,
    pub build_command: Command,
    pub dist_dir: Option<PathBuf>,
    pub assets_dir: Option<PathBuf>,
    pub app_name: Option<String>,
    pub transformers: Vec<Box<dyn Transformer>>,
    pub wasm_opt: Option<WasmOpt>,
}

Available on non-WebAssembly only.

A helper to generate the distributed package.

Usage

use std::process;
use xtask_wasm::{anyhow::Result, clap};

#[derive(clap::Parser)]
enum Opt {
    Dist(xtask_wasm::Dist),
}

fn main() -> Result<()> {
    let opt: Opt = clap::Parser::parse();

    match opt {
        Opt::Dist(dist) => {
            log::info!("Generating package...");

            dist
                .assets_dir("my-project/assets")
                .app_name("my-project")
                .build("my-project")?;
        }
    }

    Ok(())
}

In this example, we added a dist subcommand to build and package the my-project crate. It will run the default_build_command at the workspace root, copy the content of the my-project/assets directory, generate JS bindings and output two files: my-project.js and my-project.wasm into the dist directory.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

quiet: bool

No output printed to stdout.

jobs: Option<String>

Number of parallel jobs, defaults to # of CPUs.

profile: Option<String>

Build artifacts with the specified profile.

release: bool

Build artifacts in release mode, with optimizations.

features: Vec<String>

Space or comma separated list of features to activate.

all_features: bool

Activate all available features.

no_default_features: bool

Do not activate the default features.

verbose: bool

Use verbose output

color: Option<String>

Coloring: auto, always, never.

frozen: bool

Require Cargo.lock and cache are up to date.

locked: bool

Require Cargo.lock is up to date.

offline: bool

Run without accessing the network.

ignore_rust_version: bool

Ignore rust-version specification in packages.

example: Option<String>

Name of the example target to run.

build_command: Command

Command passed to the build process.

dist_dir: Option<PathBuf>

Directory of all generated artifacts.

assets_dir: Option<PathBuf>

Directory of all static assets artifacts.

Default to assets in the package root when it exists.

app_name: Option<String>

Set the resulting app name, default to app.

transformers: Vec<Box<dyn Transformer>>

Transformers applied to each file in the assets directory during the build.

Each transformer is called in order for every file; the first one that returns Ok(true) claims the file and the rest are skipped. Files not claimed by any transformer are copied verbatim into the dist directory.

wasm_opt: Option<WasmOpt>

Available on crate feature wasm-opt only.

Optional wasm-opt pass to run on the generated Wasm binary after bindgen.

Set via Dist::optimize_wasm. Only available when the wasm-opt feature is enabled.

Implementations

impl Dist

pub fn build_command(self, command: Command) -> Self

Set the command used by the build process.

The default command is the result of the default_build_command.

pub fn dist_dir(self, path: impl Into<PathBuf>) -> Self

Set the directory for the generated artifacts.

The default for debug build is target/debug/dist and target/release/dist for the release build.

pub fn assets_dir(self, path: impl Into<PathBuf>) -> Self

Set the directory for the static assets artifacts (like index.html).

Default to assets in the package root when it exists.

pub fn app_name(self, app_name: impl Into<String>) -> Self

Set the resulting package name.

The default is app.

pub fn transformer(self, transformer: impl Transformer + 'static) -> Self

Add a transformer for the asset copy step.

Transformers are called in the order they are added. See Transformer for details.

pub fn optimize_wasm(self, wasm_opt: WasmOpt) -> Self

Available on crate feature wasm-opt only.

Run WasmOpt on the generated Wasm binary after the bindgen step.

This is the recommended way to integrate wasm-opt: it runs automatically at the end of build using the resolved output path, so you do not need to wrap Dist in a custom struct or compute the path manually.

The optimization is skipped for debug builds — it only runs when release is true. A log::debug! message is emitted when it is skipped.

Requires the wasm-opt feature.

Examples

use xtask_wasm::{anyhow::Result, clap, WasmOpt};

#[derive(clap::Parser)]
enum Opt {
    Dist(xtask_wasm::Dist),
}

fn main() -> Result<()> {
    let opt: Opt = clap::Parser::parse();

    match opt {
        Opt::Dist(dist) => {
            dist.optimize_wasm(WasmOpt::level(1).shrink(2))
                .build("my-project")?;
        }
    }

    Ok(())
}

pub fn example(self, example: impl Into<String>) -> Self

Set the example to build.

pub fn default_debug_dir() -> Utf8PathBuf

Get the default dist directory for debug builds.

pub fn default_release_dir() -> Utf8PathBuf

Get the default dist directory for release builds.

pub fn build(self, package_name: &str) -> Result<PathBuf>

Build the given package for Wasm.

This will generate JS bindings via wasm-bindgen and copy files from a given assets directory if any to finally return the path of the generated artifacts. Wasm optimizations can be achieved using WasmOpt if the feature wasm-opt is enabled.

Trait Implementations

impl Args for Dist

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Dist

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Dist

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Dist

fn default() -> Dist

Returns the “default value” for a type.

impl FromArgMatches for Dist

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Dist

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.