Files
meow/CLAUDE.md
T
yves af12f4ebcf
continuous-integration/drone/push Build is failing
continuous-integration/drone Build is passing
meow servers validation
2026-11-21 17:27:41 +01:00

29 lines
1.5 KiB
Markdown

# CLAUDE.md — rust/
Meow v2 workspace (Rust rewrite of meowlib / meowsrv / meowcli). Protocol v2 is a clean break:
no wire compatibility with the Go v1 stack.
* Read `ROADMAP.md` first: part 2 lists what is left in the recommended order; take the first
lot, then move it to part 1 ("Fait") and add a journal entry when done.
* `ARCHITECTURE.md` is the design reference (crypto constructions, handshake, server API). Keep it in sync.
* Toolchain lives in `~/.cargo/bin` (not on PATH by default): `export PATH=$HOME/.cargo/bin:$PATH`.
## Commands
```bash
scripts/check.sh # fmt --check, clippy -D warnings, cargo test --workspace
tests/e2e.sh # full CLI + 2 servers scenario; E2E_STORAGE=redis://... for Redis
scripts/ffi-test.sh # regenerate Dart bindings (flutter_rust_bridge 2.13.0) + Dart tests in ../bastet
scripts/build-ffi.sh linux|android [debug|release] # native lib (also run by the Flutter builds)
```
## Rules
* `meow-core` does no I/O and takes time as a parameter. Keep it that way.
* No `unsafe` (except the generated `meow-ffi/src/frb_generated.rs`, never edited by hand); no
`unwrap`/`expect` in library code outside tests.
* `meow-ffi/src/api/` is the Dart API: after changing it, run `scripts/ffi-test.sh`.
* Persist ratchet/contact state **before** sending the resulting bytes.
* `proto/meow.proto` is the single wire schema (compiled by protox, no protoc needed). Bump/extend, never renumber.
* Never log keys, mailbox ids or message content at `info` level.