development.md

MoonZoon Development

---

WARNING: MoonZoon is in the phase of early development and a CI pipeline / linters haven't been configured yet.

1. Required tools

• Rust

  rustup update
  rustc -V # rustc 1.55.0 (c8dfcfe04 2021-09-06)

• cargo-make

  cargo install cargo-make
  makers -V # makers 0.35.0

  • Note: cargo-make is needed only for MoonZoon development and running its examples, you don't need it for your apps.

2. VS Code settings

• Install Rust Analyzer
• My current .vscode/settings.json:

{
    "rust-analyzer.linkedProjects": [
        // rust-analyzer ignores `main.rs` when `linkedProjects` are set
        "crates/mzoon/Cargo.toml",
        // examples are ignored because they have own workspaces
        "examples/canvas/Cargo.toml",
        "examples/chat/Cargo.toml",
        "examples/counter/Cargo.toml",
        "examples/counters/Cargo.toml",
        "examples/js-framework-benchmark/keyed/Cargo.toml",
        "examples/pages/Cargo.toml",
        "examples/svg/Cargo.toml",
        "examples/time_tracker/Cargo.toml",
        "examples/timer/Cargo.toml",
        "examples/todomvc/Cargo.toml",
        "examples/viewport/Cargo.toml",
    ],
    "rust-analyzer.diagnostics.disabled": [
        "missing-unsafe",
        "add-reference-here",
    ],
    "rust-analyzer.procMacro.enable": true,
    "rust-analyzer.cargo.allFeatures": true,
    "rust-analyzer.completion.autoimport.enable": false,
    "rust-analyzer.updates.channel": "nightly"
}

3. Start example

• Runnable examples (the list is continuously updated):
  • canvas
  • chat
  • counter
  • counters
  • js-framework-benchmark/keyed
  • pages
  • svg
  • time_tracker
  • timer
  • todomvc
  • viewport

cd examples
cd chat # or another example
makers mzoon start -o # add -r for the release mode

5. Have fun!

--

Question: Do you think a code tour would be useful for you?