Compare commits

...
4 Commits
Author SHA1 Message Date
Ansho ReiandClaude Opus 5 f16e2aba0c (3686dd6) Open a command prompt on the board with : and parse what is typed, and bump to 0.32.15
The board reads. Changing anything meant quitting it and retyping an id
that was already selected. So `:` opens a one line editor in the footer
and the line is a worklane command, spelled exactly as the shell spells
it.

This is the mode and the grammar check, not the doing. Enter tokenises
the line with split_line, prepends the binary's own name and hands the
arguments to the same Cli definition the shell reaches, so a flag added
to a command is typeable here the day it is added and no list of verbs
lives on the board to go stale. A line that resolves is named and the
prompt closes; a line that does not keeps the prompt open with the line
intact and clap's own message, cut back to what fits a row. Running it
is 53ffb94, and the notice and the `↵ check` key both say so rather than
reading like a move that happened.

The prompt owns the keyboard while it is open, the contract search_key
and picker_key already keep, and declines ctrl-c for the same reason
they do. A line that ends inside a quote never reaches clap, which is
what the splitter's Unclosed state is for. --help is caught, or clap's
page lands on the alternate screen the way an unsunk println! would.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-27 21:07:26 +02:00
Ansho ReiandClaude Opus 5 bf7d8e05d8 (54fde0b) Split a typed command line into arguments the way a shell does, and bump to 0.32.14
The command prompt reads one string and clap reads an argv, so a line has
to be tokenised before anything can parse it: `comment 1b78a24 the offset
was never passed` split on whitespace is five arguments and `comment`
takes two.

One pure function over the line and the cursor, in a module of its own
rather than in tui.rs. The rules are the shell's, because that is what
the prompt promises. Two answers a shell's own splitter does not owe
anybody come out of the same scan: what a half-typed line is still
inside, as a state to report rather than an error to raise, and which
argument the cursor is in with whether it begins one.

Nothing calls it yet. The prompt that will is 3686dd6, and the dead_code
allow on the module goes when it lands.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-27 20:13:01 +02:00
Ansho Rei 30a2b3429e Specify in skill that set overwrites and to use append when that is not desired 2026-08-27 14:11:59 +02:00
Ansho Rei 69bc2feef5 (fa5662a) Write handler output through a caller-supplied sink, and bump to 0.32.13 2026-08-27 08:13:32 +02:00
9 changed files with 1729 additions and 173 deletions
+22
View File
@@ -9,6 +9,7 @@
- `src/campaign.rs` - the campaign file format, its resolution, its index and its members
- `src/history.rs` - the history log: the path, the kinds, the reader, the writer, the card's counter and the block `show` and the board both render
- `src/tui.rs` - board state, the change digest, and the ratatui draw
- `src/split.rs` - one pure function turning a typed line into arguments the way a shell does, plus what the half-typed line is still inside and where the cursor sits among them
- `src/clipboard.rs` - the OSC 52 write and the base64 it carries, the board's only way out to the clipboard
- `src/install.rs` - the embedded agent assets and the compare-and-refuse install
- `assets/SKILL.md` - the agent skill for the CLI itself, embedded with `include_str!`
@@ -350,6 +351,27 @@ and this file is for what someone changing worklane's own code needs.
- Both closed footers name `/`, since the jump works with a ticket open as well: it moves the selection and the overlay follows
- Out of scope on purpose, each its own ticket once the input mode exists: `n` and `N` for the next and previous match, searching the description, tags or owner, regex, and filtering the board down to matches rather than selecting one
### The Command Prompt
- **`prompt: Option<Prompt>` is the whole mode**, the shape `search` and `detail` use: open and content cannot disagree, and closing it leaves nothing to reset. `Prompt` carries the line, the cursor as a byte offset into it, and `refused`, which is `Search::missed` with something to say
- **`Board::prompt_key` is third in the pre-dispatch**, beside `search_key` and `picker_key` and on the same contract: while a command is being typed `q` is a letter, `d` leaves the columns alone and `tab` stays out of the project tabs, and `ctrl-c` is the one key declined. It takes no `Size`, because nothing it does measures the board — the keypress that will is 53ffb94, which redraws on what the command wrote. Only one of the two prompts can be open at once: `:` is reachable from the action arms alone, and while either has the keyboard the other's key is a character in a line
- **`esc` and `enter` are the mode's own keys and are answered in `prompt_key`; everything else belongs to the line and goes to `Prompt::key`.** That is also what keeps the borrow straight, since closing the prompt takes the whole board and editing takes only the prompt. Left, right, home, end, backspace and `ctrl-w` behave as they do in a shell, and `ctrl-w` eats the separators behind the cursor before the word behind those, so one press at the end of `mv 1b78a24 ` takes the id. There is deliberately no `tab`: suggesting the selected ticket is 00a14e7, and until then it is a key that must not reach the tabs
- **The grammar is clap's, with nothing restated.** The line is tokenised by `split_line`, the binary's own name goes in front, and the arguments go to the same `Cli` definition the shell reaches, so a flag added to a command is typeable here the day it is added. Through `Cli::command().try_get_matches_from_mut` rather than `try_parse_from`, for what the matches give back: `command_name` walks the subcommands to name what resolved (`campaign show`, not `campaign`) instead of a `match` over every variant, which would be a second list of every verb the CLI has and one that goes stale silently
- **`refused` is cleared by an edit and not by a movement.** The message is about the line, and moving the cursor does not change the line. `Prompt::key` clears it in the three arms that write to the line
- **A line that ends inside a quote never reaches clap.** That is what `Unclosed` is for: a grammar complaint about a sentence nobody finished describes the wrong thing. Enter on an empty line, or one of nothing but separators, closes the prompt with nothing said, the way `esc` does — the bare form of the CLI opens a board and there is one on the screen
- **Enter resolves the line and does not run it**, so the notice says `parsed, not run yet` rather than reading like a move that happened, and the prompt's own key is drawn as `↵ check`. Both are replaced by 53ffb94, which is the ticket that runs it; naming the key `run` here would be the fault 1b78a24 was, in the other direction
- **What a refused line shows is clap's own message with the usage block cut off**, which is also what drops the `--help` line after it. `--help` is the exception: it parses as an error of the kind that means *print this* and what it would print is a page, so it is caught and answered in a row's worth of words, or clap's help lands on the alternate screen the way an unsunk `println!` would. `--version` goes through the ordinary path, because what it prints is one line by construction. `ColorChoice::Never` on the command, so nothing that reaches the row carries an escape
- **The keys' width comes off the row before the line is windowed**, so a long command does not push them off the end; a message takes the row from the keys instead, since the reader has just been told something and `esc` and `enter` still do what they did. `prompt_window` anchors the window on the cursor's right edge, which costs the text *after* the cursor on a long line: keeping both ends needs a scroll offset in state, and the draw is where the width is known and the state is not writable
- `: command` is named in every footer state, because the key works in every one of them
### Splitting a Typed Line
- **`split_line` is the whole module, and it knows nothing about `Board`.** The command prompt reads one string and clap reads an argv, so `comment 1b78a24 the offset was never passed` has to be tokenised before anything can parse it: split on whitespace it is five arguments and `comment` takes two. A pure function over the line and the cursor is what makes every rule reachable from a unit test, and it is in a file of its own rather than in `tui.rs`, which is eleven thousand lines already
- **The rules are the shell's, because that is what the prompt promises**: the line is spelled there exactly as it is spelled in the shell. Runs of whitespace separate arguments, single and double quotes group one, a backslash escapes the next character *except* inside single quotes where it is a backslash, and an explicitly empty `''` is an argument that exists and is empty — which is what `--title ""` being a usage error rather than a silent clear depends on. A leading hyphen is not special here: whether `--foo` is a flag or the text of a criterion is clap's question, and `PROSE` already answers it
- **Written rather than pulled in, for the two answers a shell's own splitter does not owe anybody.** A line being typed is half finished, so an unterminated quote is a state to report and not an error to raise: `Unclosed` says which quote is open, or that the line ends on a backslash with nothing yet to escape, and the arguments up to that point are handed back anyway, because that is what a hint or a completion has to work from. And completion needs the cursor: which argument it is in counting from the verb, and whether nothing of that argument lies before it, which is the difference between completing an argument and starting one. Both fall out of the one scan and neither is reachable afterwards from the arguments alone
- **`Some("")` is an argument that has been opened and is still empty**, which is the only thing that tells `''` from nothing typed at all. The cursor's answer is taken *before* the last argument is pushed, so a cursor at the end of the line is in the argument being typed rather than one past it
- The cursor is a byte offset, because that is what the prompt's own cursor is: a `String` inserts and removes at byte indices. Past the end reads as the end and inside a multi-byte character reads as after it, so nothing panics and no caller has to clamp first
- `Unclosed::Escape` wins over an open quote, being the inner of the two, and either answer refuses the line
- The binary's own name is not among the arguments: prepending it before `Cli::try_parse_from` is the caller's, since only the caller knows what it is calling
### The Copy Key
- **`y` copies the selected card's short id, over OSC 52 written by hand.** The board is where a ticket is found and the CLI is where it is acted on, and the only thing joining them was seven characters retyped off the screen. `y` reads as yank to the readers a keyboard board is for, and was the letter left: `q`, `esc`, `enter`, `space`, `hjkl`, the arrows, `pgup`, `pgdn`, `tab`, `backtab`, `d` and `/` were taken
- **The mechanism was chosen against ssh**, which is where a board is often read. An escape sequence is the only one of the three ways that crosses the connection, since it is the terminal at the reader's end that owns the clipboard. A crate (`arboard` and its kind) wants X11 and Wayland libraries at build time, and on X11 the selection belongs to the process that set it: copy an id, quit, and the paste buffer is empty, which is precisely this flow. Shelling out to `wl-copy`, `xclip` or `pbcopy` is platform sniffing plus a process spawn, and does nothing on a machine where none of them is installed or on the far end of a connection. crossterm 0.28 is what ratatui 0.29 pins and it ships no clipboard command, and the backend types have to match whatever ratatui pins, so a newer crossterm cannot be picked up on its own
Generated
+1 -1
View File
@@ -1503,7 +1503,7 @@ dependencies = [
[[package]]
name = "worklane"
version = "0.32.12"
version = "0.32.15"
dependencies = [
"anyhow",
"assert_cmd",
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "worklane"
version = "0.32.12"
version = "0.32.15"
edition = "2024"
[dependencies]
+6 -4
View File
@@ -173,10 +173,12 @@ worklane chown alice 1b78a24 # hand the ticket to someone
worklane chown --clear 1b78a24 # hand it back to nobody
```
`set` replaces, `append` adds, `--clear` empties. Neither `set` nor `append` has
`--owner` or `--status`: owner is `chown`'s and status is `mv`'s, so each field has
exactly one writer. A field set to the value it already holds is reported unchanged and
nothing is written, and so is a field cleared that was already unset.
`set` replaces, `append` adds, `--clear` empties. `set --tags` overwrites the whole
field: to add a tag to a ticket that already carries one, replace the value with every
tag separated by commas. Neither `set` nor `append` has `--owner` or `--status`: owner
is `chown`'s and status is `mv`'s, so each field has exactly one writer. A field set to
the value it already holds is reported unchanged and nothing is written, and so is a
field cleared that was already unset.
**`--clear` takes the field as its value**, one of `due`, `tags`, `priority`,
`description`, `acceptance` or `plan`, and repeats. It writes back exactly what `add`
+283 -125
View File
@@ -2,7 +2,7 @@ use anyhow::{Result, anyhow};
use chrono::Local;
use std::collections::BTreeMap;
use std::fs;
use std::io::{BufRead, IsTerminal, Write};
use std::io::{BufRead, IsTerminal};
use std::path::Path;
use crate::campaign::*;
@@ -15,12 +15,12 @@ use crate::install;
use crate::tag::{TAGS_FILE, TagIndex, tags_path};
use crate::util::*;
pub fn cmd_init(start: &Path) -> Result<()> {
pub fn cmd_init(start: &Path, sink: &mut Sink) -> Result<()> {
let dir = start.canonicalize().unwrap_or_else(|_| start.to_path_buf());
let worklane_dir = dir.join(".worklane");
if worklane_dir.exists() {
println!("worklane already initialized in: {}", worklane_dir.display());
sink.writeln(&format!("worklane already initialized in: {}", worklane_dir.display()))?;
return Ok(());
}
@@ -42,11 +42,11 @@ pub fn cmd_init(start: &Path) -> Result<()> {
// directory was made three lines ago, so there is nothing here to truncate.
fs::write(tags_path(&worklane_dir), TagIndex::default().render())?;
println!("Initialized worklane in: {}", worklane_dir.display());
sink.writeln(&format!("Initialized worklane in: {}", worklane_dir.display()))?;
Ok(())
}
pub fn cmd_ls(args: &LsArgs, worklane_dir: &Path) -> Result<()> {
pub fn cmd_ls(args: &LsArgs, worklane_dir: &Path, sink: &mut Sink) -> Result<()> {
// Resolved before anything is read, so an unknown campaign is refused rather than
// silently listing nothing, and the name is available for the heading. Ahead of the
// `--ids` branch too: a completion that quietly listed the whole board because the
@@ -58,17 +58,18 @@ pub fn cmd_ls(args: &LsArgs, worklane_dir: &Path) -> Result<()> {
let uuid = campaign.as_ref().map(|campaign| campaign.uuid.as_str());
let tag = args.tag.as_deref();
let priority_filter = args.priority;
let colored = sink.use_color;
if args.ids {
return list_ids(args.status, priority_filter, uuid, tag, worklane_dir);
return list_ids(sink, args.status, priority_filter, uuid, tag, worklane_dir);
}
if let Some(campaign) = &campaign {
println!(
sink.writeln(&format!(
"Members of campaign ({}) {}\n",
color_text(short_id(&campaign.uuid), Color::Red),
color_text(&campaign.title, Color::Green),
);
paint(short_id(&campaign.uuid), Color::Red, colored),
paint(&campaign.title, Color::Green, colored),
))?;
}
if let Some(status) = args.status {
@@ -92,16 +93,16 @@ pub fn cmd_ls(args: &LsArgs, worklane_dir: &Path) -> Result<()> {
items.sort_by(|a, b| by_status_order(status, a, b));
if items.is_empty() {
println!("No tickets in '{}' status.", name);
sink.writeln(&format!("No tickets in '{}' status.", name))?;
return Ok(());
}
println!("Tickets in '{}' status:\n", name);
display_ticket_items(&items);
sink.writeln(&format!("Tickets in '{}' status:\n", name))?;
display_ticket_items(sink, &items)?;
} else {
// List all statuses with their ticket counts
let statuses = status_dirs();
println!("Tickets by status:\n");
sink.writeln("Tickets by status:\n")?;
for status in &statuses {
let status_path = worklane_dir.join(status);
if !status_path.exists() {
@@ -110,7 +111,7 @@ pub fn cmd_ls(args: &LsArgs, worklane_dir: &Path) -> Result<()> {
let items = filtered(collect_ticket_items(&status_path)?, priority_filter, uuid, tag);
let count = items.len();
let label = if count == 1 { "ticket" } else { "tickets" };
println!(" [{}] {} {}", status.to_uppercase(), count, label);
sink.writeln(&format!(" [{}] {} {}", status.to_uppercase(), count, label))?;
}
// Show all tickets except the two terminal statuses, grouped by status. Over
@@ -134,9 +135,9 @@ pub fn cmd_ls(args: &LsArgs, worklane_dir: &Path) -> Result<()> {
continue;
}
let status_header =
color_text(&format!("[{}]", status.as_str().to_uppercase()), Color::Orange);
println!("\n{}", status_header);
display_ticket_items(&items);
paint(&format!("[{}]", status.as_str().to_uppercase()), Color::Orange, colored);
sink.writeln(&format!("\n{}", status_header))?;
display_ticket_items(sink, &items)?;
}
}
@@ -160,6 +161,7 @@ pub fn cmd_ls(args: &LsArgs, worklane_dir: &Path) -> Result<()> {
/// parts company with the listing. The caller is usually a shell filling in a candidate
/// list, and an error printed over the prompt is worse there than no candidates.
fn list_ids(
sink: &mut Sink,
status: Option<Status>,
level: Option<u8>,
campaign: Option<&str>,
@@ -181,7 +183,7 @@ fn list_ids(
let mut items = filtered(collect_ticket_items(&status_path)?, level, campaign, tag);
items.sort_by(|a, b| by_status_order(status, a, b));
for item in items {
println!("{}\t{}", item.id, item.title);
sink.writeln(&format!("{}\t{}", item.id, item.title))?;
}
}
@@ -243,7 +245,7 @@ fn filter_by_priority(items: Vec<TicketItem>, level: Option<u8>) -> Vec<TicketIt
}
}
pub fn cmd_add(args: &AddArgs, start: &Path) -> Result<()> {
pub fn cmd_add(args: &AddArgs, start: &Path, sink: &mut Sink) -> Result<()> {
let AddArgs {
title,
description,
@@ -349,28 +351,28 @@ pub fn cmd_add(args: &AddArgs, start: &Path) -> Result<()> {
// the same writer as every edit is the one that makes the new file appear whole.
write_then_replace(&worklane_dir, &filepath, &filename, &body, TICKET, title)?;
println!("Created ticket: {}", filename);
sink.writeln(&format!("Created ticket: {}", filename))?;
Ok(())
}
pub fn cmd_show(search: &str, worklane_dir: &Path) -> Result<()> {
pub fn cmd_show(search: &str, worklane_dir: &Path, sink: &mut Sink) -> Result<()> {
let colored = sink.use_color;
let (_status, title, content) = resolve_ticket(search, worklane_dir)?;
let ticket_uuid = parse_ticket_field(&content, "ID");
// Read before anything is printed, so a board that cannot be read fails instead of
// half printing a ticket.
// Read before anything is printed, so a board that cannot be read fails instead of recover.
let resolved = resolved_for(&content, worklane_dir)?;
// The only title in the output: content_trim_colored used to print it a second
// The only title in the output: content_trim used to print it a second
// time from the file content. Green per the colour guideline, and the rule is
// measured in characters so a non-ASCII title is not over-drawn.
println!("{}", color_text(&title, Color::Green));
println!("{}", "─".repeat(title.chars().count()));
println!("\n{}", content_trim_colored(&content, &resolved));
sink.writeln(&paint(&title, Color::Green, colored))?;
sink.writeln(&"─".repeat(title.chars().count()))?;
sink.writeln(&format!("\n{}", content_trim(&content, colored, &resolved)))?;
if ticket_uuid != "_Not set_" {
let entries = read_history(worklane_dir, &ticket_uuid)?;
let formatted = format_history(&entries);
println!("{}", formatted);
sink.writeln(&formatted)?;
}
Ok(())
@@ -598,7 +600,7 @@ fn check_dependents(worklane_dir: &Path, uuid: &str, title: &str) -> Result<()>
/// A status is a [`Status`] rather than a string, so an unknown one is clap's to refuse
/// and nothing here has to check. What is left is the order of the flow, which is
/// `Status::ALL`.
pub fn cmd_mv(args: &MvArgs, start: &Path) -> Result<()> {
pub fn cmd_mv(args: &MvArgs, start: &Path, sink: &mut Sink) -> Result<()> {
let MvArgs {
ticket: ticket_id,
status: target,
@@ -657,10 +659,10 @@ pub fn cmd_mv(args: &MvArgs, start: &Path) -> Result<()> {
let recorded = parse_ticket_field(&resolved, "Status");
if recorded == target_status {
println!(
sink.writeln(&format!(
"Ticket is already in '{}' status.",
color_text(target_status, Color::Orange)
);
paint(target_status, Color::Orange, sink.use_color)
))?;
return Ok(());
}
@@ -679,12 +681,12 @@ pub fn cmd_mv(args: &MvArgs, start: &Path) -> Result<()> {
&corrected,
)?;
println!(
sink.writeln(&format!(
"Corrected Status field on '{}': said {}, but the file sits in {}.",
color_text(&title, Color::Green),
color_text(&recorded, Color::Orange),
color_text(target_status, Color::Orange)
);
paint(&title, Color::Green, sink.use_color),
paint(&recorded, Color::Orange, sink.use_color),
paint(target_status, Color::Orange, sink.use_color)
))?;
return Ok(());
}
@@ -747,12 +749,12 @@ pub fn cmd_mv(args: &MvArgs, start: &Path) -> Result<()> {
&reason,
)?;
println!(
sink.writeln(&format!(
"Moved ticket '{}' from {} to {}",
color_text(&title, Color::Green),
color_text(&current_status, Color::Orange),
color_text(target_status, Color::Orange),
);
paint(&title, Color::Green, sink.use_color),
paint(&current_status, Color::Orange, sink.use_color),
paint(target_status, Color::Orange, sink.use_color),
))?;
Ok(())
}
@@ -763,6 +765,7 @@ pub fn cmd_comment(
actor: &Option<String>,
actor_from_git: bool,
start: &Path,
sink: &mut Sink,
) -> Result<()> {
if body.is_empty() {
return Err(anyhow!("Comment body is required."));
@@ -785,7 +788,7 @@ pub fn cmd_comment(
"",
)?;
println!("Comment added to '{}' ({})", title, filename);
sink.writeln(&format!("Comment added to '{}' ({})", title, filename))?;
Ok(())
}
@@ -928,8 +931,8 @@ fn apply(content: &mut String, changed: &mut Vec<&'static str>, field: &'static
}
}
fn report(fields: &[&str], title: &str, verb: &str) {
report_in(fields, title, Color::Green, verb)
fn report(sink: &mut Sink, fields: &[&str], title: &str, verb: &str) -> Result<()> {
report_in(sink, fields, title, Color::Green, verb)
}
/// The same, for a subject that is not a title.
@@ -939,16 +942,28 @@ fn report(fields: &[&str], title: &str, verb: &str) {
/// not one of them. The colour is passed in rather than decided here, which is the trade
/// `paint` makes with `color_text`, and it keeps the wording in one place so a tag reports
/// a no-op in the same words a ticket does.
fn report_in(fields: &[&str], title: &str, color: Color, verb: &str) {
fn report_in(
sink: &mut Sink,
fields: &[&str],
title: &str,
color: Color,
verb: &str,
) -> Result<()> {
if fields.is_empty() {
println!("No changes to '{}'", color_text(title, color));
return;
sink.writeln(&format!("No changes to '{}'", sink.color(title, color)))?;
return Ok(());
}
println!("{} {} on '{}'", verb, fields.join(", "), color_text(title, color));
sink.writeln(&format!(
"{} {} on '{}'",
verb,
fields.join(", "),
sink.color(title, color)
))?;
Ok(())
}
pub fn cmd_set(args: &SetArgs, start: &Path) -> Result<()> {
pub fn cmd_set(args: &SetArgs, start: &Path, sink: &mut Sink) -> Result<()> {
if let Some(field) = args.contested() {
let name = field.name();
return Err(anyhow!(
@@ -1010,7 +1025,7 @@ pub fn cmd_set(args: &SetArgs, start: &Path) -> Result<()> {
}
if changed.is_empty() && cleared.is_empty() {
report(&[], &title, "Updated");
report(sink, &[], &title, "Updated")?;
return Ok(());
}
@@ -1037,10 +1052,10 @@ pub fn cmd_set(args: &SetArgs, start: &Path) -> Result<()> {
let shown = args.title.clone().unwrap_or(title);
if !changed.is_empty() {
report(&changed, &shown, "Updated");
report(sink, &changed, &shown, "Updated")?;
}
if !cleared.is_empty() {
report(&cleared, &shown, "Cleared");
report(sink, &cleared, &shown, "Cleared")?;
}
Ok(())
}
@@ -1061,7 +1076,7 @@ pub fn cmd_set(args: &SetArgs, start: &Path) -> Result<()> {
/// for a ticket it is filing, which is a default for something new; an owner taken away
/// says nobody owns this, and putting the person running the command there instead would
/// hand them a ticket they were giving up.
pub fn cmd_chown(args: &ChownArgs, start: &Path) -> Result<()> {
pub fn cmd_chown(args: &ChownArgs, start: &Path, sink: &mut Sink) -> Result<()> {
let (ticket_id, user) = args.target().ok_or_else(|| {
anyhow!("chown takes a user and a ticket, or --clear with the ticket alone")
})?;
@@ -1073,7 +1088,7 @@ pub fn cmd_chown(args: &ChownArgs, start: &Path) -> Result<()> {
let content = set_metadata_field(&original, "Owner", user.unwrap_or(NOT_SET), &title)?;
if content == original {
report(&[], &title, "Updated");
report(sink, &[], &title, "Updated")?;
return Ok(());
}
@@ -1097,11 +1112,11 @@ pub fn cmd_chown(args: &ChownArgs, start: &Path) -> Result<()> {
Some(_) => "Updated",
None => "Cleared",
};
report(&["owner"], &title, verb);
report(sink, &["owner"], &title, verb)?;
Ok(())
}
pub fn cmd_append(args: &AppendArgs, start: &Path) -> Result<()> {
pub fn cmd_append(args: &AppendArgs, start: &Path, sink: &mut Sink) -> Result<()> {
let worklane_dir = find_worklane_dir(start)?;
let (status, title, original) = resolve_ticket(&args.ticket, &worklane_dir)?;
let uuid = parse_ticket_field(&original, "ID");
@@ -1122,7 +1137,7 @@ pub fn cmd_append(args: &AppendArgs, start: &Path) -> Result<()> {
save_ticket(&worklane_dir, &status, &uuid, &title, None, &content)?;
report(&changed, &title, "Appended to");
report(sink, &changed, &title, "Appended to")?;
Ok(())
}
@@ -1210,7 +1225,7 @@ fn find_relation(
}
}
pub fn cmd_relate(args: &RelateArgs, start: &Path) -> Result<()> {
pub fn cmd_relate(args: &RelateArgs, start: &Path, sink: &mut Sink) -> Result<()> {
let worklane_dir = find_worklane_dir(start)?;
let (status, title, original) = resolve_ticket(&args.ticket, &worklane_dir)?;
let uuid = parse_ticket_field(&original, "ID");
@@ -1303,7 +1318,7 @@ pub fn cmd_relate(args: &RelateArgs, start: &Path) -> Result<()> {
}
if items.is_empty() && dropped.is_empty() {
report(&[], &title, "Recorded");
report(sink, &[], &title, "Recorded")?;
return Ok(());
}
@@ -1336,10 +1351,10 @@ pub fn cmd_relate(args: &RelateArgs, start: &Path) -> Result<()> {
save_ticket(&worklane_dir, &status, &uuid, &title, None, &content)?;
if !changed.is_empty() {
report(&changed, &title, "Recorded");
report(sink, &changed, &title, "Recorded")?;
}
if !cleared.is_empty() {
report(&cleared, &title, "Cleared");
report(sink, &cleared, &title, "Cleared")?;
}
Ok(())
}
@@ -1351,7 +1366,7 @@ pub fn cmd_relate(args: &RelateArgs, start: &Path) -> Result<()> {
/// Written through `write_then_replace` rather than `fs::write`, so a failure leaves no
/// half-written campaign behind. `cmd_add` predates that primitive and still uses the
/// plain write; the difference is noted on the ticket rather than fixed here.
pub fn cmd_campaign_add(args: &CampaignAddArgs, start: &Path) -> Result<()> {
pub fn cmd_campaign_add(args: &CampaignAddArgs, start: &Path, sink: &mut Sink) -> Result<()> {
let CampaignAddArgs {
title,
description,
@@ -1382,7 +1397,7 @@ pub fn cmd_campaign_add(args: &CampaignAddArgs, start: &Path) -> Result<()> {
write_then_replace(&worklane_dir, &path, &filename, &body, CAMPAIGN, title)?;
println!("Created campaign: {}", filename);
sink.writeln(&format!("Created campaign: {}", filename))?;
Ok(())
}
@@ -1392,26 +1407,26 @@ pub fn cmd_campaign_add(args: &CampaignAddArgs, start: &Path) -> Result<()> {
/// scan per row rather than one scan reused, and it is deliberate: the alternative is a
/// map from campaign uuid to counts built in a single walk, which is worth writing when
/// a board has enough campaigns to notice and is premature now.
pub fn cmd_campaign_ls(worklane_dir: &Path, ids: bool) -> Result<()> {
pub fn cmd_campaign_ls(worklane_dir: &Path, ids: bool, sink: &mut Sink) -> Result<()> {
let index = CampaignIndex::load(worklane_dir)?;
let colored = sink.use_color;
// Ahead of the empty check, which prints prose: a completion must offer nothing
// rather than offer a sentence, the same bargain `list_ids` takes with a missing
// status directory.
if ids {
for campaign in index.iter() {
println!("{}\t{}", short_id(&campaign.uuid), campaign.title);
sink.writeln(&format!("{}\t{}", short_id(&campaign.uuid), campaign.title))?;
}
return Ok(());
}
if index.is_empty() {
println!("No campaigns yet. `worklane campaign add --title` files one.");
sink.writeln("No campaigns yet. `worklane campaign add --title` files one.")?;
return Ok(());
}
let colored = should_use_colors();
println!("Campaigns:\n");
sink.writeln("Campaigns:\n")?;
for campaign in index.iter() {
let standing = Standing::of(&members(worklane_dir, &campaign.uuid)?);
@@ -1432,14 +1447,14 @@ pub fn cmd_campaign_ls(worklane_dir: &Path, ids: bool) -> Result<()> {
false => String::new(),
};
println!(
sink.writeln(&format!(
" ({}) {}{} | {}{}",
paint(short_id(&campaign.uuid), Color::Red, colored),
codename,
campaign.title,
standing.label(),
state,
);
))?;
}
Ok(())
@@ -1479,7 +1494,7 @@ pub fn cmd_campaign_ls(worklane_dir: &Path, ids: bool) -> Result<()> {
///
/// Every status, done included, for the reason `ls --ids` includes it: a tag retired months
/// ago is still part of the answer to what the vocabulary has been.
pub fn cmd_tags(worklane_dir: &Path) -> Result<()> {
pub fn cmd_tags(worklane_dir: &Path, sink: &mut Sink) -> Result<()> {
// Through the same `load` `tags add` uses, so a file that is there and cannot be read
// is an error here too. The listing is the one tag command that could go on without the
// file, and reporting a vocabulary while silently treating a broken file as no file is
@@ -1507,8 +1522,8 @@ pub fn cmd_tags(worklane_dir: &Path) -> Result<()> {
for (tag, count) in counts {
match index.summary(&tag) {
Some(summary) => println!("{tag}\t{count}\t{summary}"),
None => println!("{tag}\t{count}"),
Some(summary) => sink.writeln(&format!("{tag}\t{count}\t{summary}"))?,
None => sink.writeln(&format!("{tag}\t{count}"))?,
}
}
@@ -1531,7 +1546,7 @@ pub fn cmd_tags(worklane_dir: &Path) -> Result<()> {
/// The whole file is re-rendered from the parsed vocabulary, so declaring a tag also
/// re-sorts the file and rewrites its preamble. That is why an unreadable file is an error
/// in `TagIndex::load` rather than an empty vocabulary: here, empty would mean erased.
pub fn cmd_tag_add(args: &TagAddArgs, start: &Path) -> Result<()> {
pub fn cmd_tag_add(args: &TagAddArgs, start: &Path, sink: &mut Sink) -> Result<()> {
let worklane_dir = find_worklane_dir(start)?;
let mut index = TagIndex::load(&worklane_dir)?;
@@ -1559,7 +1574,10 @@ pub fn cmd_tag_add(args: &TagAddArgs, start: &Path) -> Result<()> {
// The tag in its own colour, which is the colour it is drawn in on every card and in
// every listing: `tag_color` is a pure function of the word.
println!("Declared tag: {}", color_text(&args.tag, tag_color(&args.tag)));
sink.writeln(&format!(
"Declared tag: {}",
paint(&args.tag, tag_color(&args.tag), sink.use_color)
))?;
Ok(())
}
@@ -1577,7 +1595,7 @@ pub fn cmd_tag_add(args: &TagAddArgs, start: &Path) -> Result<()> {
/// The no-op compares the rendered file rather than the annotation, which is what `apply`
/// does for a ticket: the file is the thing that would be written, so it is the thing worth
/// asking whether the write would change.
pub fn cmd_tag_set(args: &TagSetArgs, start: &Path) -> Result<()> {
pub fn cmd_tag_set(args: &TagSetArgs, start: &Path, sink: &mut Sink) -> Result<()> {
let worklane_dir = find_worklane_dir(start)?;
let mut index = TagIndex::load(&worklane_dir)?;
@@ -1606,7 +1624,7 @@ pub fn cmd_tag_set(args: &TagSetArgs, start: &Path) -> Result<()> {
)?;
}
report_in(&changed, &args.tag, tag_color(&args.tag), "Updated");
report_in(sink, &changed, &args.tag, tag_color(&args.tag), "Updated")?;
Ok(())
}
@@ -1649,7 +1667,7 @@ pub fn cmd_tag_set(args: &TagSetArgs, start: &Path) -> Result<()> {
/// the heading, so an insertion path here would be reachable only from a hand-edited file:
/// that is the opposite of the Relations case, where `add` writes nothing and the insertion
/// is the only path there is.
pub fn cmd_campaign_set(args: &CampaignSetArgs, start: &Path) -> Result<()> {
pub fn cmd_campaign_set(args: &CampaignSetArgs, start: &Path, sink: &mut Sink) -> Result<()> {
let worklane_dir = find_worklane_dir(start)?;
let campaign = resolve_campaign(&args.campaign, &worklane_dir)?;
let title = campaign.title.clone();
@@ -1693,14 +1711,14 @@ pub fn cmd_campaign_set(args: &CampaignSetArgs, start: &Path) -> Result<()> {
}
if changed.is_empty() {
report(&[], &title, "Updated");
report(sink, &[], &title, "Updated")?;
return Ok(());
}
let renamed = changed.contains(&"title").then_some(()).and(args.title.as_ref());
save_campaign(&worklane_dir, &campaign.uuid, &title, renamed, &content)?;
report(&changed, args.title.as_ref().unwrap_or(&title), "Updated");
report(sink, &changed, args.title.as_ref().unwrap_or(&title), "Updated")?;
Ok(())
}
@@ -1717,7 +1735,7 @@ pub fn cmd_campaign_set(args: &CampaignSetArgs, start: &Path) -> Result<()> {
///
/// One section, so there is no loop and no list to report: what changed is the description
/// or the call failed.
pub fn cmd_campaign_append(args: &CampaignAppendArgs, start: &Path) -> Result<()> {
pub fn cmd_campaign_append(args: &CampaignAppendArgs, start: &Path, sink: &mut Sink) -> Result<()> {
let worklane_dir = find_worklane_dir(start)?;
let campaign = resolve_campaign(&args.campaign, &worklane_dir)?;
@@ -1726,7 +1744,7 @@ pub fn cmd_campaign_append(args: &CampaignAppendArgs, start: &Path) -> Result<()
save_campaign(&worklane_dir, &campaign.uuid, &campaign.title, None, &content)?;
report(&[DESCRIPTION.label], &campaign.title, "Appended to");
report(sink, &[DESCRIPTION.label], &campaign.title, "Appended to")?;
Ok(())
}
@@ -1735,28 +1753,35 @@ pub fn cmd_campaign_append(args: &CampaignAppendArgs, start: &Path) -> Result<()
/// Every status is shown, done included, unlike `ls`, which leaves done out of its
/// listing. A campaign's whole point is what is finished against what is left, so
/// hiding the finished half would hide the answer.
pub fn cmd_campaign_show(search: &str, worklane_dir: &Path) -> Result<()> {
pub fn cmd_campaign_show(search: &str, worklane_dir: &Path, sink: &mut Sink) -> Result<()> {
let colored = sink.use_color;
let campaign = resolve_campaign(search, worklane_dir)?;
println!("{}", color_text(&campaign.title, Color::Green));
println!("{}", "─".repeat(campaign.title.chars().count()));
sink.writeln(&paint(&campaign.title, Color::Green, colored))?;
sink.writeln(&"─".repeat(campaign.title.chars().count()))?;
// No relations and no campaign of its own: a campaign is not a ticket, and neither
// belongs to one.
println!("\n{}", content_trim_colored(&campaign.content, &Resolved::default()));
sink.writeln(&format!(
"\n{}",
content_trim(&campaign.content, colored, &Resolved::default())
))?;
let grouped = members(worklane_dir, &campaign.uuid)?;
let standing = Standing::of(&grouped);
println!("{}", color_text("Members", Color::Orange));
println!("{}", "─".repeat("Members".chars().count()));
println!("\n{}", standing.label());
sink.writeln(&paint("Members", Color::Orange, colored))?;
sink.writeln(&"─".repeat("Members".chars().count()))?;
sink.writeln(&format!("\n{}", standing.label()))?;
for (status, items) in &grouped {
if items.is_empty() {
continue;
}
println!("\n{}", color_text(&format!("[{}]", status.to_uppercase()), Color::Orange));
display_ticket_items(items);
sink.writeln(&format!(
"\n{}",
paint(&format!("[{}]", status.to_uppercase()), Color::Orange, colored)
))?;
display_ticket_items(sink, items)?;
}
Ok(())
@@ -1776,6 +1801,7 @@ pub fn cmd_assign(
actor: &Option<String>,
actor_from_git: bool,
start: &Path,
sink: &mut Sink,
) -> Result<()> {
let worklane_dir = find_worklane_dir(start)?;
let campaign = resolve_campaign(campaign_search, &worklane_dir)?;
@@ -1786,11 +1812,11 @@ pub fn cmd_assign(
set_or_insert_metadata_field(&original, CAMPAIGN_FIELD, &campaign.uuid, TICKET, &title)?;
if content == original {
println!(
sink.writeln(&format!(
"Ticket '{}' is already in campaign '{}'",
color_text(&title, Color::Green),
paint(&title, Color::Green, sink.use_color),
campaign.title,
);
))?;
return Ok(());
}
@@ -1817,11 +1843,11 @@ pub fn cmd_assign(
"",
)?;
println!(
sink.writeln(&format!(
"Assigned '{}' to campaign '{}'",
color_text(&title, Color::Green),
paint(&title, Color::Green, sink.use_color),
campaign.title,
);
))?;
Ok(())
}
@@ -1832,7 +1858,7 @@ pub fn cmd_assign(
/// reason: the opencode wrapper throws on the exit code and keeps stderr, so a list
/// printed to stdout would be discarded and an agent would learn nothing. Prompting
/// regardless would leave it blocked on a stdin that never closes.
fn ask_which_criterion(criteria: &[Criterion], title: &str) -> Result<usize> {
fn ask_which_criterion(sink: &mut Sink, criteria: &[Criterion], title: &str) -> Result<usize> {
let listing = criteria_list(criteria);
if !std::io::stdin().is_terminal() {
@@ -1843,11 +1869,14 @@ fn ask_which_criterion(criteria: &[Criterion], title: &str) -> Result<usize> {
));
}
println!("Acceptance criteria of '{}':", color_text(title, Color::Green));
println!("{}", listing);
sink.writeln(&format!(
"Acceptance criteria of '{}':",
paint(title, Color::Green, sink.use_color)
))?;
sink.writeln(&listing)?;
// Either form, since find_criteria takes both.
print!("Number or text: ");
std::io::stdout().flush()?;
sink.write("Number or text: ")?;
sink.flush()?;
let mut answer = String::new();
std::io::stdin().lock().read_line(&mut answer)?;
@@ -1933,7 +1962,7 @@ fn resolve_criteria(criteria: &[Criterion], terms: &[String], title: &str) -> Re
Ok(chosen)
}
pub fn cmd_check(args: &CheckArgs, checked: bool, start: &Path) -> Result<()> {
pub fn cmd_check(args: &CheckArgs, checked: bool, start: &Path, sink: &mut Sink) -> Result<()> {
let worklane_dir = find_worklane_dir(start)?;
let (status, title, content) = resolve_ticket(&args.ticket, &worklane_dir)?;
@@ -1943,7 +1972,7 @@ pub fn cmd_check(args: &CheckArgs, checked: bool, start: &Path) -> Result<()> {
}
let chosen = match args.criteria.as_slice() {
[] => vec![ask_which_criterion(&criteria, &title)?],
[] => vec![ask_which_criterion(sink, &criteria, &title)?],
terms => resolve_criteria(&criteria, terms, &title)?,
};
@@ -1975,7 +2004,12 @@ pub fn cmd_check(args: &CheckArgs, checked: bool, start: &Path) -> Result<()> {
past.to_string()
};
println!("{} {}: {}", state, offset + 1, color_text(&criterion.text, Color::Green));
sink.writeln(&format!(
"{} {}: {}",
state,
offset + 1,
paint(&criterion.text, Color::Green, sink.use_color)
))?;
}
Ok(())
@@ -1990,7 +2024,12 @@ pub fn cmd_check(args: &CheckArgs, checked: bool, start: &Path) -> Result<()> {
/// With no name, every shipped document is installed. Narrowing to one is the
/// exception rather than the rule, so that a document added in a later version reaches
/// anyone who already knows the command.
pub fn cmd_install_skill(skill: Option<&str>, force: bool, print: bool) -> Result<()> {
pub fn cmd_install_skill(
skill: Option<&str>,
force: bool,
print: bool,
sink: &mut Sink,
) -> Result<()> {
if print {
// Printing every document would run them together into something that is not
// any of them, and the point of `--print` is to diff one against its copy.
@@ -2000,7 +2039,7 @@ pub fn cmd_install_skill(skill: Option<&str>, force: bool, print: bool) -> Resul
install::skill_names()
)
})?;
print!("{}", install::skill_named(name)?.content);
sink.write(install::skill_named(name)?.content)?;
return Ok(());
}
@@ -2010,14 +2049,14 @@ pub fn cmd_install_skill(skill: Option<&str>, force: bool, print: bool) -> Resul
};
let root = install::skills_root()?;
let written = install_each(&chosen, &root, force, |asset| {
let written = install_each(sink, &chosen, &root, force, |asset| {
format!("worklane install-skill {} --print", asset.name)
})?;
// Once, and only when something arrived: repeating it per document would make the
// instruction look like part of each outcome rather than the one thing to do next.
if written {
println!("Claude Code and opencode pick it up on their next session");
sink.writeln("Claude Code and opencode pick it up on their next session")?;
}
Ok(())
@@ -2033,6 +2072,7 @@ pub fn cmd_install_skill(skill: Option<&str>, force: bool, print: bool) -> Resul
/// each command has its own thing to say about what picks the asset up, and neither
/// should say it once per asset.
fn install_each(
sink: &mut Sink,
chosen: &[&install::Asset],
root: &Path,
force: bool,
@@ -2043,15 +2083,26 @@ fn install_each(
for asset in chosen {
match asset.install(root, force)? {
install::Outcome::Written(path) => {
println!("Installed the {} {} to: {}", asset.name, asset.what, path.display());
sink.writeln(&format!(
"Installed the {} {} to: {}",
asset.name,
asset.what,
path.display()
))?;
written = true;
}
install::Outcome::Unchanged(path) => {
println!("Already up to date: {}", path.display());
sink.writeln(&format!("Already up to date: {}", path.display()))?;
}
install::Outcome::Refused(path) => {
println!("Differs from the version in this binary: {}", path.display());
println!("Compare with `{}`, or overwrite with --force", compare(asset));
sink.writeln(&format!(
"Differs from the version in this binary: {}",
path.display()
))?;
sink.writeln(&format!(
"Compare with `{}`, or overwrite with --force",
compare(asset)
))?;
}
}
}
@@ -2064,29 +2115,136 @@ fn install_each(
/// No name argument, where `install-skill` has an optional one: there is a single tool
/// file, so a name could only be right or wrong, and `--print` needs no help deciding
/// what to print.
pub fn cmd_install_tool(force: bool, print: bool) -> Result<()> {
pub fn cmd_install_tool(force: bool, print: bool, sink: &mut Sink) -> Result<()> {
if print {
print!("{}", install::TOOL.content);
sink.write(install::TOOL.content)?;
return Ok(());
}
let chosen: Vec<&install::Asset> = install::TOOLS.iter().collect();
let root = install::tools_root()?;
let written =
install_each(&chosen, &root, force, |_| "worklane install-tool --print".to_string())?;
let written = install_each(sink, &chosen, &root, force, |_| {
"worklane install-tool --print".to_string()
})?;
// Not "on its next session", which is what the skills say: opencode reads its config
// once at startup and does not reload it, so a running one keeps the tools it began
// with. The second line is there because the file is executable and looks like it
// needs a toolchain: it does not, it runs inside opencode.
if written {
println!(
"opencode loads it in every project. Restart it: the config is read at startup and never reloaded"
);
println!(
"Nothing else to install. It runs in opencode's own runtime, so neither Bun nor @opencode-ai/plugin is needed on this machine"
);
sink.writeln(
"opencode loads it in every project. Restart it: the config is read at startup and never reloaded",
)?;
sink.writeln(
"Nothing else to install. It runs in opencode's own runtime, so neither Bun nor @opencode-ai/plugin is needed on this machine",
)?;
}
Ok(())
}
#[cfg(test)]
mod sink_tests {
use super::*;
use crate::util::Sink;
use std::fs;
/// A throwaway board, so a test can point a handler at a sink without touching the
/// real one. Cleaned up at the end; a leftover here is an aborted test, not a
/// fixture the suite has to keep alive.
fn temp_worklane() -> std::path::PathBuf {
let dir = std::env::temp_dir().join(format!("wl-sink-{}", uuid::Uuid::new_v4()));
fs::create_dir_all(&dir).unwrap();
for status in ["backlog", "committed", "reviewing", "done", "discarded"] {
fs::create_dir_all(dir.join(status)).unwrap();
}
fs::create_dir_all(dir.join("campaigns")).unwrap();
fs::write(dir.join("tags.md"), crate::tag::TagIndex::default().render()).unwrap();
dir
}
fn ticket(dir: &Path, status: &str, uuid: &str) {
fs::write(
dir.join(status).join(format!("{}_ticket.md", uuid)),
format!(
"# {u} title\n\
\n\
## Description\n\
body\n\
\n\
## Metadata\n\
\n\
- **ID**: {u}\n\
- **Priority**: 3\n\
- **Tags**: _None_\n\
- **Owner**: alice\n\
- **Created At**: 2026-08-21 02:10:17\n\
- **Status**: {status}\n",
u = uuid,
status = status,
),
)
.unwrap();
}
/// A handler writes through the sink it is handed, and a caller can read the bytes
/// back without a terminal or a real stdout.
#[test]
fn handler_writes_to_a_buffer() {
let dir = temp_worklane();
ticket(&dir, "backlog", "abc1234-def5678");
let args = LsArgs {
status: None,
priority: None,
tag: None,
campaign: None,
ids: false,
};
let mut buf = Vec::new();
{
let mut sink = Sink::buffer(&mut buf);
cmd_ls(&args, &dir, &mut sink).unwrap();
}
let out = String::from_utf8(buf).unwrap();
// The short id, not swallowed by a terminal, and no colour escapes without a
// colour sink.
assert!(out.contains("abc1234"), "ticket id missing from:\n{out}");
assert!(!out.contains('\u{1b}'), "unexpected colour in:\n{out}");
fs::remove_dir_all(&dir).ok();
}
/// The same handler behind a coloured sink paints the id red, so the colour decision
/// is the sink's and not the process's.
#[test]
fn handler_colours_when_the_sink_says_so() {
let dir = temp_worklane();
ticket(&dir, "backlog", "abc1234-def5678");
let args = LsArgs {
status: None,
priority: None,
tag: None,
campaign: None,
ids: false,
};
let mut buf = Vec::new();
{
let mut sink = Sink::new(Box::new(&mut buf), true);
// The sink is the source of the colour decision: the same word it wraps
// here is what the handler paints through `paint(.., sink.use_color)`.
assert!(sink.color("abc1234", Color::Red).contains('\u{1b}'));
cmd_ls(&args, &dir, &mut sink).unwrap();
}
let out = String::from_utf8(buf).unwrap();
assert!(out.contains("abc1234"), "ticket id missing from:\n{out}");
assert!(out.contains('\u{1b}'), "expected colour in:\n{out}");
fs::remove_dir_all(&dir).ok();
}
}
+52 -26
View File
@@ -8,6 +8,11 @@ mod completions;
mod handlers;
mod history;
mod install;
/// The command prompt reads `split_line` and `unclosed`; `cursor_arg` and `at_new_arg` are
/// what completing an argument needs and nothing reads them yet, so the allow stays until
/// 00a14e7 and 952a9f8 land. The tests are what drive them in the meantime.
#[cfg_attr(not(test), allow(dead_code))]
mod split;
mod tag;
mod tui;
mod util;
@@ -42,45 +47,47 @@ fn main() -> Result<()> {
let start = std::env::current_dir()?;
match cli.command {
let mut sink = Sink::std();
let result = match cli.command {
// No subcommand opens the board, the way a bare `frig` does, and with no path
// it opens the board above the working directory.
None => run_tui(&[], &start),
Some(Command::Tui { paths }) => run_tui(&paths, &start),
Some(Command::Init) => cmd_init(&start),
Some(Command::Add(args)) => cmd_add(&args, &start),
Some(Command::Init) => cmd_init(&start, &mut sink),
Some(Command::Add(args)) => cmd_add(&args, &start, &mut sink),
Some(Command::Ls(args)) => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_ls(&args, &worklane_dir)
cmd_ls(&args, &worklane_dir, &mut sink)
}
Some(Command::Show { id }) => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_show(&id, &worklane_dir)
cmd_show(&id, &worklane_dir, &mut sink)
}
Some(Command::Mv(args)) => cmd_mv(&args, &start),
Some(Command::Set(args)) => cmd_set(&args, &start),
Some(Command::Append(args)) => cmd_append(&args, &start),
Some(Command::Relate(args)) => cmd_relate(&args, &start),
Some(Command::Chown(args)) => cmd_chown(&args, &start),
Some(Command::Check(args)) => cmd_check(&args, true, &start),
Some(Command::Uncheck(args)) => cmd_check(&args, false, &start),
Some(Command::Mv(args)) => cmd_mv(&args, &start, &mut sink),
Some(Command::Set(args)) => cmd_set(&args, &start, &mut sink),
Some(Command::Append(args)) => cmd_append(&args, &start, &mut sink),
Some(Command::Relate(args)) => cmd_relate(&args, &start, &mut sink),
Some(Command::Chown(args)) => cmd_chown(&args, &start, &mut sink),
Some(Command::Check(args)) => cmd_check(&args, true, &start, &mut sink),
Some(Command::Uncheck(args)) => cmd_check(&args, false, &start, &mut sink),
Some(Command::Comment {
ticket,
body,
actor,
actor_from_git,
}) => cmd_comment(&ticket, &body, &actor, actor_from_git, &start),
}) => cmd_comment(&ticket, &body, &actor, actor_from_git, &start, &mut sink),
Some(Command::Campaign { command }) => match command {
CampaignCommand::Add(args) => cmd_campaign_add(&args, &start),
CampaignCommand::Add(args) => cmd_campaign_add(&args, &start, &mut sink),
CampaignCommand::Ls { ids } => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_campaign_ls(&worklane_dir, ids)
cmd_campaign_ls(&worklane_dir, ids, &mut sink)
}
CampaignCommand::Set(args) => cmd_campaign_set(&args, &start),
CampaignCommand::Append(args) => cmd_campaign_append(&args, &start),
CampaignCommand::Set(args) => cmd_campaign_set(&args, &start, &mut sink),
CampaignCommand::Append(args) => cmd_campaign_append(&args, &start, &mut sink),
CampaignCommand::Show { campaign } => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_campaign_show(&campaign, &worklane_dir)
cmd_campaign_show(&campaign, &worklane_dir, &mut sink)
}
},
Some(Command::Assign {
@@ -88,32 +95,37 @@ fn main() -> Result<()> {
ticket,
actor,
actor_from_git,
}) => cmd_assign(&campaign, &ticket, &actor, actor_from_git, &start),
}) => cmd_assign(&campaign, &ticket, &actor, actor_from_git, &start, &mut sink),
// The bare form and `ls` are one arm: `worklane tags` was the listing before the
// group existed and the fish completion still calls it that way, so the two
// spellings cannot be allowed to drift into two behaviours.
Some(Command::Tags { command }) => match command {
None | Some(TagCommand::Ls) => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_tags(&worklane_dir)
cmd_tags(&worklane_dir, &mut sink)
}
Some(TagCommand::Add(args)) => cmd_tag_add(&args, &start),
Some(TagCommand::Set(args)) => cmd_tag_set(&args, &start),
Some(TagCommand::Add(args)) => cmd_tag_add(&args, &start, &mut sink),
Some(TagCommand::Set(args)) => cmd_tag_set(&args, &start, &mut sink),
},
// No board either, for the reason `install-skill` has none: a completion script
// is generated from the clap definition and is the same wherever it is run.
Some(Command::Completions { shell }) => {
completions::generate(shell, &mut std::io::stdout()).map_err(Into::into)
completions::generate(shell, sink.as_write()).map_err(Into::into)
}
// No board is looked for: the point of the skill is to teach an agent worklane
// before there is a `.worklane` anywhere.
Some(Command::InstallSkill { skill, force, print }) => {
cmd_install_skill(skill.as_deref(), force, print)
cmd_install_skill(skill.as_deref(), force, print, &mut sink)
}
// No board either, and one agent rather than both: opencode loads the tool file,
// Claude Code has no path for one.
Some(Command::InstallTool { force, print }) => cmd_install_tool(force, print),
}
Some(Command::InstallTool { force, print }) => cmd_install_tool(force, print, &mut sink),
};
// The board (and every handler) own their own writing, so flush what the last one
// handed the sink before returning; an error path printed nothing to flush.
sink.flush()?;
result
}
// ---------------------------------------------------------------------- tui --
@@ -208,6 +220,14 @@ fn run_tui(paths: &[std::path::PathBuf], start: &std::path::Path) -> Result<()>
continue;
}
// And the command prompt, third, on the same contract: while a command is being
// typed `q` is a letter, `d` leaves the columns alone and `tab` stays out of the
// project tabs. No screen, because nothing it does measures the board yet. The
// rule is `Board::prompt_key`, where a test can reach it.
if board.prompt_key(key) {
continue;
}
match key.code {
// One arm, because the two keys mean one thing: close what is open, and
// quit when there is nothing left to close. Two arms carrying one rule
@@ -251,6 +271,12 @@ fn run_tui(paths: &[std::path::PathBuf], start: &std::path::Path) -> Result<()>
// at an open picker is taken by `picker_key` to open the picker's own
// query, so this arm is only ever the way in to the board's prompt.
KeyCode::Char('/') => board.open_search(),
// The way in to the command prompt, and the same single-shot arm `/` is:
// from the next keypress on, `prompt_key` above has the keyboard. A `:`
// typed into either open prompt is a character there and one pressed at an
// open picker is swallowed by it, so this arm is only ever the way in from
// the board itself. Free of every existing binding.
KeyCode::Char(':') => board.open_prompt(),
// `y` as in yank, for the readers this board is for, and the only letter
// left that a vim hand would reach for. The clipboard is handed in rather
// than reached for inside `Board`, so the suite can drive both answers.
+453
View File
@@ -0,0 +1,453 @@
//! Splitting a typed line into the arguments a parser wants.
//!
//! The prompt on the board takes one string and clap takes an argv, so something has to
//! turn `comment 1b78a24 the offset was never passed` into a verb, a ticket and one body
//! with spaces in it. Splitting on whitespace hands clap five arguments where `comment`
//! takes two, which is not a grammar error to report but a tokenising step nobody ran.
//!
//! The rules are the shell's, because that is what the prompt promises: a line is spelled
//! there exactly as it is spelled in the shell. Runs of whitespace separate arguments,
//! single and double quotes group one, a backslash escapes the next character except
//! inside single quotes where it is a backslash, and an explicitly empty `''` is an
//! argument that exists and is empty — which is what `--title ""` being a usage error
//! rather than a silent clear depends on. A leading hyphen is not special here: whether
//! `--foo` is a flag or the text of a criterion is clap's question, and the prose
//! arguments already accept one.
//!
//! Two things a shell's own splitter does not have to answer, and both are why this is
//! written rather than pulled in:
//!
//! - **A line being typed is half finished.** An unterminated quote is a state to report,
//! not an error to raise, because the prompt has to keep taking characters and refuse
//! only enter. See [`Unclosed`].
//! - **Completion needs to know where the cursor is.** Which argument it sits in, counting
//! from the verb, and whether nothing of that argument lies before it. Both fall out of
//! the scan for free and neither is reachable afterwards from the arguments alone.
//!
//! One pure function over the line and the cursor, and nothing here knows about `Board`.
/// What a line is still inside when it ends.
///
/// A half-typed line is not a line that failed: `comment 1b78a24 "the offset` is a
/// sentence somebody is in the middle of, and the arguments before the quote are already
/// right. So this is a state the caller reports, and the reason enter is refused while it
/// is anything but [`Unclosed::Closed`] — the arguments up to that point are still handed
/// back, because that is what a completion or a hint has to work from.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Unclosed {
/// Nothing. The arguments are whole and the line can go to a parser.
Closed,
/// A `'` with no `'` after it.
Single,
/// A `"` with no `"` after it.
Double,
/// A trailing `\`, which has nothing yet to escape.
///
/// Not a quote, and reported the same way for the same reason: the character it will
/// escape is the next one typed. It wins over an open quote, being the inner of the
/// two, and either answer refuses the line.
Escape,
}
/// Which quote the scan is inside.
///
/// Private, because what a caller needs is [`Unclosed`], which also carries the state no
/// quote can. Two public spellings of one fact is how they come to disagree.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Quote {
Single,
Double,
}
/// One scan of a line: its arguments, where the cursor sits among them, and what the line
/// is still inside.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Split {
/// The arguments, in order, with the quotes and escapes taken off. The binary's own
/// name is not among them: prepending it is the caller's, since only the caller knows
/// what it is calling.
pub args: Vec<String>,
/// Which argument the cursor is in, counting from the verb at 0. Equal to
/// `args.len()` when the cursor is past the last one, which is the index an argument
/// typed next would take.
pub cursor_arg: usize,
/// Whether nothing of `cursor_arg` lies before the cursor, because the line up to it
/// ends in a separator or has nothing in it at all. That is the difference between
/// completing an argument and starting one.
pub at_new_arg: bool,
/// What the line is still inside, and therefore whether it can be run at all.
pub unclosed: Unclosed,
}
/// Split `line` into arguments, reading the cursor at `cursor` as a byte offset into it.
///
/// Bytes because that is what the prompt's own cursor is: a `String` inserts and removes
/// at byte indices. A cursor past the end of the line reads as the end, and one inside a
/// multi-byte character reads as being after that character, so neither can panic and
/// neither needs the caller to have clamped it first.
pub fn split_line(line: &str, cursor: usize) -> Split {
let mut args: Vec<String> = Vec::new();
// `Some("")` is an argument that has been opened and is still empty, which is what
// tells `''` from nothing at all: a bare `take()` cannot make that distinction.
let mut arg: Option<String> = None;
let mut quote: Option<Quote> = None;
let mut escape = false;
// The cursor's answer, taken at the character it falls on and never revised.
let mut at: Option<(usize, bool)> = None;
for (offset, c) in line.char_indices() {
if at.is_none() && offset >= cursor {
at = Some((args.len(), arg.is_none()));
}
if escape {
arg.get_or_insert_default().push(c);
escape = false;
continue;
}
match (quote, c) {
// The shell's exception, and the reason a criterion reading `a\b` survives
// being typed as `'a\b'`: single quotes are literal, backslash included.
(Some(Quote::Single), '\\') => arg.get_or_insert_default().push(c),
(_, '\\') => escape = true,
(None, '\'') => {
quote = Some(Quote::Single);
arg.get_or_insert_default();
}
(None, '"') => {
quote = Some(Quote::Double);
arg.get_or_insert_default();
}
(Some(Quote::Single), '\'') | (Some(Quote::Double), '"') => quote = None,
// A run of separators closes the open argument once and then finds none.
(None, ws) if ws.is_whitespace() => {
if let Some(done) = arg.take() {
args.push(done);
}
}
_ => arg.get_or_insert_default().push(c),
}
}
// Before the last argument is pushed, so a cursor at the end of the line is still in
// the argument it is typing rather than one past it.
let (cursor_arg, at_new_arg) = at.unwrap_or((args.len(), arg.is_none()));
if let Some(last) = arg {
args.push(last);
}
Split {
args,
cursor_arg,
at_new_arg,
unclosed: match (escape, quote) {
(true, _) => Unclosed::Escape,
(false, Some(Quote::Single)) => Unclosed::Single,
(false, Some(Quote::Double)) => Unclosed::Double,
(false, None) => Unclosed::Closed,
},
}
}
#[cfg(test)]
mod tests {
use super::*;
/// One line and everything the scan is supposed to say about it.
///
/// The defaults are the empty line's own answers, so a row states the rule it is about
/// and stays quiet about the rest.
struct Case {
line: &'static str,
/// Where the cursor is, or the end of the line, which is where it sits while a
/// line is being typed. Only the cursor rows move it.
cursor: Option<usize>,
args: &'static [&'static str],
cursor_arg: usize,
at_new_arg: bool,
unclosed: Unclosed,
}
impl Default for Case {
fn default() -> Self {
Case {
line: "",
cursor: None,
args: &[],
cursor_arg: 0,
at_new_arg: true,
unclosed: Unclosed::Closed,
}
}
}
/// Every field of every row, each named in its own failure: a table that reports only
/// the first mismatch makes the next run tell a different story than this one.
fn check(cases: &[Case]) {
for case in cases {
let cursor = case.cursor.unwrap_or(case.line.len());
let split = split_line(case.line, cursor);
let args: Vec<&str> = split.args.iter().map(String::as_str).collect();
let at = format!("{:?} with the cursor at {cursor}", case.line);
assert_eq!(args, case.args, "arguments of {at}");
assert_eq!(split.cursor_arg, case.cursor_arg, "cursor argument of {at}");
assert_eq!(split.at_new_arg, case.at_new_arg, "new argument of {at}");
assert_eq!(split.unclosed, case.unclosed, "unclosed state of {at}");
}
}
#[test]
fn a_line_splits_into_arguments_the_way_a_shell_splits_one() {
check(&[
// Nothing typed yet, which is the state the prompt opens in.
Case::default(),
Case {
line: "tags",
args: &["tags"],
at_new_arg: false,
..Case::default()
},
Case {
line: "mv 1b78a24 --status committed",
args: &["mv", "1b78a24", "--status", "committed"],
cursor_arg: 3,
at_new_arg: false,
..Case::default()
},
// Runs of separators collapse, at either end and in the middle, and a tab is
// one of them.
Case {
line: " mv 1b78a24 ",
args: &["mv", "1b78a24"],
cursor_arg: 2,
..Case::default()
},
Case {
line: "mv\t1b78a24",
args: &["mv", "1b78a24"],
cursor_arg: 1,
at_new_arg: false,
..Case::default()
},
// What the ticket for this was written about: one body, spaces and all.
Case {
line: "comment 1b78a24 \"the offset was never passed\"",
args: &["comment", "1b78a24", "the offset was never passed"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// Single quotes group the same, and a run of spaces inside one is not a
// separator to collapse.
Case {
line: "comment 1b78a24 'two spaces'",
args: &["comment", "1b78a24", "two spaces"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// A quote in the middle of an argument groups part of it, which is how a
// `--flag=value` carrying a space is typed.
Case {
line: "set 1b78a24 --title=\"a b\"",
args: &["set", "1b78a24", "--title=a b"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// A backslash escapes the next character: a separator, a quote, itself.
Case {
line: "comment 1b78a24 a\\ b",
args: &["comment", "1b78a24", "a b"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
Case {
line: "comment 1b78a24 \"she said \\\"no\\\"\"",
args: &["comment", "1b78a24", "she said \"no\""],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
Case {
line: "comment 1b78a24 a\\\\b",
args: &["comment", "1b78a24", "a\\b"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// Except inside single quotes, where it is a character like any other.
Case {
line: "comment 1b78a24 'a\\b'",
args: &["comment", "1b78a24", "a\\b"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// A leading hyphen is clap's business, not the splitter's.
Case {
line: "add --title --print is supported",
args: &["add", "--title", "--print", "is", "supported"],
cursor_arg: 4,
at_new_arg: false,
..Case::default()
},
// An empty quoted value is an argument that exists and is empty. Losing it
// here would turn a usage error into a silent clear.
Case {
line: "set 1b78a24 --title \"\"",
args: &["set", "1b78a24", "--title", ""],
cursor_arg: 3,
at_new_arg: false,
..Case::default()
},
Case {
line: "''",
args: &[""],
at_new_arg: false,
..Case::default()
},
]);
}
#[test]
fn a_half_typed_line_says_what_it_is_still_inside_and_hands_back_the_rest() {
check(&[
// The arguments before the open quote are already right, and the open one is
// as far as it has been typed.
Case {
line: "comment 1b78a24 \"the offset",
args: &["comment", "1b78a24", "the offset"],
cursor_arg: 2,
at_new_arg: false,
unclosed: Unclosed::Double,
..Case::default()
},
Case {
line: "comment 1b78a24 'the offset",
args: &["comment", "1b78a24", "the offset"],
cursor_arg: 2,
at_new_arg: false,
unclosed: Unclosed::Single,
..Case::default()
},
// A quote just opened is an argument that exists and is empty, the same shape
// a closed `''` leaves.
Case {
line: "comment 1b78a24 \"",
args: &["comment", "1b78a24", ""],
cursor_arg: 2,
at_new_arg: false,
unclosed: Unclosed::Double,
..Case::default()
},
// A trailing backslash has nothing yet to escape. It opened no argument, so
// the cursor is starting one.
Case {
line: "mv 1b78a24 \\",
args: &["mv", "1b78a24"],
cursor_arg: 2,
unclosed: Unclosed::Escape,
..Case::default()
},
// Inside a quote the escape is the inner of the two, and it is what the line
// is waiting on.
Case {
line: "comment 1b78a24 \"a\\",
args: &["comment", "1b78a24", "a"],
cursor_arg: 2,
at_new_arg: false,
unclosed: Unclosed::Escape,
..Case::default()
},
// A closed quote reopened is open again: the state is where the scan ended,
// not how many quotes were typed.
Case {
line: "comment 1b78a24 'a' 'b",
args: &["comment", "1b78a24", "a", "b"],
cursor_arg: 3,
at_new_arg: false,
unclosed: Unclosed::Single,
..Case::default()
},
]);
}
#[test]
fn the_split_says_which_argument_the_cursor_is_in_and_whether_it_begins_one() {
check(&[
// The line is split whole whatever the cursor is doing: only the two cursor
// answers move.
Case {
line: "mv 1b78a24",
cursor: Some(0),
args: &["mv", "1b78a24"],
..Case::default()
},
Case {
line: "mv 1b78a24",
cursor: Some(1),
args: &["mv", "1b78a24"],
at_new_arg: false,
..Case::default()
},
// At the end of the verb, still in the verb: the cursor is completing it.
Case {
line: "mv 1b78a24",
cursor: Some(2),
args: &["mv", "1b78a24"],
at_new_arg: false,
..Case::default()
},
// Past the separator, so the argument at 1 has nothing before the cursor even
// though the line goes on to hold one.
Case {
line: "mv 1b78a24",
cursor: Some(3),
args: &["mv", "1b78a24"],
cursor_arg: 1,
..Case::default()
},
// A cursor past the end of the line reads as the end of it.
Case {
line: "mv",
cursor: Some(99),
args: &["mv"],
at_new_arg: false,
..Case::default()
},
// Inside a quoted argument the cursor is in that argument, not in a fourth
// one the quotes might look like they opened.
Case {
line: "comment 1b78a24 \"the offset\"",
cursor: Some(20),
args: &["comment", "1b78a24", "the offset"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// Byte offsets, so a multi-byte character before the cursor counts for its
// width and not for one: 8 is where `é` starts and 9 is inside it.
Case {
line: "comment é",
cursor: Some(8),
args: &["comment", "é"],
cursor_arg: 1,
..Case::default()
},
// A cursor inside a character reads as being after it, which is the answer
// that cannot claim an argument has not started when it has.
Case {
line: "comment é",
cursor: Some(9),
args: &["comment", "é"],
cursor_arg: 1,
at_new_arg: false,
..Case::default()
},
]);
}
}
+822 -1
View File
@@ -23,7 +23,9 @@ use ratatui::text::{Line, Span, Text};
use ratatui::widgets::{Block, Borders, Clear, Paragraph, Tabs, Wrap};
use crate::campaign::{CAMPAIGNS_DIR, CampaignIndex, Standing};
use crate::command::Cli;
use crate::history::{HistoryPart, history_parts, history_root, read_history};
use crate::split::{Unclosed, split_line};
use crate::tag::{NO_ANNOTATION, TAGS_FILE, TagIndex};
use crate::util::*;
@@ -696,6 +698,177 @@ pub struct Search {
pub missed: bool,
}
/// The open command prompt: the line, where the cursor is in it, and what the last enter
/// had to say about it.
///
/// One field on `Board` rather than a buffer beside a bool, for the reason [`Search`] is
/// one: "the prompt is open" and "what is in it" cannot disagree, and closing it leaves
/// nothing to reset.
///
/// The cursor is a byte offset into `line`, which is what `String` inserts and removes at
/// and what [`crate::split::split_line`] reads. Every key that moves it moves it by whole
/// characters, so it is never inside one.
#[derive(Debug, Default)]
pub struct Prompt {
pub line: String,
pub cursor: usize,
/// What the last enter could not do, cleared by the next edit of the line. The message
/// is about the line that was refused, so it goes the moment the line changes; moving
/// the cursor leaves it up, since the line it is about has not changed. `Search::missed`
/// is the same rule with nothing to say but "no match".
pub refused: Option<String>,
}
impl Prompt {
/// Every key that only edits the line or moves the cursor, which is all of them but
/// `esc` and `enter`: those two are the mode's rather than the line's, and they are
/// answered by [`Board::prompt_key`] before it gets here.
///
/// Left, right, home, end, backspace and `ctrl-w` behave as they do in a shell. There
/// is no `tab`: suggesting the selected ticket is 00a14e7, and until then it is a key
/// that must not reach the project tabs. Every other control combination lands on the
/// last arm and does nothing, which is what stops `ctrl-d` reaching the action bound
/// to `d`.
fn key(&mut self, key: KeyEvent, control: bool) {
match key.code {
KeyCode::Left if !control => self.cursor = self.left_of(),
KeyCode::Right if !control => self.cursor = self.right_of(),
KeyCode::Home if !control => self.cursor = 0,
KeyCode::End if !control => self.cursor = self.line.len(),
// The three that change the line, so the message about what it used to say goes
// with it. Movement above deliberately does not clear it.
KeyCode::Backspace if !control => self.cut(self.left_of()),
KeyCode::Char('w') if control => self.cut(self.word_start()),
KeyCode::Char(typed) if !control => {
self.line.insert(self.cursor, typed);
self.cursor += typed.len_utf8();
self.refused = None;
}
_ => {}
}
}
/// The offset one character to the left of the cursor, or the cursor itself at the
/// start of the line. By characters, so a cursor never lands inside one.
fn left_of(&self) -> usize {
match self.line[..self.cursor].chars().next_back() {
Some(c) => self.cursor - c.len_utf8(),
None => self.cursor,
}
}
/// The same one character to the right, or the cursor itself at the end.
fn right_of(&self) -> usize {
match self.line[self.cursor..].chars().next() {
Some(c) => self.cursor + c.len_utf8(),
None => self.cursor,
}
}
/// Where the word before the cursor starts, which is what `ctrl-w` takes off: the
/// separators immediately behind the cursor, and then the run of everything that is
/// not one behind those.
///
/// The separators first, so `ctrl-w` at the end of `mv 1b78a24 ` takes the id rather
/// than the space alone, which is what a shell does with it.
fn word_start(&self) -> usize {
let back = |at: usize| {
self.line[..at]
.chars()
.next_back()
.map(|c| (at - c.len_utf8(), c))
};
let mut at = self.cursor;
while let Some((before, c)) = back(at) {
if !c.is_whitespace() {
break;
}
at = before;
}
while let Some((before, c)) = back(at) {
if c.is_whitespace() {
break;
}
at = before;
}
at
}
/// Take everything between `from` and the cursor off the line, and put the cursor
/// where it was taken from. Nothing to remove writes nothing.
fn cut(&mut self, from: usize) {
if from >= self.cursor {
return;
}
self.line.replace_range(from..self.cursor, "");
self.cursor = from;
self.refused = None;
}
}
/// What a line that ends half typed is waiting for, or nothing when it is whole.
///
/// The splitter reports the state rather than raising an error, and this is the sentence
/// the row carries for it. Said here rather than at the call site so the three states are
/// spelled in one place.
fn unclosed_message(unclosed: Unclosed) -> Option<&'static str> {
match unclosed {
Unclosed::Closed => None,
Unclosed::Single => Some("the line ends inside a ' quote"),
Unclosed::Double => Some("the line ends inside a \" quote"),
Unclosed::Escape => Some("the line ends on a backslash"),
}
}
/// What clap resolved the line to, as the words a reader typed: `mv`, or `campaign show`
/// for a command inside a group.
///
/// Off the matches rather than off a `match` on `Command`, which would be a second list of
/// every verb the CLI has — one that goes stale the day a command is added, and silently,
/// since a missing arm would only ever be seen by whoever typed that verb. `None` is the
/// bare form, which names no command at all.
fn command_name(matches: &clap::ArgMatches) -> Option<String> {
let (name, inner) = matches.subcommand()?;
Some(match command_name(inner) {
Some(rest) => format!("{name} {rest}"),
None => name.to_string(),
})
}
/// The one line the row carries for a line clap would not take.
///
/// Clap's own message, because the grammar is clap's: a complaint written here would
/// describe a rule this file does not own. What is dropped is the usage block and the
/// `--help` line after it, which are a paragraph — the synopsis is d7e493e's, and until
/// then the row says what is wrong rather than what would have been right.
///
/// `--help` is the exception. It parses as an error of the kind that means *print this*,
/// and what it would print is a page: caught here, or clap's help lands on the alternate
/// screen the way an unsunk `println!` would. `--version` goes through the ordinary path
/// because what it prints is one line by construction, which is exactly what fits.
fn refusal(err: &clap::Error) -> String {
if matches!(
err.kind(),
clap::error::ErrorKind::DisplayHelp
| clap::error::ErrorKind::DisplayHelpOnMissingArgumentOrSubcommand
) {
return "help is a page and this is a row: try it in a shell".to_string();
}
let rendered = err.render().to_string();
rendered
.lines()
.take_while(|line| !line.starts_with("Usage:"))
.map(str::trim)
.filter(|line| !line.is_empty())
.collect::<Vec<_>>()
.join(" ")
}
/// A line the footer carries in place of the key list until the next keypress.
///
/// The board otherwise says everything by drawing it, and a copy leaves nothing on the
@@ -1073,6 +1246,10 @@ pub struct Board {
pub offset: u16,
/// The search prompt while it is open. `None` is the board reading keys as actions.
pub search: Option<Search>,
/// The command prompt while it is open, on the same terms as `search`. Only one of the
/// two can be open at once: `:` is reachable from the action arms alone, and while
/// either prompt has the keyboard the other's key is a character in a line.
pub prompt: Option<Prompt>,
/// The campaign picker while it is open, on the same terms as `search`.
pub picker: Option<Picker>,
/// What the last action said, until the next keypress takes it away.
@@ -1109,6 +1286,7 @@ impl Board {
detail: None,
offset: 0,
search: None,
prompt: None,
picker: None,
notice: None,
visibility: Visibility::default(),
@@ -1920,6 +2098,113 @@ impl Board {
}
}
/// Open the command prompt on an empty line.
///
/// Empty rather than the last line kept, for the reason `open_search` opens empty: the
/// command that was typed has been dealt with, and reopening on it would make `:` and
/// enter repeat something nobody asked for. Recalling a line is `a9bd6f0`.
pub fn open_prompt(&mut self) {
self.prompt = Some(Prompt::default());
}
/// Feed a keypress to the open command prompt, and say whether it was taken.
///
/// The same contract as `search_key` and `picker_key`, and it runs beside them for the
/// same reason: the prompt owns the keyboard while it is open, so `q` typed into a
/// command has to be a letter, `d` must not rotate the columns and `tab` must not
/// change project. `ctrl-c` is the one key it declines, because a terminal application
/// always honours it and a prompt that ate it would leave no way off the board.
///
/// `esc` and `enter` are the mode's own two keys and are answered here; everything else
/// belongs to the line and goes to `Prompt::key`. That split is also what keeps the
/// borrow straight: closing the prompt takes the whole board, editing takes the prompt.
///
/// No screen: nothing here measures the board. The keypress that will is 53ffb94, which
/// redraws on what the command wrote.
pub fn prompt_key(&mut self, key: KeyEvent) -> bool {
if self.prompt.is_none() {
return false;
}
let control = key.modifiers.contains(KeyModifiers::CONTROL);
if control && key.code == KeyCode::Char('c') {
return false;
}
match key.code {
KeyCode::Esc if !control => self.prompt = None,
KeyCode::Enter if !control => self.submit(),
_ => {
if let Some(prompt) = &mut self.prompt {
prompt.key(key, control);
}
}
}
true
}
/// What enter does with the line: name the command it resolved to, or say why it did
/// not resolve to one.
///
/// The grammar is clap's, with nothing restated. The line is tokenised the way a shell
/// tokenises one, the binary's own name is put in front of the arguments, and the
/// result goes to the same `Cli` definition the shell reaches: a flag added to a
/// command is typeable here the day it is added, and no list of verbs lives on the
/// board to go stale.
///
/// A line that resolves closes the prompt and says what it resolved to, in the footer's
/// one channel for saying something in words. **It does not run it** — running is
/// 53ffb94 — so the notice says so rather than reading like a move that happened.
///
/// A line that does not resolve keeps the prompt open with the line and the cursor
/// exactly as they were, and puts the message on the row, so a typo is corrected in
/// place instead of retyped from `:`. That is `Search`'s hit-closes-miss-stays rule,
/// and the reason both are true of one field.
fn submit(&mut self) {
let Some(prompt) = &self.prompt else { return };
// Before clap sees anything, because a line ending inside a quote is not a line
// that failed to parse: it is one the reader has not finished typing, and handing
// its half-open argument to clap would report a grammar fault about a sentence
// nobody finished.
let split = split_line(&prompt.line, prompt.cursor);
if let Some(open) = unclosed_message(split.unclosed) {
self.refuse(open.to_string());
return;
}
// Enter on an empty line closes the prompt and leaves the board as it was, the way
// esc does. A line of nothing but separators is the same line: it names no command,
// and the bare form of the CLI opens a board, which is already on the screen.
if split.args.is_empty() {
self.prompt = None;
return;
}
let mut command = <Cli as clap::CommandFactory>::command().color(clap::ColorChoice::Never);
let argv = std::iter::once(command.get_name().to_string()).chain(split.args);
match command.try_get_matches_from_mut(argv) {
// No subcommand is the bare form, which opens a board: there is one on the
// screen, so there is nothing to name and nothing to do but close.
Ok(matches) => {
self.prompt = None;
if let Some(named) = command_name(&matches) {
self.notice = Some(Notice::done(format!("{named}: parsed, not run yet")));
}
}
Err(err) => self.refuse(refusal(&err)),
}
}
/// Keep the prompt open, with the line untouched, carrying what enter had to say.
fn refuse(&mut self, message: String) {
if let Some(prompt) = &mut self.prompt {
prompt.refused = Some(message);
}
}
/// The string the copy key puts on the clipboard: the selected card's short id.
///
/// A method here rather than a line inside the arm that copies, so what gets copied
@@ -3734,6 +4019,14 @@ fn key_hints(hints: &[(&str, &str)]) -> Vec<Span<'static>> {
}
fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
// The command prompt takes the whole row on the same terms as the search prompt below,
// and is asked first: an input cannot be covered, and it is the newest of the three
// things that can hold the row. Only one of the two prompts can be open at a time.
if let Some(prompt) = &board.prompt {
draw_prompt(frame, prompt, area);
return;
}
// The prompt takes the whole row while it is open. The footer is one line and
// already says what the state allows, and with every key going into the buffer the
// key list it replaces describes nothing that currently works.
@@ -3831,6 +4124,7 @@ fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
("←→↑↓", "select"),
("pgup/pgdn", "scroll"),
("/", "search"),
(":", "command"),
("y", "copy id"),
("↵/q", "close"),
]),
@@ -3840,13 +4134,19 @@ fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
("↵", height),
("pgup/pgdn", "scroll"),
("/", "search"),
(":", "command"),
]);
if let Some(copied) = copied {
hints.push(("y", copied));
}
}
(false, Focus::Cards) => {
hints.extend([("←→", "column"), ("↑↓", "card"), ("/", "search")]);
hints.extend([
("←→", "column"),
("↑↓", "card"),
("/", "search"),
(":", "command"),
]);
hints.extend_from_slice(filter);
hints.extend([("y", "copy id"), ("↵", "detail")]);
}
@@ -3907,6 +4207,85 @@ fn draw_search(frame: &mut Frame, search: &Search, area: Rect) {
frame.set_cursor_position((area.x + at, area.y));
}
/// What the row spends on the command prompt before the line starts: its own opening space
/// and the key that opened it, drawn where a search draws its `/`.
const PROMPT_OPENING: &str = " :";
/// The command prompt, in place of the key list, and the line windowed to what is left of
/// the row.
///
/// The keys are drawn the way `draw_search` draws its two, and their width is taken off the
/// row *before* the line is windowed, so they keep their place rather than being pushed off
/// the end by a long command. A message takes the row from them instead: the reader has
/// just been told something and that is the thing to read, while `esc` and `enter` still do
/// what they did. It is brightred beside the line it is about, the one thing on the row
/// that is neither a key nor what was typed, which is where `no match` sits.
///
/// `check` and not `run`: enter resolves the line and names it, and running it is 53ffb94.
/// A row naming a key by what it does not do yet is the fault 1b78a24 was, in the other
/// direction.
fn draw_prompt(frame: &mut Frame, prompt: &Prompt, area: Rect) {
let keys = key_hints(&[("↵", "check"), ("esc", "cancel")]);
let spent: usize = PROMPT_OPENING.chars().count()
+ KEY_GAP.chars().count()
+ keys
.iter()
.map(|span| span.content.chars().count())
.sum::<usize>();
// At least one cell, so a terminal too narrow for the keys still draws a cursor to type
// at rather than nothing at all.
let room = (area.width as usize).saturating_sub(spent).max(1);
let (visible, at) = prompt_window(&prompt.line, prompt.cursor, room);
let mut spans = vec![Span::raw(format!("{PROMPT_OPENING}{visible}"))];
match &prompt.refused {
Some(message) => spans.push(Span::styled(
format!("{KEY_GAP}{message}"),
Style::default().fg(Color::BrightRed.into()),
)),
None => {
spans.push(Span::raw(KEY_GAP));
spans.extend(keys);
}
}
frame.render_widget(Paragraph::new(Line::from(spans)), area);
// Held on the row, the way the search prompt holds its own: a line longer than the
// terminal leaves the cursor on the last cell rather than off the frame.
let column = (PROMPT_OPENING.chars().count() + at) as u16;
frame.set_cursor_position((area.x + column.min(area.width.saturating_sub(1)), area.y));
}
/// The part of `line` a field `room` cells wide shows with the cursor at `cursor`, and the
/// column the cursor lands on inside it.
///
/// The window is anchored on the cursor's right edge, so a line longer than the row scrolls
/// as it is typed instead of being cut off at the end of the field, and scrolls back as the
/// cursor moves left. What it costs is the text *after* the cursor on a long line, which is
/// off the window until the cursor reaches it. A window that kept both ends needs a scroll
/// offset held in state, and the draw is where the width is known and the state is not
/// writable, so that offset would have to be maintained by every key that moves the cursor
/// against a width the keypress cannot see.
///
/// Counted in characters, which is what the rest of this row is measured in. The cursor is
/// counted rather than sliced, so an offset that is somehow not on a character boundary
/// gives a window rather than a panic on the board.
fn prompt_window(line: &str, cursor: usize, room: usize) -> (String, usize) {
let before = line
.char_indices()
.take_while(|(offset, _)| *offset < cursor)
.count();
// One cell of the field is the cursor's own, so a line whose head fills the row keeps
// the cursor on it rather than one cell past its end.
let start = before.saturating_sub(room.saturating_sub(1));
let visible = line.chars().skip(start).take(room).collect();
(visible, before - start)
}
/// The picker's footer: its query while one is open, and the keys it answers to otherwise.
///
/// The same division `draw_search` makes, and the same reason for it: while every printable
@@ -6940,6 +7319,448 @@ approach";
);
}
// ------------------------------------------------------------ the command prompt --
/// A keypress with control held, which is how `ctrl-w` and `ctrl-c` arrive.
fn ctrl(c: char) -> KeyEvent {
KeyEvent::new(KeyCode::Char(c), KeyModifiers::CONTROL)
}
/// Type a whole line into an open command prompt, one key at a time, the way it arrives.
fn type_line(board: &mut Board, line: &str) {
for c in line.chars() {
assert!(board.prompt_key(letter(c)), "'{c}' was not taken");
}
}
fn prompt_line(board: &Board) -> Option<&str> {
board.prompt.as_ref().map(|prompt| prompt.line.as_str())
}
/// What the last enter had to say, or nothing.
fn refused(board: &Board) -> Option<&str> {
board
.prompt
.as_ref()
.and_then(|prompt| prompt.refused.as_deref())
}
/// Press enter on the open prompt, which is the whole of what this ticket does.
fn submit(board: &mut Board) {
assert!(board.prompt_key(typed(KeyCode::Enter)), "enter was not taken");
}
/// The prompt takes the row, names its own two keys, and the board is still behind it.
#[test]
fn the_command_prompt_replaces_the_footer_and_draws_the_line_and_its_cursor() {
let dir = searchable();
let mut board = one_board(&dir);
board.open_prompt();
let screen = render(&board, SCREEN.width, SCREEN.height);
let row = screen.last().expect("no rows rendered");
assert!(row.contains("↵ check"), "{row}");
assert!(row.contains("esc cancel"), "{row}");
assert!(!row.contains("quit"), "the key list survived the prompt:\n{row}");
assert!(
screen.join("\n").contains("Alpha first"),
"the board went away behind the prompt"
);
type_line(&mut board, "mv 1111111");
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(row.contains(" :mv 1111111"), "the line is not drawn: {row}");
let mut terminal = Terminal::new(TestBackend::new(SCREEN.width, SCREEN.height)).unwrap();
terminal.draw(|frame| draw(frame, &board)).unwrap();
let at = terminal.get_cursor_position().unwrap();
// The leading space, the `:`, and the ten characters typed.
assert_eq!(at.x, 12, "the cursor is not after the line");
assert_eq!(at.y, SCREEN.height - 1, "the cursor left the prompt row");
}
/// The line is edited where the cursor is, not at its end, which is the difference
/// between a command line and the search prompt's append-only query.
#[test]
fn the_line_is_edited_at_a_cursor_the_way_a_shell_edits_one() {
let dir = searchable();
let mut board = one_board(&dir);
board.open_prompt();
type_line(&mut board, "mv 1111111");
board.prompt_key(typed(KeyCode::Home));
type_line(&mut board, "x");
assert_eq!(prompt_line(&board), Some("xmv 1111111"), "home did not reach the front");
// Backspace takes the character before the cursor, not the last one on the line.
board.prompt_key(typed(KeyCode::Backspace));
assert_eq!(prompt_line(&board), Some("mv 1111111"));
board.prompt_key(typed(KeyCode::Right));
board.prompt_key(typed(KeyCode::Right));
type_line(&mut board, "!");
assert_eq!(prompt_line(&board), Some("mv! 1111111"));
board.prompt_key(typed(KeyCode::Left));
board.prompt_key(typed(KeyCode::Backspace));
assert_eq!(prompt_line(&board), Some("m! 1111111"));
// `ctrl-w` takes the word before the cursor, and the separators behind the cursor
// with it, so a second press takes the word before those rather than the space.
board.prompt_key(typed(KeyCode::End));
board.prompt_key(ctrl('w'));
assert_eq!(prompt_line(&board), Some("m! "));
board.prompt_key(ctrl('w'));
assert_eq!(prompt_line(&board), Some(""));
// Nothing to take is nothing done, at either end.
board.prompt_key(typed(KeyCode::Backspace));
board.prompt_key(ctrl('w'));
board.prompt_key(typed(KeyCode::Left));
assert_eq!(prompt_line(&board), Some(""));
// A cursor counted in bytes still moves by whole characters, so a backspace over a
// multi-byte one takes the character rather than splitting it.
type_line(&mut board, "comment é");
board.prompt_key(typed(KeyCode::Backspace));
assert_eq!(prompt_line(&board), Some("comment "));
}
/// The whole point of an input mode. Every one of these keys does something on the
/// board, and none of it may happen while a command is being typed.
#[test]
fn the_command_prompt_swallows_the_keys_that_are_bound_to_actions() {
let first = searchable();
let second = board_dir();
let mut board = boards(&[("alpha", &first), ("beta", &second)]);
let before = selected_title(&board);
board.open_prompt();
for key in [
letter('d'),
letter('q'),
letter('j'),
letter('h'),
typed(KeyCode::Up),
typed(KeyCode::Down),
typed(KeyCode::Left),
typed(KeyCode::Right),
typed(KeyCode::Tab),
typed(KeyCode::BackTab),
typed(KeyCode::PageDown),
] {
assert!(board.prompt_key(key), "{key:?} was not taken");
}
assert!(!board.should_quit, "typing 'q' quit the board");
assert_eq!(board.visibility, Visibility::Neither, "typing 'd' rotated the columns");
assert_eq!(selected_title(&board), before, "an arrow moved the selection");
assert_eq!(board.tab, 0, "tab changed project from under the prompt");
// The letters landed in the line; the keys that are not characters did not.
assert_eq!(prompt_line(&board), Some("dqjh"));
}
/// `ctrl-c` is the exception, since a terminal application always honours it. Every
/// other control combination is swallowed and does nothing but the one that is bound.
#[test]
fn the_command_prompt_declines_ctrl_c_and_eats_every_other_control_key() {
let dir = searchable();
let mut board = one_board(&dir);
board.open_prompt();
assert!(
!board.prompt_key(ctrl('c')),
"the prompt ate ctrl-c and left no way off the board"
);
assert!(board.prompt_key(ctrl('d')), "ctrl-d fell through to the 'd' arm");
assert_eq!(prompt_line(&board), Some(""), "a control key typed its letter");
}
/// Both ways of leaving with nothing done, and neither touches anything behind the row.
#[test]
fn esc_and_enter_on_an_empty_line_leave_the_board_as_it_was() {
let dir = searchable();
let mut board = one_board(&dir);
board.toggle_detail();
let before = selected_title(&board);
board.open_prompt();
type_line(&mut board, "mv 1111111");
assert!(board.prompt_key(typed(KeyCode::Esc)), "esc was not taken");
assert!(board.prompt.is_none(), "the prompt stayed open");
assert!(board.detail.is_some(), "esc reached the overlay arm");
assert!(!board.should_quit, "esc reached the quit arm");
assert_eq!(selected_title(&board), before, "the selection moved on a cancel");
assert!(board.notice.is_none(), "a cancel said something in the footer");
// And the next esc is the overlay's again.
assert!(!board.prompt_key(typed(KeyCode::Esc)));
board.open_prompt();
submit(&mut board);
assert!(board.prompt.is_none(), "enter on an empty line left the prompt open");
assert!(board.notice.is_none(), "an empty line named a command");
// A line of nothing but separators names no command either.
board.open_prompt();
type_line(&mut board, " ");
submit(&mut board);
assert!(board.prompt.is_none(), "a line of spaces left the prompt open");
assert!(board.notice.is_none(), "a line of spaces named a command");
}
/// A line clap takes closes the prompt and is named, in the footer's one channel for
/// saying something in words. It is *not* run here, and the notice has to say so.
#[test]
fn enter_names_the_command_the_line_resolved_to_and_closes_the_prompt() {
let dir = searchable();
let mut board = one_board(&dir);
board.open_prompt();
type_line(&mut board, "mv 1111111 --status committed");
submit(&mut board);
assert!(board.prompt.is_none(), "the prompt stayed open on a line clap took");
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(row.contains("mv"), "the command was not named: {row}");
assert!(row.contains("not run"), "the notice reads like the move happened: {row}");
// A command inside a group is named by the words that reach it, off the matches
// rather than a list of verbs kept here.
board.open_prompt();
type_line(&mut board, "campaign show v1");
submit(&mut board);
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(row.contains("campaign show"), "the group was not named: {row}");
// And the reason the line is tokenised at all: `comment` takes two arguments, so a
// body split on whitespace would be five and clap would refuse it.
board.open_prompt();
type_line(&mut board, "comment 1111111 \"the offset was never passed\"");
submit(&mut board);
assert!(board.prompt.is_none(), "a quoted body was refused: {:?}", refused(&board));
}
/// A line clap will not take keeps the prompt open with the line intact, so a typo is
/// corrected in place instead of retyped from `:`. The message is clap's own, cut back
/// to the part that fits a row.
#[test]
fn a_refused_line_keeps_the_prompt_open_and_shows_clap_without_the_usage_block() {
let dir = searchable();
let mut board = one_board(&dir);
board.open_prompt();
type_line(&mut board, "mv");
submit(&mut board);
assert_eq!(prompt_line(&board), Some("mv"), "the line was not kept");
let message = refused(&board).expect("nothing was said about a line clap refused");
assert!(message.contains("required"), "not clap's own message: {message}");
assert!(!message.contains("Usage:"), "the usage block reached the row: {message}");
assert!(!message.contains('\n'), "the message is a paragraph, not a row: {message}");
assert!(!message.contains('\x1b'), "clap coloured the message: {message:?}");
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(row.contains(" :mv"), "the line left the row: {row}");
assert!(row.contains("required"), "the message is not on the row: {row}");
assert!(
!row.contains("esc cancel"),
"the keys and the message shared the row: {row}"
);
// The message is about the line, so moving the cursor keeps it and an edit takes it.
board.prompt_key(typed(KeyCode::Left));
assert!(
refused(&board).is_some(),
"moving the cursor cleared a message about a line that had not changed"
);
type_line(&mut board, "x");
assert!(refused(&board).is_none(), "the message outlived the line it was about");
}
/// `--help` parses as an error of the kind that means *print this*, and what it would
/// print is a page: uncaught, clap's help lands on the alternate screen the way an
/// unsunk `println!` would. `--version` is one line by construction, so it says itself.
#[test]
fn help_and_version_put_nothing_over_the_board() {
let dir = searchable();
let mut board = one_board(&dir);
for line in ["--help", "-h", "mv --help"] {
board.open_prompt();
type_line(&mut board, line);
submit(&mut board);
let message = refused(&board).unwrap_or_else(|| panic!("`{line}` said nothing"));
assert!(!message.contains('\n'), "`{line}` put a page on the row: {message}");
assert!(message.contains("help"), "`{line}` said something else: {message}");
let screen = render(&board, SCREEN.width, SCREEN.height);
assert!(
screen.join("\n").contains("Alpha first"),
"`{line}` printed over the board"
);
board.prompt_key(typed(KeyCode::Esc));
}
board.open_prompt();
type_line(&mut board, "--version");
submit(&mut board);
let message = refused(&board).expect("`--version` said nothing");
assert!(
message.contains(env!("CARGO_PKG_VERSION")),
"`--version` did not say the version: {message}"
);
assert!(!message.contains('\n'), "the version is not one line: {message}");
}
/// The splitter reports a half-typed line as a state rather than an error, and this is
/// what the prompt does with it: nothing goes to clap, because a grammar complaint about
/// a sentence nobody finished is a complaint about the wrong thing.
#[test]
fn a_line_that_ends_inside_a_quote_is_never_handed_to_clap() {
let dir = searchable();
let mut board = one_board(&dir);
board.open_prompt();
type_line(&mut board, "comment 1111111 \"the offset");
submit(&mut board);
assert_eq!(
prompt_line(&board),
Some("comment 1111111 \"the offset"),
"the line was not kept"
);
let message = refused(&board).expect("nothing was said about an open quote");
assert!(message.contains("quote"), "{message}");
// Closing it makes the same line a command.
type_line(&mut board, "\"");
submit(&mut board);
assert!(
board.prompt.is_none(),
"a closed quote was still refused: {:?}",
refused(&board)
);
}
/// A line longer than the row scrolls under the cursor instead of being cut off at the
/// end of the field, and scrolls back as the cursor moves left.
#[test]
fn a_line_longer_than_the_row_scrolls_with_the_cursor() {
// The window itself, which is where the rule lives.
assert_eq!(prompt_window("mv", 2, 10), ("mv".to_string(), 2));
assert_eq!(prompt_window("", 0, 10), (String::new(), 0));
assert_eq!(prompt_window("abcdefghij", 10, 5), ("ghij".to_string(), 4));
assert_eq!(prompt_window("abcdefghij", 0, 5), ("abcde".to_string(), 0));
assert_eq!(prompt_window("abcdefghij", 7, 5), ("defgh".to_string(), 4));
// One cell wide is still a cursor to type at rather than a panic.
assert_eq!(prompt_window("abc", 3, 1), (String::new(), 0));
let dir = searchable();
let mut board = one_board(&dir);
board.open_prompt();
type_line(&mut board, &format!("mv {}", "a".repeat(200)));
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(!row.contains(":mv"), "the head of the line held the row: {row}");
assert!(row.contains("esc cancel"), "a long line pushed the keys off: {row}");
let mut terminal = Terminal::new(TestBackend::new(SCREEN.width, SCREEN.height)).unwrap();
terminal.draw(|frame| draw(frame, &board)).unwrap();
assert!(
terminal.get_cursor_position().unwrap().x < SCREEN.width,
"the cursor left the frame"
);
// Home takes the window back to the front of the line.
board.prompt_key(typed(KeyCode::Home));
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(
row.contains(" :mv aaa"),
"the window did not follow the cursor back: {row}"
);
}
/// `:` is the way in, and only from the action arms: typed into either open prompt it is
/// an ordinary character, and pressed at an open picker it belongs to the picker.
#[test]
fn a_colon_typed_into_the_search_or_the_picker_opens_nothing() {
let dir = searchable();
// A campaign to pick, since an empty picker says so rather than opening. Its own
// uuid, not one of the tickets': nothing here resolves either, and a shared prefix
// in a fixture reads as a claim that it matters.
write_campaign(
&dir,
"55555555-0000-4000-8000-000000000000",
"First public release",
"v1",
"For a public tag.",
);
let mut board = one_board(&dir);
board.open_search();
assert!(board.search_key(letter(':'), SCREEN), "':' was not taken by the search");
assert!(board.prompt.is_none(), "the search prompt opened a command prompt");
assert_eq!(board.search.as_ref().map(|search| search.query.as_str()), Some(":"));
board.search_key(typed(KeyCode::Esc), SCREEN);
board.open_picker(PickerKind::Campaign, SCREEN);
assert!(board.picker_key(letter(':'), SCREEN), "':' was not taken by the picker");
assert!(board.prompt.is_none(), "the picker opened a command prompt");
assert!(board.picker.is_some(), "':' closed the picker");
// And inside the picker's own query it is a character like any other.
board.picker_key(letter('/'), SCREEN);
board.picker_key(letter(':'), SCREEN);
assert_eq!(
board
.picker
.as_ref()
.and_then(|picker| picker.query.clone())
.as_deref(),
Some(":"),
);
assert!(board.prompt.is_none(), "the picker's query opened a command prompt");
}
/// The row names the keys that work, and `:` works in every state the board is in.
#[test]
fn every_footer_names_the_command_key() {
let dir = searchable();
let mut board = one_board(&dir);
assert!(footer(&board, 120, 20).contains(": command"), "the board's own footer");
board.toggle_detail();
assert!(footer(&board, 120, 20).contains(": command"), "the modal footer");
}
/// The prompt has to be offered every key before the action arms, and `:` has to be the
/// way in from the board itself. Neither is reachable from a test, so the dispatch is
/// read as text, the way the search prompt's own contract is.
#[test]
fn the_dispatch_opens_the_command_prompt_and_gives_it_the_keyboard_first() {
let source = include_str!("main.rs")
.split_whitespace()
.collect::<Vec<_>>()
.join(" ");
assert!(
source.contains("if board.prompt_key(key) { continue; }"),
"the prompt has to be offered every key before the action arms, or typing \
'd' into a command toggles the done column"
);
assert!(
source.contains("KeyCode::Char(':') => board.open_prompt(),"),
"`:` has to open the prompt from the action arms"
);
}
// ------------------------------------------------------------------ the copy key --
/// A sink that records what it was handed, standing in for the clipboard.
+89 -15
View File
@@ -1,7 +1,7 @@
use anyhow::{Result, anyhow};
use chrono::NaiveDateTime;
use std::fs;
use std::io::IsTerminal;
use std::io::{IsTerminal, Write};
use std::path::Path;
use std::sync::OnceLock;
@@ -303,6 +303,80 @@ pub fn color_text(text: &str, color: Color) -> String {
paint(text, color, should_use_colors())
}
/// A destination for a command's output, chosen by the caller.
///
/// `main` hands a handler its own stdout and nothing about the CLI changes; the
/// board (or a test) hands it an in-memory buffer and reads back what the command
/// said. Threading the writer and the colour decision together means every print
/// site reaches both, and a handler never asks the process about its own stdout.
///
/// `use_color` is the sink's answer, not a read of [`should_use_colors`]: a process
/// whose stdout is a pipe still wants colour when the sink is a buffer a renderer
/// will colour itself, and the board wants plain text however the terminal answers.
pub struct Sink<'a> {
writer: Box<dyn Write + 'a>,
/// Whether the bytes this sink writes carry colour escapes.
pub use_color: bool,
}
impl<'a> Sink<'a> {
/// The process's stdout, coloured by what the terminal wants.
///
/// What `main` passes, so the CLI's output is byte identical to before: every
/// command wrote to stdout through `println!`, and this sink writes to the same
/// stdout through the same [`paint`].
pub fn std() -> Sink<'static> {
// Through `new` so the process's stdout is just another writer the sink wraps.
Sink::new(Box::new(std::io::stdout()), should_use_colors())
}
/// An in-memory buffer, plain, for a test or a caller that colours the text
/// itself.
#[allow(dead_code)]
pub fn buffer(target: &'a mut Vec<u8>) -> Sink<'a> {
Sink {
writer: Box::new(target),
use_color: false,
}
}
/// Any writer, with the colour decision given.
pub fn new(writer: Box<dyn Write + 'a>, use_color: bool) -> Sink<'a> {
Sink { writer, use_color }
}
/// The writer, for a caller that already knows how to fill it (the completions
/// generator).
pub fn as_write(&mut self) -> &mut dyn Write {
&mut *self.writer
}
/// Write `text` followed by a newline, the way `println!` did.
pub fn writeln(&mut self, text: &str) -> Result<()> {
self.writer.write_all(text.as_bytes())?;
self.writer.write_all(b"\n")?;
Ok(())
}
/// Write `text` with no terminator, the way `print!` did. The caller flushes
/// when it then waits on input.
pub fn write(&mut self, text: &str) -> Result<()> {
self.writer.write_all(text.as_bytes())?;
Ok(())
}
/// Flush the writer, so a prompt reaches the terminal before a read.
pub fn flush(&mut self) -> Result<()> {
self.writer.flush()?;
Ok(())
}
/// `text` wrapped in `color`'s escape when this sink is coloured.
pub fn color(&self, text: &str, color: Color) -> String {
paint(text, color, self.use_color)
}
}
/// What sits at a candidate `.worklane` path.
///
/// The distinction the walk turns on is between nothing there and something
@@ -738,10 +812,6 @@ pub struct Resolved {
pub campaign: Vec<Cell>,
}
pub fn content_trim_colored(content: &str, resolved: &Resolved) -> String {
content_trim(content, should_use_colors(), resolved)
}
/// A section heading, its rule, and the blank line the body opens under.
///
/// The rule is measured on the name as displayed, in characters. It used to span the
@@ -3314,8 +3384,8 @@ fn show_priority(priority: Priority, colored: bool) -> String {
paint(glyph, colour, colored)
}
pub fn display_ticket_items(items: &[TicketItem]) {
let colored = should_use_colors();
pub fn display_ticket_items(sink: &mut Sink, items: &[TicketItem]) -> Result<()> {
let colored = sink.use_color;
for item in items {
let id = paint(&item.id, Color::Red, colored);
@@ -3324,15 +3394,19 @@ pub fn display_ticket_items(items: &[TicketItem]) {
let priority = show_priority(item.priority, colored);
if item.created.is_empty() {
println!(" {} ({}) {} | Owner: {} | Due: {}", priority, id, item.title, owner, due);
sink.writeln(&format!(
" {} ({}) {} | Owner: {} | Due: {}",
priority, id, item.title, owner, due
))?;
} else {
let created = paint(&item.created, Color::Cyan, colored);
println!(
sink.writeln(&format!(
" {} {} ({}) {} | Owner: {} | Due: {}",
priority, created, id, item.title, owner, due
);
))?;
}
}
Ok(())
}
pub fn collect_ticket_items(status_path: impl AsRef<Path>) -> Result<Vec<TicketItem>> {
@@ -4714,7 +4788,7 @@ mod tests {
#[test]
fn a_section_rule_matches_the_width_of_its_name() {
let rendered = content_trim_colored("# T\n\n## Description\nbody\n", &Resolved::default());
let rendered = content_trim("# T\n\n## Description\nbody\n", false, &Resolved::default());
// Eleven characters, not fourteen: the rule used to span "## Description"
assert!(rendered.starts_with("Description\n───────────\n"), "{rendered:?}");
@@ -4722,7 +4796,7 @@ mod tests {
#[test]
fn a_non_ascii_section_name_is_not_over_drawn() {
let rendered = content_trim_colored("# T\n\n## Résumé\nbody\n", &Resolved::default());
let rendered = content_trim("# T\n\n## Résumé\nbody\n", false, &Resolved::default());
assert!(rendered.starts_with("Résumé\n──────\n"), "{rendered:?}");
}
@@ -4730,7 +4804,7 @@ mod tests {
#[test]
fn the_body_leaves_the_title_to_cmd_show() {
let rendered =
content_trim_colored("# Only Once\n\n## Description\nbody\n", &Resolved::default());
content_trim("# Only Once\n\n## Description\nbody\n", false, &Resolved::default());
assert!(!rendered.contains("Only Once"), "{rendered:?}");
// And no gap where it was
@@ -4740,7 +4814,7 @@ mod tests {
#[test]
fn the_metadata_section_renders_as_a_table_inside_the_body() {
let content = "# T\n\n## Metadata\n\n- **ID**: abc\n- **Owner**: alice\n";
let rendered = content_trim_colored(content, &Resolved::default());
let rendered = content_trim(content, false, &Resolved::default());
assert_eq!(rendered, "Metadata\n────────\n\nID abc\nOwner alice\n");
}
@@ -4853,7 +4927,7 @@ Plain line with **bold** and a [link](http://x.test/a).
#[test]
fn a_section_after_metadata_still_renders() {
let content = "# T\n\n## Metadata\n\n- **ID**: abc\n\n## Notes\n\nafter\n";
let rendered = content_trim_colored(content, &Resolved::default());
let rendered = content_trim(content, false, &Resolved::default());
assert!(rendered.contains("ID abc"), "{rendered:?}");
assert!(rendered.contains("Notes\n─────\n"), "{rendered:?}");