Skip to content

Development Workflow ​

Requirements ​

  • Rust with the wasm32-unknown-unknown target and wasm-pack
  • Node.js and pnpm (the version is pinned in package.json)

Commands ​

CommandPurpose
pnpm devBuild the WASM core into public/wasm/, then start the Vite dev server
pnpm buildBuild the WASM core, type-check, and produce the production app
pnpm wasm:buildRebuild only the WASM core (wasm-pack build ./rust --target web --release)
pnpm testRun the frontend tests with Vitest
pnpm lintRun ESLint
cargo test (in rust/)Run the Rust unit and integration tests
pnpm docs:devServe this documentation locally with VitePress
pnpm docs:buildBuild the documentation
pnpm boxart:fetchDownload the featured-cartridge covers into public/boxart/ as WebP

Standard loop ​

  1. Add or update a focused test in the Rust crate
  2. Implement the corresponding subsystem in the emulator core
  3. Run cargo test for the affected module, or pnpm test for browser code
  4. Rebuild the WASM output with pnpm wasm:build when the core changes
  5. Validate the app in the Vite dev environment

See Testing Strategy for what the tests cover and the fuzzing options.

Browser shell ​

The React app is responsible for UI, canvas rendering, and browser integration. It should not contain emulator logic beyond the minimal bridge and event handling required to drive the core.

Documentation ​

The docs site lives under the doc/ folder and is built with VitePress. .github/workflows/deploy-docs.yml publishes it to GitHub Pages on the custom domain pecten.app, with the docs under /docs/.

Diagrams are Mermaid fenced code blocks (rendered by vitepress-plugin-mermaid), so they stay in the Markdown next to the text they illustrate.

User Manual screenshots are WebP files in doc/manual/images/. Take them from the app running the MIT-licensed test ROMs in rust/tests/fixtures/gba-tests/, never from commercial games.