Skip to content

development.md

Latest commit

 

History

History
101 lines (76 loc) · 4.59 KB

development.md

File metadata and controls

101 lines (76 loc) · 4.59 KB
Raw

Development

Prerequisites

Commands

Command What it does
bun install Install JavaScript dependencies
bun run tauri dev Run the app with hot reload
bun run tauri build Build every release bundle
bun run build:dmg Build a macOS disk image into src-tauri/target/release/bundle/dmg/
bun run build Type-check and build the frontend only
bun run dev Frontend only, in a browser (no shells: Tauri commands aren't available there)
cargo check --manifest-path src-tauri/Cargo.toml Check the Rust backend
bun run test Type-check the tests and run the frontend and Rust tests
bun run bench Run the benchmarks; see benchmarks.md

bun run tauri dev rebuilds the Rust side when anything under src-tauri/ changes, including the shell scripts in src-tauri/shell/, which are compiled into the binary.

Project structure

src/
  App.tsx                 workspaces, tabs, keyboard handling, persistence
  main.tsx                fonts, initial theme, mount
  theme.ts                themes and fonts
  settings.ts             settings model and storage
  keybindings.ts          shortcut matching and the shortcut list
  layout/paneTree.ts      the pane tree: layout and operations
  components/
    TerminalView.tsx      one xterm.js terminal and its session
    PaneLayout.tsx        panes and draggable dividers for one tab
    TerminalTab.tsx       a tab in the title bar
    WorkspaceSwitcher.tsx ⌘E
    SettingsPanel.tsx     ⌘,
    ShortcutSheet.tsx     ⌘/
src-tauri/
  src/lib.rs              Tauri commands
  src/session.rs          session manager
  src/pty.rs              PTY and shell startup
  shell/                  zsh integration scripts
  capabilities/           what the frontend is allowed to call
docs/                     this documentation

App icon

The icon's source is src-tauri/app-icon.svg. After editing it, render it and regenerate every size:

rsvg-convert -w 1024 -h 1024 src-tauri/app-icon.svg -o src-tauri/app-icon.png
bun run tauri icon src-tauri/app-icon.png

tauri icon also writes Android and iOS icons, which Rook doesn't use; delete src-tauri/icons/android, src-tauri/icons/ios and src-tauri/icons/64x64.png afterwards.

Conventions

  • TypeScript: two-space indentation, single quotes, PascalCase components, camelCase everything else.
  • Rust: rustfmt formatting, snake_case.
  • Keep Tauri command names and argument names aligned between invoke(...) calls and Rust. Tauri maps them by name.
  • Review src-tauri/capabilities/default.json whenever the frontend needs a new backend capability.
  • Commits follow Conventional Commits: feat:, fix:, chore:.

Checking a change

Before opening a pull request:

bun run build
bun run test

bun run test type-checks the tests, then runs both suites:

  • Frontend (bun test): tests sit next to the code as *.test.ts. They cover the pure modules: the pane tree in src/layout/paneTree.ts (including a randomized test that checks the invariants in pane-layout.md after every operation), shortcut matching in keybindings.ts, and settings loading in settings.ts. Test files are excluded from the app's tsconfig.json and type-checked with tsconfig.test.json, so Bun's types stay out of app code.
  • Backend (cargo test): #[cfg(test)] modules at the bottom of session.rs (combining queued output) and pty.rs. The PTY tests start a real zsh, so they need zsh installed.

Then run bun run tauri dev and try what you changed: creating, splitting, resizing and closing panes, typing in them, switching tabs and workspaces, and restarting to check that the session restores.

CI and releases

GitHub Actions runs .github/workflows/ci.yml on every pull request and every push to main: the build, both test suites, on macOS.

To release:

  1. Bump the version in package.json, src-tauri/Cargo.toml and src-tauri/tauri.conf.json (and Cargo.lock, via cargo check), plus the download links in the README, then merge that to main.
  2. Publish a GitHub release for tag vX.Y.Z with your notes, for example gh release create v0.1.7 --target main --notes-file notes.md.
  3. .github/workflows/release.yml checks that the tag matches the app version, runs the tests, builds the DMG and attaches it to the release. It takes a few minutes after publishing.