Lutra/docs/development.md
danny ba70b0f43a H6: isolated data directory for dev and live-check instances
`--data-dir DIR` / `LUTRA_DATA_DIR` move settings, the recovery journal,
the rendezvous file and the WebView2 user data folder into one directory.
`--control PORT` without either uses `<temp>/lutra-control/<port>/`. The
SHA-256-checked Phpactor cache stays shared from the user's data dir
(`Engine::share_tools_from`). An isolated instance never forwards to or
registers as the user's main instance; `rendezvous::dir()` honours
`LUTRA_DATA_DIR` after `LUTRA_RENDEZVOUS_DIR`, so the CLI finds it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-25 13:03:37 +01:00

1.6 KiB
Raw Blame History

Development

Status: draft · Last updated: 2026-10-14

Prerequisites

  • Rust stable (via rustup), edition 2024
  • Node.js 22.12 or newer (Vite 8 needs it) and pnpm 10
  • Tauri 2 system prerequisites for your platform (WebView2 on Windows, WebKitGTK on Linux)
  • Optional: Phpactor on the PATH for language features, PHP 8.2+ and Composer for reference projects

Everyday commands

cargo xtask dev        # run the app in development mode
cargo xtask dev -- --control 7979 .   # with the JSON control channel
cargo xtask ci         # the full quality gate, run before every commit
cargo xtask fixtures   # create Symfony and Laravel reference projects in target/fixtures/

A --control PORT instance keeps its settings, recovery journal and webview data in <temp>/lutra-control/<port>/, never in your own data directory; --data-dir DIR or LUTRA_DATA_DIR=DIR pick another directory. Delete the folder to start fresh.

Robustness: Lutra never crashes

Shipped code returns errors instead of panicking (see AGENTS.md › Never crash). The engine guard catches panics at every entry point, keeps buffers intact and reports an internal error. Unsaved buffers are journaled so a restart can restore them.

Code style

No inline comments. Doc comment blocks above modules, functions, types and fields explain purpose, parameters, return values and errors.

Revision history

Date Change Summary
2026-10-25 minor Isolated data directory for --control instances (H6)
2026-10-14 minor Node.js 22.12+ required by the frontend toolchain
2026-10-13 major Initial draft