Address 8 issues found in spec audit (post PR #2): 1. §refs label: distinguish design vs report sections in p3-1 / p3-2 / p4-2 / p9-1 / p9-5 contract_sections (e.g., "report §11.2 Ollama" not "§11.2"). 2. mock feature gate: gate MockEmbedder (p3-1) and MockLanguageModel (p4-1) behind `mock` cargo feature, default OFF; add CI symbol-scan as DoD item. 3. Warning type unification: p1-2 frontmatter now emits `kb_parse_types::Warning` (matches p1-3 / p1-4); drops crate-internal type. 4. p4-3 streaming thread: explicitly single-threaded inside RagPipeline::ask; collection + sink.send share the calling thread, no race. UI concurrency is callers responsibility (TUI worker thread pattern in p9-3). 5. p6-2 tesseract version: noted that `tesseract` 0.13 has no stable Rust `version()` accessor; use TessVersion FFI or shell-out + cache approach. 6. p9-* App struct extensions: introduce `kb_tui::{Library,Search,Ask,Inspect}State` slots in p9-1 forward-decl form; p9-2/3/4 fill bodies in their own crate without editing `App`. Parallel-safety contract added. 7. p3-3 cosine score: shift `(sim+1)/2` instead of clamp; preserve ranking signal between unrelated and opposite vectors. Clamp reserved for NaN. 8. fixtures/ root: p0-1 DoD now creates all fixture subdirs with .gitkeep so downstream tasks have a stable target path.
5.5 KiB
5.5 KiB
phase, component, task_id, title, status, depends_on, unblocks, contract_source, contract_sections
| phase | component | task_id | title | status | depends_on | unblocks | contract_source | contract_sections | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| P9 | kb-tui (search pane) | p9-2 | TUI Search pane: input + result list + preview + editor jump | planned |
|
../../docs/superpowers/specs/2026-04-27-kb-final-form-design.md |
|
p9-2 — TUI Search pane
Goal
Add a Search pane to the TUI that drives kb-app::search, renders dense results (rank+score / path#frag / heading / snippet), and supports g (editor jump to citation) for the selected hit.
Why now / why this size
Search is the most-used surface. Confining it to one pane leverages the App skeleton from p9-1 without rebuilding key dispatch.
Allowed dependencies
kb-corekb-configkb-appkb-tui(extends p9-1)ratatui,crosstermtracingthiserror
Forbidden dependencies
kb-source-fs,kb-parse-*,kb-normalize,kb-chunk,kb-store-*,kb-embed*,kb-search,kb-llm*,kb-rag,kb-desktop
Inputs
| input | type | source |
|---|---|---|
kb-app::search(query) |
facade | runtime |
| keyboard events | crossterm |
terminal |
| selected hit's citation | kb_core::Citation |
App state |
Outputs
| output | type | downstream |
|---|---|---|
| Ratatui frame for Search pane | render | user |
| External editor process spawn | std::process::Command |
OS |
Public surface (signatures only — no new types)
pub fn render_search<B: ratatui::backend::Backend>(f: &mut ratatui::Frame, area: ratatui::layout::Rect, state: &App);
pub fn handle_key_search(state: &mut App, key: crossterm::event::KeyEvent) -> KeyOutcome;
pub fn jump_to_citation(citation: &kb_core::Citation, editor_env: &str /* $EDITOR */) -> anyhow::Result<()>;
This task fills the body of kb_tui::SearchState (forward-declared in p9-1). The App struct itself is NOT edited — only SearchState gets fields:
pub struct SearchState {
pub input: String,
pub mode: kb_core::SearchMode,
pub hits: Vec<kb_core::SearchHit>,
pub selected_hit: usize,
pub last_query_at: Option<time::OffsetDateTime>, // debounce timer
}
The Library pane's keypress handler (in p9-1) sets app.search = Some(SearchState::default()) on pane switch; p9-2's render_search/handle_key_search read app.search.as_mut() exclusively. Parallel-safety contract from p9-1 holds.
Behavior contract
- Layout: top input bar (search query + mode badge
[hybrid|lexical|vector]), middle result list (one hit per 4 lines per design §1.5 dense format), bottom preview pane (full chunk text fetched lazily viakb-app::inspect_chunk). - Key bindings (Search pane):
- typing → updates
search_input; debounced (200 ms) re-search Tab→ cyclessearch_modeLexical → Vector → Hybrid → LexicalEnter→ forces re-search immediatelyj/kor arrow keys → move selected hitg→ calljump_to_citation(&hits[selected].citation, &env::var("EDITOR").unwrap_or_else(|_| "vi".into()))Esc→ switch back to Library pane
- typing → updates
jump_to_citation:- For
Citation::Line { path, start, .. }: spawneditor +<start> <workspace_root>/<path>. Common editorsvim/nvim/vi/emacs/hxaccept+N. Fallback:code -g <path>:<start>if$EDITORcontains "code". - For other citation kinds: open the file in
$EDITORwithout line jump (best effort). - Use
std::process::Command::status()blocking; suspend the TUI (disable_raw_mode) before launch and restore on return.
- For
- The search call runs synchronously; for hybrid mode that may take seconds, render a centered "searching…" overlay until complete.
- All search results rendered must conform to design §1.5 dense format (4 lines:
<rank>. <score> <path#frag>/<section_label>/<snippet line 1>/<snippet line 2>). - Errors → popup overlay (consistent with p9-1).
- Stable terminal restoration on panic and process exit.
Storage / wire effects
- Reads only. No DB writes.
- Spawns external editor process; that process can mutate user files. The TUI does not interfere.
Test plan
| kind | description | fixture / data |
|---|---|---|
| unit | typing into search_input triggers re-search after debounce | inline timer mock |
| unit | Tab cycles mode through 3 values back to Lexical |
inline |
| unit | j / k move selection within bounds |
inline |
| unit | jump_to_citation for Line builds +<line> <path> command (assert via mocked Command runner) |
inline |
| snapshot | rendered Search pane with 3 hits + preview stable | TestBackend |
| integration | mocked kb-app::search returning fixture hits drives render |
inline |
All tests under cargo test -p kb-tui search.
Definition of Done
cargo check -p kb-tuipassescargo test -p kb-tui searchpassesgkeybinding launches$EDITORwith correct+<line>argument (manual smoke against vim)- No imports outside Allowed dependencies
- PR links design §1.5/1.6, §3.7
Out of scope
- Inline citation render of LLM answers (Ask pane = p9-3).
- Full
--explainretrieval trace (mention but defer to a future toggle). - Mouse selection.
Risks / notes
- Suspending and restoring crossterm raw mode around the editor spawn is finicky; code defensively (RAII guard).
- Different editors take different jump syntaxes. Provide an env override
KB_EDITOR_JUMP_FORMAT="vim"for users on exotic editors. - Long snippet text wrap: clamp to viewport width and ellipsize per design §1.5 (
…already in dense template).