Sign up
View stargazers0Sign up
Commits

docs/11-crates.md

11 — Crate & Module Layout

Cargo workspace, edition 2021, MSRV 1.92 (required by the locked GTK dependency family). Development uses rust-toolchain.toml; CI checks the minimum separately.

text
1Cargo.toml # workspace
2crates/
3 signaltty-core/ # toolkit-free domain model (no tokio, no PTY)
4 src/{lib,ids,model,state,layout,notification,git,error}.rs
5 signaltty-proto/ # IPC envelopes, methods, events, versions
6 src/{lib,protocol,message,method,event,error}.rs
7 signaltty-term/ # TerminalBackend trait + headless impl + OSC scan
8 src/{lib,backend,headless,osc,sanitize}.rs
9 signaltty-agent/ # Phase 2: AgentAdapter trait + impls + hooks
10 src/{lib,types,registry,adapters/*}.rs
11 signaltty-integration/ # OS-facing hook configuration/transactions (ADR-0013)
12 src/lib.rs
13 signaltty-server/ # daemon: store, PTY mgr, router, persist, bus
14 src/{main,server,store,pty,router,events,persist,config,gitwatch}.rs
15 signaltty-cli/ # clap client (human + automation + hooks entry)
16 src/{main,client,daemon,attach,integration}.rs
17 signaltty-plugin/ # Phase 4: plugin.toml manifests + hook dispatch
18 src/lib.rs
19 signaltty-gui/ # Phase 3: gtk4 + libadwaita + vte4 (plain gtk-rs)
20 src/{main,app,actor,sidebar,terminal,notif,util}.rs
21 signaltty-testkit/ # shared integration-test harness (real PTYs)
22 src/{lib,server,pty_helpers}.rs

Dependency rules

  • core: serde, serde_json, uuid, chrono, thiserror only. No async, no OS calls.

  • proto → core. term → core (+vt100, vte).

  • server → core, proto, term, agent, integration (+tokio, portable-pty, serde_json, nix, base64).

  • cli → core, proto, integration (+tokio, clap, serde_json). Never server.

  • gui → core, proto (+gtk4, libadwaita, vte4, notify-rust). Never server, never PTY crates.

  • plugin → core, proto (+tokio, toml). server and cli depend on it; it never depends on them.

  • agent → core, proto only; adapters are pure classifiers over AdapterEvent snapshots so they stay unit-testable without PTYs.

  • integration → serde, serde_json, thiserror, nix only; filesystem hook installation shared by server/CLI, never GTK or server dependencies.

scripts/check-quality.py architecture validates resolved Cargo package identities, including aliases and transitive normal/build edges. It checks the core/proto direct allowlists, toolkit exclusion outside GUI, and server/PTY exclusion from clients. Dev-only edges are excluded so integration test fixtures can use testkit. This does not prove absence of OS calls in source; that remains a code-review responsibility.

Binaries

signaltty-server (daemon), signaltty (CLI), signaltty-gui (Phase 3). One version for the whole workspace; server.status reports it and IPC refuses cross-major mismatches.

Phase 1 build order

core → proto → term → server → cli → testkit, each with unit tests; integration tests live in server/tests/ + cli/tests/ using testkit with real PTYs.