rite-tui 0.3.0

Interactive terminal frontend for Rite ceremonies (internal to the `rite` CLI; no stable API)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Interactive terminal frontend for Rite ceremonies, built on
//! [`ratatui`] and shaped as a TEA (The Elm Architecture) application.
//!
//! The crate exposes a single entry point, [`run`], that the CLI invokes
//! after spawning the executor thread. Inside, the loop merges three
//! input sources into a single [`Msg`] stream:
//!
//! - keyboard / resize events from `crossterm`
//! - executor events from the runtime channel
//! - timer ticks for spinner animation
//!
//! `update(model, msg)` is pure and the only place state changes; it
//! returns a list of [`Cmd`]s the runtime interprets (sending commands
//! back to the executor, quitting). `view(model, frame)` is pure and the
//! only place rendering happens.
//!
//! # Stability
//!
//! Internal crate. This is an implementation detail of the `rite` CLI, with no
//! stable API and no semver guarantees across releases. Build against the
//! public `rite-sdk`, `rite-model`, or `rite-resolver` crates instead.

#![warn(missing_docs)]

mod model;
mod msg;
#[cfg(test)]
mod preview;
mod runtime;
mod update;
mod view;

pub use model::{Model, RunningState, Screen, StepTab};
pub use msg::{Cmd, Msg};
pub use runtime::run;