Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
70 lines (55 sloc) 2.9 KB

Building a release version

The build commands in the Building and Running section are intended for development: They produce large .wasm file sizes, and unoptimized performance. To build a release version, run cargo make build_release instead of cargo make build.

Debugging

There are two categories of error message you may receive: Compiler errors, and panics. I'm using a different definition than the one in this section of the Rust book.

1: Compiler errors are occur while building, and will be displayed in the terminal after running cargo build, or calling build script. Rust's compiler usually provides helpful messages, so try to work through these using the information available. It attempts to highlight which part of your code triggered the error, and suggest fixes. Examples include syntax errors, using the wrong type of parameter, calling something that doesn't exist, and running afoul of the borrow checker.

2: Runtime panics show up as console errors in the web browser. Example: panicked at 'assertion failed. They usually provide a traceback. (For example, a problem while using unwrap). They're often associated withunwrap or expect calls. When applicable, try to use normal pattern matching, or expect with a useful error message instead of unwrap: Your message will show in the console, helping identify where the panic triggered.

Logging

You may log things to the browser console using the following functions: seed::log, and seed::error. They accept a single argument which implements Debug. Each has a corresponding macro: log!, and error!, which work in a similar way, but accept multiple arguments, which will be displayed separated by spaces. If you'd like to log something which implements ToString, but not Debug, call to_string() on it when using it in the function or macro.

Debugging elements

El and Node implement the Debug trait, so you can view them using log!: log!(format!("{:?}", my_el)); In order to take advantage of this, you must implement Debug for your message type, and any sub-types. Example:

#[derive(Copy, Clone, Debug)]
enum Page {
    Guide,
    Changelog
}

#[derive(Clone, Debug)]
enum Msg {
    RoutePage(Page),
    ChangePage(Page),
}

Tests

To run tests, you may either use wasm-pack test commands, or simplified ones from the Makefile.toml included in the quickstart repo.

To run all tests with the Makefile: cargo make test_h firefox Where firefox may be replaced with chrome or safari.

To run a single test: cargo make test_h test_name. with test_name replaced by the name of the test. It uses Firefox.

With wasm-pack directly, or to run individual tests, use commands similar to this:

wasm-pack test --firefox --headless -- --lib test_name
You can’t perform that action at this time.