Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f0f88025f3 |
@@ -247,9 +247,12 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- The draw aligns the focused column again on its own geometry, so a resize between keypress and frame cannot hide the selection, and caps every column against blank space past its last card. The stored value may go stale after a tick shrinks the column; that is fine, because what is drawn is corrected immediately and the next navigation writes the correction back
|
||||
- Entering another column follows the selection rather than resetting to its top. The card index carries across columns, so a reset would open the column with the highlight below the fold whenever it was — the opposite of the detail view's reset-on-selection-move, where each ticket genuinely starts at its own top. The index is shared and clamps permanently when a shorter column pulls it down, so a column you return to follows the selection to where it now sits rather than holding your old place
|
||||
- **The footer names only keys that work.** It read `↑↓ scroll` when nothing scrolled at all, which sends the reader looking for their own mistake. A UI that misdescribes itself is worse than one that is merely incomplete
|
||||
- **A hint is a key and what pressing it does, and `key_hint` is the only thing that draws one.** The key is cyan and bold, the description takes the terminal's default foreground, and the row keeps its three-space gaps. Everything that names a key goes through it: the three footer states, the prompt's two keys, the picker's row and the `q board` on the frame's border, so a reader learns the shape once. Same division in frig and pantop, each in its own accent colour, cyan here and magenta there — the three tools are read side by side and used to look like three programs
|
||||
- **A key that is its description's first letter is merged into it**, so the board draws `quit`, `campaign` and `tag` with the letter coloured and no letter in front, while `y copy id`, `ctrl-c quit`, `d show done (2)` and every arrow row stay split. Two cells back on a row already at its width naming eight keys, and the coloured letter *is* the key either way. The prefix test in `key_hint` is case sensitive for exactly that reason: a row naming both `r` and `R` would otherwise draw one word for the two of them, and the merged form can only say which key it is while the letter on screen is that key. It also means the row carries both forms at once, which is the cost of the two cells
|
||||
- **What the row is cannot be read off its text any more, so the tests read its cells.** `footer_cells`, `footer_at`, `keys_on` and `footer_style` in the test module: `keys_on(.., "quit")` is `Some(1)` where `q` quits and `Some(0)` on a row whose only `quit` is the tail of `ctrl-c quit`. A `contains("q quit")` cannot tell those apart, and three of the guards that keep 1b78a24 out were written that way
|
||||
- **`q` and `esc` are one key: close what is open, quit when there is nothing left to close.** `q` used to set `should_quit` outright, so a reader who pressed it to put a ticket away lost the board instead, which is not what `q` does anywhere else that lays a document over a list. One match arm in `main.rs`, not two: two arms carrying one rule is how a later edit changes it for one key and not the other
|
||||
- **The rule is `Board::dismiss`, not the match arm.** The dispatch in `main.rs` is not reachable from a test, so anything decided there is undecidable by the suite. The arm is the line that names the keys and nothing else. `the_dispatch_gives_q_and_esc_one_arm_and_leaves_ctrl_c_quitting` scans `main.rs` for what the arm cannot say for itself, over whitespace-collapsed source so rustfmt cannot fail it
|
||||
- **The footer's last slot always answers how to get out**, and with a ticket open the honest answer is `ctrl-c`, the only key left that quits in one press. Going on saying `q quit` there would be 1b78a24 in the other direction: a footer describing a key by what it used to do
|
||||
- **The footer's last slot always answers how to get out**, and with a ticket open the honest answer is `ctrl-c`, the only key left that quits in one press. Going on drawing the merged `quit` there would be 1b78a24 in the other direction: a footer describing a key by what it used to do. `ctrl-c quit` is split by the same rule that merges the other, being no word's first letter
|
||||
- **The overlay names its ticket on the border, not at the head of the paragraph.** `Board::detail` is a `Detail` carrying the title, the id and the text, because the name has to travel beside the body rather than inside it: `content_trim` drops the `# ` heading on purpose, since `cmd_show` prints it, and anything in the paragraph scrolls away
|
||||
- `detail_title` cuts the string itself instead of leaving it to ratatui, which truncates an overlong block title at whatever cell it reaches and would take the id with it. Cut against the inner width, so the id survives whole and the name ends in an ellipsis. The id goes first because that is how every other view addresses a ticket
|
||||
- The detail view renders from cells, never from painted strings: ratatui draws styled spans, so an escape sequence in a paragraph would be printed as literal bytes. `content_trim` and `format_history_with` take the colour decision for the CLI's side of the same layouts
|
||||
@@ -286,9 +289,9 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- **The toggle re-clamps the frame offset, through `scroll_frame(0, screen)`.** A taller viewport has a smaller last offset than a shorter one, so where the reader was can end up past the end of the frame they just asked for. The draw clamps on its own geometry either way, but the stored value has to be clamped too or the next `pgup` counts down from a number the frame never showed. A scroll of no pages is that clamp and nothing else, which keeps it in the one place it lives
|
||||
- **The frame is out of reach from under an open ticket.** With the overlay open, up and down step through the tickets and it follows, so a selection that reached the frame would have to either close it on an arrow key or leave it showing a ticket nothing is selecting. `an_open_ticket_keeps_the_scroll_keys_from_the_frame` builds that state by hand for exactly this reason: the precedence has to hold whether or not a keypress can reach it
|
||||
- **The standing comes from the columns, not from a walk of the tree.** While a campaign is selected the columns *are* its members, done included, so `Tab::standing` counts what is already in hand rather than paying what `campaign ls` pays per campaign. Counted over every column, drawn or not: hiding done is a change to what is drawn and never to what is counted
|
||||
- **The way out is on the frame's own border, not in the footer.** `q board` sits on the thing it takes away, and the footer row was already at its width naming eight keys. Dropped whole when it and the standing would meet, the rule the page indicator follows
|
||||
- **The way out is on the frame's own border, not in the footer.** `q board` sits on the thing it takes away, and the footer row was already at its width naming eight keys. Dropped whole when it and the standing would meet, the rule the page indicator follows, and measured over its spans rather than one string since it is a key hint like any other. Drawn through `key_hint` and not as grey chrome: it is the one key on the board named anywhere but the footer, and a reader who has learnt to look for the cyan letter should not need a second convention to find it. The indicator beside it stays grey, having no key in it
|
||||
- **`c` and `t` are named in the footer only on a closed board with nothing filtered**, which is where a reader has to find them. Over an open ticket and on a filtered board they are left out: the frame's border then says how to put the filter away, and the row has no cells to spare. The tag used to be drawn on that row in its own colour, for want of a frame to draw it in, and 2a83bd4 took that away rather than saying it twice. Incomplete rather than wrong, which is the trade this row is allowed to make — what it must never do is name a key by what it used to do
|
||||
- **The footer has three states, because the selection has three places to be.** An open ticket, the frame, and the cards. On the frame it names `↓ board`, `enter expand` or `enter collapse`, the two scroll keys and `y copy id` — `y copy tag` on a tag frame — and leaves out `←→` because they do nothing there. It has to say which way `enter` goes, since the key is a toggle and the frame is always at one of its two heights. `↑ frame` is not named on the board, on the same trade `c` is dropped on: the frame is drawn directly above the columns and up is the key that reaches it. Nor is the way to collapse an expanded frame named from the cards, which is the same trade again — the frame is right there and `↑` reaches it
|
||||
- **The footer has three states, because the selection has three places to be.** An open ticket, the frame, and the cards. On the frame it names `↓ board`, `↵ expand` or `↵ collapse`, the two scroll keys and `y copy id` — `y copy tag` on a tag frame — and leaves out `←→` because they do nothing there. It has to say which way `↵` goes, since the key is a toggle and the frame is always at one of its two heights. `↑ frame` is not named on the board, on the same trade `c` is dropped on: the frame is drawn directly above the columns and up is the key that reaches it. Nor is the way to collapse an expanded frame named from the cards, which is the same trade again — the frame is right there and `↑` reaches it
|
||||
- **`picker: Option<Picker>` is the whole mode**, the shape `search` and `detail` use, and `Board::picker_key` runs beside `search_key` ahead of the action arms for the same reason: an open list owns the keyboard, so `d` must not toggle done and `q` must not quit while a campaign is being chosen. `ctrl-c` is the one key it declines and every other control combination is swallowed, or `ctrl-d` would reach the arm bound to `d`
|
||||
- **The picker's rows are `Tab::campaigns`, not a copy taken when it opened**, so a campaign filed elsewhere appears in an open picker on the next tick. It opens on the campaign already selected, so `c` on a filtered board says where you are as well as offering somewhere to go, and a board with no campaigns gets a `Notice` rather than an empty box that has to be dismissed to learn it was empty
|
||||
- **A picker row draws a real codename only.** The row opens with the short id, so the card's `~<id>` fallback would print it twice and say nothing the second time
|
||||
@@ -333,7 +336,7 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- Id and title only, per 3b16540, both lowercased. The title has to be case insensitive to be worth typing, and giving the id the same treatment lets a pasted id match whatever case it was copied in. An empty or all-space query matches **nothing** rather than everything
|
||||
- **The jump goes through `select_at`, the tail `select_card` already used.** `follow_selection` scrolls the column the card is in, and the offsets are per column and on the `Tab`, so a jump across columns moves the right one; `refresh_detail` keeps an open overlay on the ticket the selection names. A second version of either is how a jump comes to scroll differently from the arrow keys
|
||||
- **A hit closes the prompt and a miss keeps it open**, marked, with the selection untouched. The query can then be corrected in place instead of retyped from `/`. Doing nothing visible is what makes a reader retype a query that was already right
|
||||
- **The prompt takes the whole footer row**, because the key list it replaces describes nothing that currently works while every key is going into the buffer. The typed query is drawn in the default foreground and the keys in grey: one is content, the other is chrome. `no match` is brightred beside the query it is about, since grey chrome is what a reader skips
|
||||
- **The prompt takes the whole footer row**, because the key list it replaces describes nothing that currently works while every key is going into the buffer. Its two keys are drawn as every other key is, cyan on the key and the default foreground on the word. That the query then sits in the same foreground as the descriptions is what the house style costs on this row, and the cursor is what says which half is an input — which it does in a terminal with no colour at all. `no match` stays brightred beside the query it is about, being the one thing on the row that is neither a key nor what was typed
|
||||
- **The real terminal cursor goes after the query**, not a glyph standing in for one. ratatui shows the cursor only for a frame that asked for it, so `set_cursor_position` is also what says "you are typing" while the query is still empty. Clamped to the row, so a query longer than the terminal leaves it on the last cell
|
||||
- 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
|
||||
@@ -480,7 +483,8 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- **Relation row to a discarded target → struck through, the whole row.** The one thing in the palette that is not a colour, and it is here because the status mark cannot carry it: that mark is one cell in a column of five states, so a row pointing at abandoned work reads as a live dependency, which is exactly what it is not. The strike says the relation no longer stands for anything while the row stays on the ticket, for completeness and for the case the target is moved back out of discarded. Only discarded: a done target still stands for the fact that it was a blocker, and a `_missing_` one says something different again, that the row cannot be resolved at all. Gutter and padding included, so the line runs unbroken from the label to the end of the title, and every cell opens its own SGR 9 since each is closed by its own `RESET`
|
||||
- **The strike is under the colour flag, like every other escape.** A piped `show` carries none of it, the same bargain committed and reviewing already take for being told apart by colour alone, and the board draws it as a style instead. Do not answer the pipe by changing the glyph in the mark column: the pair there has to stay unique, and `every_status_has_a_mark` is what says so
|
||||
- Markdown link → cyan, markers and url kept. Not a new meaning for the colour: the plan numbers, the criterion numbers and the `relates to` mark are already cyan inside a rendered body, and a link is the same kind of thing, a pointer the reader may follow rather than a value. The url is not hidden behind the text the way a renderer would hide it, because `show` prints to a terminal worklane cannot assume will make it clickable, and a link whose target cannot be read is worse than a long line
|
||||
- Chrome → grey. The footer's key names, a rendered `[ ]`, and the overlay's page indicator. Not a new slot: grey already means "what a reader skips", which is the other half of the unset-value meaning, and none of these is a value. The indicator in orange would read as the title it faces across the overlay, in cyan as a timestamp, and in the priority ramp's colours as a level
|
||||
- Chrome → grey. A rendered `[ ]`, the overlay's page indicator and the frame's. Not a new slot: grey already means "what a reader skips", which is the other half of the unset-value meaning, and none of these is a value. The indicator in orange would read as the title it faces across the overlay, in cyan as a timestamp, and in the priority ramp's colours as a level
|
||||
- **A key name → cyan, and bold; what pressing it does → the default foreground.** The one place the palette spends a colour on something that is not a value: a key is what a reader is hunting for on a row they otherwise skip, and with the key merged into its description the colour is the only thing saying which letter to press. Not a second meaning for the timestamp's cyan in any place the two could be confused — nothing on the footer, the prompt or a border hint holds a value at all — and it is the accent frig draws the same row in, which is the point. Grey stays on the chrome around it: the page indicator, and the row's gaps
|
||||
- Chrome → grey, in the history block too: the kind label at the head of a mechanical row, and the `From` on a comment's author line. Both name their row rather than holding a value, which is what grey already says. The label was orange, which means Status everywhere else, so an `owner` or `tags` label claimed a meaning belonging to the value beside it
|
||||
- **A value in the history block takes the colour it has in the metadata table three lines above.** A status is orange, a tags entry goes through the same `tag_cells` the Tags field does, a campaign codename takes `tag_color` bare the way `Codename` does, and `_Not set_`, `_None_` and `_missing_` are grey. An owner stays plain: a person's name is the one value the palette has no meaning for, and spending a colour on the field that needs it least is how a colour stops meaning anything. The block's job is to be scanned, and it is not worth scanning if it has a palette of its own to learn first
|
||||
- History actor → its name through `tag_color`, the way a campaign codename is. Not a new meaning for a reserved colour but the existing use of the tag slots, a name that groups rows: one writer is one colour in every entry it wrote, so a reader sees who has been working a ticket without reading the same name four times. `claude`, `opencode` and a person each get their own
|
||||
|
||||
Generated
+1
-1
@@ -1503,7 +1503,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "worklane"
|
||||
version = "0.32.1"
|
||||
version = "0.32.2"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"assert_cmd",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "worklane"
|
||||
version = "0.32.1"
|
||||
version = "0.32.2"
|
||||
edition = "2024"
|
||||
|
||||
[dependencies]
|
||||
|
||||
+334
-97
@@ -2682,31 +2682,43 @@ fn draw_frame(frame: &mut Frame, tab: &Tab, area: Rect) {
|
||||
|
||||
// The way out, on the border of the thing it undoes rather than in the footer. The
|
||||
// footer row is already at its width naming eight keys, and this belongs beside the
|
||||
// frame anyway: it is what takes the frame away. Grey because it is chrome, the colour
|
||||
// the footer's own key names and the overlay's page indicator take.
|
||||
// frame anyway: it is what takes the frame away. Drawn as a key hint and not as grey
|
||||
// chrome, because that is what it is, and it is the one key on the board named anywhere
|
||||
// but the footer: a reader who has learnt where the cyan letter is should not have to
|
||||
// learn a second convention to find this one. The indicator beside it keeps the chrome
|
||||
// colour, having no key in it.
|
||||
//
|
||||
// The page indicator follows it on the same border rather than going up beside the
|
||||
// title where the overlay's sits. The title is cut against the border it is on, so an
|
||||
// indicator up there would shorten a long campaign name the moment its description grew
|
||||
// past three rows, and the bottom right is the standing's — which is what the frame is
|
||||
// about, where this is only where the reader has got to in it.
|
||||
let hint = " q board ";
|
||||
let mut hint = vec![Span::raw(" ")];
|
||||
hint.extend(key_hint("q", "board"));
|
||||
hint.push(Span::raw(" "));
|
||||
|
||||
let indicator = page_indicator(offset, last, text.height, area.width).unwrap_or_default();
|
||||
let room = area.width.saturating_sub(2) as usize;
|
||||
let taken = spans_width(&content.standing);
|
||||
let hint_width = spans_width(&hint);
|
||||
let indicator_width = indicator.chars().count();
|
||||
|
||||
// Dropped whole rather than cut, the rule the indicator follows on the overlay: half of
|
||||
// either reads as something else. The indicator goes first when the two cannot both fit,
|
||||
// because with a filter on the footer's last slot names `ctrl-c quit` and this is the
|
||||
// only place on the board that says `q` gives it back.
|
||||
let both = format!("{hint}{indicator}");
|
||||
let left = [both.as_str(), hint, ""]
|
||||
.into_iter()
|
||||
.find(|left| left.chars().count() + taken <= room)
|
||||
.unwrap_or_default();
|
||||
// only place on the board that says `q` gives it back. Measured over the spans rather
|
||||
// than over one string, since the hint is three of them now.
|
||||
let left = match (hint_width + indicator_width + taken <= room, hint_width + taken <= room) {
|
||||
(true, _) => {
|
||||
let mut both = hint;
|
||||
both.push(Span::styled(indicator, Style::default().fg(Color::Grey.into())));
|
||||
both
|
||||
}
|
||||
(false, true) => hint,
|
||||
(false, false) => Vec::new(),
|
||||
};
|
||||
if !left.is_empty() {
|
||||
block = block
|
||||
.title_bottom(Line::from(Span::styled(left, Style::default().fg(Color::Grey.into()))));
|
||||
block = block.title_bottom(Line::from(left));
|
||||
}
|
||||
|
||||
block = block.title_bottom(Line::from(content.standing).right_aligned());
|
||||
@@ -3379,6 +3391,56 @@ fn with_ellipsis(row: &str, width: usize) -> String {
|
||||
cut
|
||||
}
|
||||
|
||||
/// The gap between two hints on a row of keys.
|
||||
const KEY_GAP: &str = " ";
|
||||
|
||||
/// One key hint: the key, and what pressing it does.
|
||||
///
|
||||
/// Two spans either way, the key and the rest of it. The key is cyan and bold and the
|
||||
/// description takes the terminal's default foreground, which is the row frig and pantop
|
||||
/// draw with the same division — one accent colour per tool, cyan here and magenta there.
|
||||
/// The row as a whole is still chrome, but a key nobody can pick out of it is chrome that
|
||||
/// has to be read word by word to be used.
|
||||
///
|
||||
/// **The key is merged into the description when it is the description's first letter**, so
|
||||
/// `quit` is drawn with a cyan `q` and nothing in front of it while `y copy id` keeps both
|
||||
/// halves. Two cells back on a row already at its width naming eight keys, and the letter
|
||||
/// on screen is the key either way. The prefix test is case sensitive for that reason: a
|
||||
/// board naming both `r` and `R` would draw one word for the two of them otherwise, and the
|
||||
/// merged form can only say which key it is while the letter it colours *is* that key.
|
||||
fn key_hint(key: &str, description: &str) -> [Span<'static>; 2] {
|
||||
let rest = match description.strip_prefix(key) {
|
||||
Some(rest) => rest.to_string(),
|
||||
None => format!(" {description}"),
|
||||
};
|
||||
|
||||
[
|
||||
Span::styled(
|
||||
key.to_string(),
|
||||
Style::default()
|
||||
.fg(Color::Cyan.into())
|
||||
.add_modifier(Modifier::BOLD),
|
||||
),
|
||||
Span::raw(rest),
|
||||
]
|
||||
}
|
||||
|
||||
/// A run of hints, gap separated, closed by the space every row ends on.
|
||||
///
|
||||
/// The opening space is the caller's: the footer starts on one, and the prompt and the
|
||||
/// picker's query row put what was typed there instead.
|
||||
fn key_hints(hints: &[(&str, &str)]) -> Vec<Span<'static>> {
|
||||
let mut spans = Vec::new();
|
||||
for (key, description) in hints {
|
||||
if !spans.is_empty() {
|
||||
spans.push(Span::raw(KEY_GAP));
|
||||
}
|
||||
spans.extend(key_hint(key, description));
|
||||
}
|
||||
spans.push(Span::raw(" "));
|
||||
spans
|
||||
}
|
||||
|
||||
fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
|
||||
// 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
|
||||
@@ -3410,24 +3472,19 @@ fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
|
||||
// version of the summary line `ls` prints above a listing that leaves the terminal
|
||||
// statuses out.
|
||||
let d = match board.visibility.next_reveal() {
|
||||
Some(status) => format!("d show {} ({})", status, column_count(board, status)),
|
||||
None => "d hide both".to_string(),
|
||||
};
|
||||
|
||||
// Only when there is a tab to move to, since the footer names keys that work.
|
||||
let tabs = match board.tabbed() {
|
||||
true => "tab project ",
|
||||
false => "",
|
||||
Some(status) => format!("show {} ({})", status, column_count(board, status)),
|
||||
None => "hide both".to_string(),
|
||||
};
|
||||
|
||||
// The last slot answers the same question in every state: how to get out of here. `q`
|
||||
// takes off whatever is on top, so with a ticket open or a filter on the honest answer
|
||||
// is `ctrl-c`, the only key left that quits in one press. Naming `q quit` over either
|
||||
// would be the fault 1b78a24 was, a footer describing a key by what it used to do — and
|
||||
// with a filter on, the frame names what that press actually does instead.
|
||||
// is `ctrl-c`, the only key left that quits in one press. Going on drawing the merged
|
||||
// `quit` there would be the fault 1b78a24 was, a footer describing a key by what it
|
||||
// used to do — and with a filter on, the frame names what that press actually does
|
||||
// instead. Split either way once the key is `ctrl-c`, which is no word's first letter.
|
||||
let quit = match board.detail.is_some() || !board.current().filter.is_whole() {
|
||||
true => "ctrl-c quit",
|
||||
false => "q quit",
|
||||
true => ("ctrl-c", "quit"),
|
||||
false => ("q", "quit"),
|
||||
};
|
||||
|
||||
// `c` and `t` are named where a reader has to find them: on the board, with nothing
|
||||
@@ -3436,53 +3493,74 @@ fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
|
||||
// so the row is not at its width naming nine keys to repeat what is already on screen.
|
||||
// The tag used to be drawn here for want of a frame to draw it in, which is the one
|
||||
// thing 2a83bd4 took away.
|
||||
let filter = match board.current().filter {
|
||||
Filter::Whole => "c campaign t tag ",
|
||||
_ => "",
|
||||
let filter: &[(&str, &str)] = match board.current().filter {
|
||||
Filter::Whole => &[("c", "campaign"), ("t", "tag")],
|
||||
_ => &[],
|
||||
};
|
||||
|
||||
// Which way `↵` will go, since the key is a toggle and the frame is already at one of
|
||||
// its two heights. Naming it `expand` while it collapses would be the fault 1b78a24
|
||||
// was, a footer describing a key by what it used to do.
|
||||
let height = match board.current().expanded {
|
||||
true => "collapse",
|
||||
false => "expand",
|
||||
};
|
||||
|
||||
// What `y` copies where the selection is. A tag is its own id, so naming it one would
|
||||
// send the reader looking for seven characters on a border that prints a word.
|
||||
let copied = match board.current().filter {
|
||||
Filter::Tag(_) => "copy tag",
|
||||
_ => "copy id",
|
||||
};
|
||||
|
||||
let mut hints: Vec<(&str, &str)> = Vec::new();
|
||||
|
||||
// Only when there is a tab to move to, since the footer names keys that work.
|
||||
if board.tabbed() {
|
||||
hints.push(("tab", "project"));
|
||||
}
|
||||
|
||||
// Three states, because the frame is a third place the selection can be and the row
|
||||
// must describe the keys that work where it is. An open ticket wins over both, which is
|
||||
// what owning `pgup` and `pgdn` means.
|
||||
//
|
||||
// On the frame, `↓` is the way back to the cards and the two scroll keys are the
|
||||
// frame's; `y` is named because it still copies what the frame names. `enter` and `←→`
|
||||
// frame's; `y` is named because it still copies what the frame names. `↵` and `←→`
|
||||
// are left out because they do nothing there. Incomplete rather than wrong, the trade
|
||||
// this row is allowed to make — what it must never do is name a key by what it used to
|
||||
// do. `↑ frame` is not named on the board for the same reason `c` is dropped from a
|
||||
// filtered board: the frame is drawn right above the columns and up is the key that
|
||||
// reaches it, and the row has no cells to spend saying so.
|
||||
// Which way `enter` will go, since the key is a toggle and the frame is already at one
|
||||
// of its two heights. Naming it `enter expand` while it collapses would be the fault
|
||||
// 1b78a24 was, a footer describing a key by what it used to do.
|
||||
let height = match board.current().expanded {
|
||||
true => "enter collapse",
|
||||
false => "enter expand",
|
||||
};
|
||||
match (board.detail.is_some(), board.current().focus) {
|
||||
(true, _) => hints.extend([
|
||||
("←→↑↓", "select"),
|
||||
("pgup/pgdn", "scroll"),
|
||||
("/", "search"),
|
||||
("y", "copy id"),
|
||||
("↵/q", "close"),
|
||||
]),
|
||||
(false, Focus::Frame) => hints.extend([
|
||||
("↓", "board"),
|
||||
("↵", height),
|
||||
("pgup/pgdn", "scroll"),
|
||||
("/", "search"),
|
||||
("y", copied),
|
||||
]),
|
||||
(false, Focus::Cards) => {
|
||||
hints.extend([("←→", "column"), ("↑↓", "card"), ("/", "search")]);
|
||||
hints.extend_from_slice(filter);
|
||||
hints.extend([("y", "copy id"), ("↵", "detail")]);
|
||||
}
|
||||
}
|
||||
|
||||
// What `y` copies where the selection is. A tag is its own id, so naming it one would
|
||||
// send the reader looking for seven characters on a border that prints a word.
|
||||
let copied = match board.current().filter {
|
||||
Filter::Tag(_) => "y copy tag",
|
||||
_ => "y copy id",
|
||||
};
|
||||
hints.push(("d", d.as_str()));
|
||||
hints.push(quit);
|
||||
|
||||
let keys = match (board.detail.is_some(), board.current().focus) {
|
||||
(true, _) => format!(
|
||||
" {tabs}←→↑↓ select pgup/pgdn scroll / search y copy id enter/q close {d} {quit} "
|
||||
),
|
||||
(false, Focus::Frame) => format!(
|
||||
" {tabs}↓ board {height} pgup/pgdn scroll / search {copied} {d} {quit} "
|
||||
),
|
||||
(false, Focus::Cards) => format!(
|
||||
" {tabs}←→ column ↑↓ card / search {filter}y copy id enter detail {d} {quit} "
|
||||
),
|
||||
};
|
||||
|
||||
frame.render_widget(
|
||||
Paragraph::new(Span::styled(keys, Style::default().fg(Color::Grey.into()))),
|
||||
area,
|
||||
);
|
||||
// The leading space is the row's own, the way every other row of the board opens on
|
||||
// one; `key_hints` closes it.
|
||||
let mut spans = vec![Span::raw(" ")];
|
||||
spans.extend(key_hints(&hints));
|
||||
frame.render_widget(Paragraph::new(Line::from(spans)), area);
|
||||
}
|
||||
|
||||
/// What the last keypress did, where the keys would otherwise be.
|
||||
@@ -3505,10 +3583,13 @@ fn draw_notice(frame: &mut Frame, notice: &Notice, area: Rect) {
|
||||
/// one: ratatui shows the cursor only for a frame that asked for it, and that is also
|
||||
/// what tells the reader they are in an input while the query is still empty.
|
||||
///
|
||||
/// What was typed is drawn in the default foreground and the keys in grey, because one
|
||||
/// of them is content and the other is chrome. A miss is said beside the query it is
|
||||
/// about, in brightred, since grey chrome is exactly what a reader skips. Colour
|
||||
/// accentuates here as it does on a card; the words carry the meaning either way.
|
||||
/// The two keys are drawn the way every other row draws them, cyan on the key and the
|
||||
/// default foreground on the word, so they are findable on a row whose other half is an
|
||||
/// input. That the query sits in the same foreground as the descriptions is what the
|
||||
/// house style costs here, and the cursor is what says which of the two is being typed
|
||||
/// into — which it does in a terminal with no colour at all. A miss stays brightred
|
||||
/// beside the query it is about, being the one thing on the row that is neither a key nor
|
||||
/// what was typed.
|
||||
fn draw_search(frame: &mut Frame, search: &Search, area: Rect) {
|
||||
let prompt = format!(" /{}", search.query);
|
||||
let mut spans = vec![Span::raw(prompt.clone())];
|
||||
@@ -3516,10 +3597,8 @@ fn draw_search(frame: &mut Frame, search: &Search, area: Rect) {
|
||||
if search.missed {
|
||||
spans.push(Span::styled(" no match", Style::default().fg(Color::BrightRed.into())));
|
||||
}
|
||||
spans.push(Span::styled(
|
||||
" enter jump esc cancel ",
|
||||
Style::default().fg(Color::Grey.into()),
|
||||
));
|
||||
spans.push(Span::raw(KEY_GAP));
|
||||
spans.extend(key_hints(&[("↵", "jump"), ("esc", "cancel")]));
|
||||
|
||||
frame.render_widget(Paragraph::new(Line::from(spans)), area);
|
||||
|
||||
@@ -3536,21 +3615,21 @@ fn draw_search(frame: &mut Frame, search: &Search, area: Rect) {
|
||||
/// is named only on the closed query, where it is the key to press, and the query's own row
|
||||
/// names what `esc` does to it rather than what it does to the picker.
|
||||
fn draw_picker_row(frame: &mut Frame, picker: &Picker, area: Rect) {
|
||||
let grey = Style::default().fg(Color::Grey.into());
|
||||
|
||||
let Some(query) = &picker.query else {
|
||||
frame.render_widget(
|
||||
Paragraph::new(Span::styled(" ↑↓ select enter view / search esc cancel ", grey)),
|
||||
area,
|
||||
);
|
||||
let mut spans = vec![Span::raw(" ")];
|
||||
spans.extend(key_hints(&[
|
||||
("↑↓", "select"),
|
||||
("↵", "view"),
|
||||
("/", "search"),
|
||||
("esc", "cancel"),
|
||||
]));
|
||||
frame.render_widget(Paragraph::new(Line::from(spans)), area);
|
||||
return;
|
||||
};
|
||||
|
||||
let prompt = format!(" /{query}");
|
||||
let spans = vec![
|
||||
Span::raw(prompt.clone()),
|
||||
Span::styled(" ↑↓ select enter view esc clear ", grey),
|
||||
];
|
||||
let mut spans = vec![Span::raw(prompt.clone()), Span::raw(KEY_GAP)];
|
||||
spans.extend(key_hints(&[("↑↓", "select"), ("↵", "view"), ("esc", "clear")]));
|
||||
frame.render_widget(Paragraph::new(Line::from(spans)), area);
|
||||
|
||||
// Held on the row, the way the search prompt's cursor is, so a query longer than the
|
||||
@@ -4142,6 +4221,77 @@ mod tests {
|
||||
render(board, width, height).pop().expect("no rows rendered")
|
||||
}
|
||||
|
||||
/// The cells of the footer row, as symbol, colour and modifier.
|
||||
///
|
||||
/// The row is the only place on the board where what a thing *is* is carried by its
|
||||
/// colour alone: the key merged into its description is one letter of a word, so the
|
||||
/// flattened row cannot say whether `quit` is a key or the tail of `ctrl-c quit`.
|
||||
fn footer_cells(
|
||||
board: &Board,
|
||||
width: u16,
|
||||
height: u16,
|
||||
) -> Vec<(String, ratatui::style::Color, Modifier)> {
|
||||
let mut terminal = Terminal::new(TestBackend::new(width, height)).unwrap();
|
||||
terminal.draw(|frame| draw(frame, board)).unwrap();
|
||||
let buffer = terminal.backend().buffer().clone();
|
||||
|
||||
let row = buffer.area.height - 1;
|
||||
(0..buffer.area.width)
|
||||
.map(|x| {
|
||||
let cell = &buffer[(x, row)];
|
||||
(cell.symbol().to_string(), cell.fg, cell.modifier)
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Where `text` starts on the footer, in cells.
|
||||
fn footer_at(cells: &[(String, ratatui::style::Color, Modifier)], text: &str) -> Option<usize> {
|
||||
let wanted: Vec<String> = text.chars().map(|c| c.to_string()).collect();
|
||||
|
||||
(0..=cells.len().saturating_sub(wanted.len())).find(|&at| {
|
||||
cells[at..at + wanted.len()]
|
||||
.iter()
|
||||
.zip(&wanted)
|
||||
.all(|((symbol, ..), c)| symbol == c)
|
||||
})
|
||||
}
|
||||
|
||||
/// How many cells the first `text` on the footer opens with in the key colour, and
|
||||
/// `None` when the row does not hold it at all.
|
||||
///
|
||||
/// One number answers both forms the row draws. Merged, `quit` is `Some(1)`: the `q`
|
||||
/// alone is a key and the rest of the word is description. Split, `ctrl-c quit` is
|
||||
/// `Some(6)`, and asking about `quit` on that row is `Some(0)` — the word is there and
|
||||
/// no part of it is a key. The flattened row cannot tell those two apart, since the
|
||||
/// split form contains the merged one, and which key quits from where is exactly what
|
||||
/// the tests below are about.
|
||||
fn keys_on(board: &Board, width: u16, height: u16, text: &str) -> Option<usize> {
|
||||
let cells = footer_cells(board, width, height);
|
||||
let at = footer_at(&cells, text)?;
|
||||
let key: ratatui::style::Color = Color::Cyan.into();
|
||||
|
||||
Some(
|
||||
cells[at..at + text.chars().count()]
|
||||
.iter()
|
||||
.take_while(|(_, colour, _)| *colour == key)
|
||||
.count(),
|
||||
)
|
||||
}
|
||||
|
||||
/// The colour and modifier the first cell of `text` reached the screen in.
|
||||
fn footer_style(
|
||||
board: &Board,
|
||||
width: u16,
|
||||
height: u16,
|
||||
text: &str,
|
||||
) -> (ratatui::style::Color, Modifier) {
|
||||
let cells = footer_cells(board, width, height);
|
||||
let at = footer_at(&cells, text).unwrap_or_else(|| panic!("no `{text}` on the footer"));
|
||||
let (_, colour, modifier) = cells[at].clone();
|
||||
|
||||
(colour, modifier)
|
||||
}
|
||||
|
||||
/// The overlay's top border row, where the block title sits.
|
||||
///
|
||||
/// Counted in characters rather than bytes: the rows carry multi-byte glyphs.
|
||||
@@ -5768,16 +5918,21 @@ mod tests {
|
||||
|
||||
let closed = render(&board, SCREEN.width, SCREEN.height).join("\n");
|
||||
assert!(closed.contains("↑↓ card"), "{closed}");
|
||||
assert!(closed.contains("enter detail"), "{closed}");
|
||||
assert!(closed.contains("↵ detail"), "{closed}");
|
||||
assert!(!closed.contains("scroll"), "a scroll offered with nothing open:\n{closed}");
|
||||
|
||||
assert!(closed.contains("q quit"), "nothing says how to leave:\n{closed}");
|
||||
// The merged form: the word alone, with `q` the only cell of it drawn as a key.
|
||||
assert_eq!(
|
||||
keys_on(&board, SCREEN.width, SCREEN.height, "quit"),
|
||||
Some(1),
|
||||
"nothing says how to leave:\n{closed}"
|
||||
);
|
||||
|
||||
board.toggle_detail();
|
||||
let open = render(&board, SCREEN.width, SCREEN.height).join("\n");
|
||||
assert!(open.contains("pgup/pgdn scroll"), "{open}");
|
||||
assert!(open.contains("select"), "{open}");
|
||||
assert!(open.contains("enter/q close"), "{open}");
|
||||
assert!(open.contains("↵/q close"), "{open}");
|
||||
}
|
||||
|
||||
/// The other half of giving `q` a second meaning. A footer that goes on saying
|
||||
@@ -5792,11 +5947,80 @@ mod tests {
|
||||
board.toggle_detail();
|
||||
|
||||
let row = footer(&board, 120, 20);
|
||||
assert!(row.contains("enter/q close"), "q is not named as the close key:\n{row}");
|
||||
assert!(!row.contains("q quit"), "q still offered as the quit key:\n{row}");
|
||||
assert!(row.contains("↵/q close"), "q is not named as the close key:\n{row}");
|
||||
// Nothing on the row is drawn as `q` quitting. Asked of the flattened row this is
|
||||
// unanswerable now: `ctrl-c quit` holds the word the merged form is.
|
||||
assert_eq!(
|
||||
keys_on(&board, 120, 20, "quit"),
|
||||
Some(0),
|
||||
"q still offered as the quit key:\n{row}"
|
||||
);
|
||||
// And the last slot still answers how to get out, which from here is the one
|
||||
// key that does it in a single press.
|
||||
assert!(row.contains("ctrl-c quit"), "nothing says what quits from here:\n{row}");
|
||||
// key that does it in a single press, split because `ctrl-c` is no word's letter.
|
||||
assert_eq!(
|
||||
keys_on(&board, 120, 20, "ctrl-c quit"),
|
||||
Some(6),
|
||||
"nothing says what quits from here:\n{row}"
|
||||
);
|
||||
}
|
||||
|
||||
/// The division the row is drawn on: the key carries the accent colour and the words
|
||||
/// beside it carry none. Everything else about which key is named where is text, and
|
||||
/// this is the one thing that is not.
|
||||
#[test]
|
||||
fn a_key_is_the_accent_colour_and_its_description_is_the_default_foreground() {
|
||||
let dir = board_dir();
|
||||
write_ticket(&dir, "backlog", "11111111-0000-4000-8000-000000000000", "First one", "");
|
||||
|
||||
let board = one_board(&dir);
|
||||
let key: ratatui::style::Color = Color::Cyan.into();
|
||||
|
||||
// Merged: the `q` of `quit` is the key and the rest of the word is not.
|
||||
let (colour, modifier) = footer_style(&board, 120, 20, "quit");
|
||||
assert_eq!(colour, key, "the key did not reach the screen as one");
|
||||
assert!(modifier.contains(Modifier::BOLD), "the key is not bold: {modifier:?}");
|
||||
|
||||
let (colour, modifier) = footer_style(&board, 120, 20, "uit");
|
||||
assert_eq!(
|
||||
colour,
|
||||
ratatui::style::Color::Reset,
|
||||
"the description took the key's colour"
|
||||
);
|
||||
assert!(!modifier.contains(Modifier::BOLD), "the description is bold: {modifier:?}");
|
||||
|
||||
// Split: the same division across two words instead of inside one.
|
||||
assert_eq!(footer_style(&board, 120, 20, "y copy id").0, key);
|
||||
assert_eq!(footer_style(&board, 120, 20, "copy id").0, ratatui::style::Color::Reset);
|
||||
}
|
||||
|
||||
/// The prompt and the picker take the row from the footer, and draw the keys they leave
|
||||
/// on it the way the footer does: a reader who has learnt where the coloured letter is
|
||||
/// does not learn it again per row.
|
||||
#[test]
|
||||
fn the_prompt_and_the_picker_draw_their_keys_as_the_footer_does() {
|
||||
let dir = board_dir();
|
||||
write_campaign(&dir, V1, "First public release", "v1", "For a public tag.");
|
||||
write_ticket(&dir, "backlog", "11111111-0000-4000-8000-000000000000", "First one", "");
|
||||
|
||||
let mut board = one_board(&dir);
|
||||
let key: ratatui::style::Color = Color::Cyan.into();
|
||||
|
||||
board.open_search();
|
||||
assert_eq!(footer_style(&board, 120, 20, "↵ jump").0, key, "the prompt's key");
|
||||
assert_eq!(
|
||||
footer_style(&board, 120, 20, "jump").0,
|
||||
ratatui::style::Color::Reset,
|
||||
"the prompt's description"
|
||||
);
|
||||
|
||||
board.search_key(typed(KeyCode::Esc), SCREEN);
|
||||
board.open_picker(PickerKind::Campaign, SCREEN);
|
||||
assert_eq!(footer_style(&board, 120, 20, "↵ view").0, key, "the picker's key");
|
||||
assert_eq!(
|
||||
footer_style(&board, 120, 20, "view").0,
|
||||
ratatui::style::Color::Reset,
|
||||
"the picker's description"
|
||||
);
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------- searching --
|
||||
@@ -5843,9 +6067,9 @@ mod tests {
|
||||
let screen = render(&board, SCREEN.width, SCREEN.height);
|
||||
let row = screen.last().expect("no rows rendered");
|
||||
|
||||
assert!(row.contains("enter jump"), "{row}");
|
||||
assert!(row.contains("↵ jump"), "{row}");
|
||||
assert!(row.contains("esc cancel"), "{row}");
|
||||
assert!(!row.contains("q quit"), "the key list survived the prompt:\n{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"
|
||||
@@ -6285,7 +6509,11 @@ mod tests {
|
||||
assert!(board.notice.is_none(), "the message outlived its keypress");
|
||||
// And the keys are back, rather than the row staying spent on a read message.
|
||||
let row = footer(&board, 120, 20);
|
||||
assert!(row.contains("q quit"), "the key list did not come back: {row}");
|
||||
assert_eq!(
|
||||
keys_on(&board, 120, 20, "quit"),
|
||||
Some(1),
|
||||
"the key list did not come back: {row}"
|
||||
);
|
||||
}
|
||||
|
||||
/// Both footers name it, since the key works with a ticket open as well.
|
||||
@@ -8216,14 +8444,23 @@ mod tests {
|
||||
let dir = board_dir();
|
||||
let mut board = tag_board(&dir);
|
||||
|
||||
// Both merged, being their own words' first letters.
|
||||
let plain = footer(&board, 120, 20);
|
||||
assert!(plain.contains("t tag"), "the tag key is not named: {plain}");
|
||||
assert!(plain.contains("c campaign"), "{plain}");
|
||||
assert_eq!(
|
||||
keys_on(&board, 120, 20, "tag"),
|
||||
Some(1),
|
||||
"the tag key is not named: {plain}"
|
||||
);
|
||||
assert_eq!(keys_on(&board, 120, 20, "campaign"), Some(1), "{plain}");
|
||||
|
||||
board.select_filter(Filter::Tag("bug".to_string()), SCREEN);
|
||||
let filtered = footer(&board, 120, 20);
|
||||
assert!(!filtered.contains("q board"), "the row repeated the frame: {filtered}");
|
||||
assert!(!filtered.contains("t tag"), "a key that filters again: {filtered}");
|
||||
assert_eq!(
|
||||
keys_on(&board, 120, 20, "tag"),
|
||||
None,
|
||||
"a key that filters again: {filtered}"
|
||||
);
|
||||
assert!(filtered.contains("ctrl-c quit"), "{filtered}");
|
||||
}
|
||||
|
||||
@@ -9196,7 +9433,7 @@ mod tests {
|
||||
assert!(row.contains("pgup/pgdn scroll"), "the scroll keys are not named:\n{row}");
|
||||
assert!(row.contains("y copy id"), "the copy key is not named:\n{row}");
|
||||
// Both do nothing here, so neither is offered.
|
||||
assert!(!row.contains("enter detail"), "enter is named and does nothing:\n{row}");
|
||||
assert!(!row.contains("↵ detail"), "↵ is named and does nothing:\n{row}");
|
||||
assert!(
|
||||
!row.contains("←→ column"),
|
||||
"the column keys are named and do nothing:\n{row}"
|
||||
@@ -9613,12 +9850,12 @@ mod tests {
|
||||
board.select_card(-1, SCREEN);
|
||||
|
||||
let row = footer(&board, 120, 20);
|
||||
assert!(row.contains("enter expand"), "enter is not named on the frame:\n{row}");
|
||||
assert!(row.contains("↵ expand"), "↵ is not named on the frame:\n{row}");
|
||||
|
||||
board.toggle_focused(SCREEN);
|
||||
let row = footer(&board, 120, 20);
|
||||
assert!(row.contains("enter collapse"), "enter still offered as expand:\n{row}");
|
||||
assert!(!row.contains("enter expand"), "the row names it both ways:\n{row}");
|
||||
assert!(row.contains("↵ collapse"), "↵ still offered as expand:\n{row}");
|
||||
assert!(!row.contains("↵ expand"), "the row names it both ways:\n{row}");
|
||||
}
|
||||
|
||||
/// Expanding and collapsing leave the reader where they were rather than at the top. The
|
||||
@@ -9889,7 +10126,7 @@ mod tests {
|
||||
assert!(row.contains("Move the store off one disk."), "{row:?}");
|
||||
// And the footer is the picker's while it is open, for the reason the prompt takes
|
||||
// it: the board's key list describes nothing that currently works.
|
||||
assert!(footer(&board, 100, 24).contains("enter view"), "the footer is the board's");
|
||||
assert!(footer(&board, 100, 24).contains("↵ view"), "the footer is the board's");
|
||||
}
|
||||
|
||||
/// A campaign with no codename shows the id once, not twice: the row already opens
|
||||
@@ -10378,12 +10615,12 @@ mod tests {
|
||||
let dir = board_dir();
|
||||
let mut board = campaign_board(&dir);
|
||||
|
||||
assert!(footer(&board, 120, 24).contains("c campaign"), "the key is unfindable");
|
||||
assert_eq!(keys_on(&board, 120, 24, "campaign"), Some(1), "the key is unfindable");
|
||||
|
||||
board.select_filter(Filter::Campaign(V1.to_string()), SCREEN);
|
||||
let footer = footer(&board, 120, 24);
|
||||
assert!(footer.contains("ctrl-c quit"), "q still claims to quit: {footer:?}");
|
||||
assert!(!footer.contains("q quit"), "{footer:?}");
|
||||
let row = footer(&board, 120, 24);
|
||||
assert!(row.contains("ctrl-c quit"), "q still claims to quit: {row:?}");
|
||||
assert_eq!(keys_on(&board, 120, 24, "quit"), Some(0), "{row:?}");
|
||||
}
|
||||
|
||||
/// The filter belongs to the tab, not the board: a campaign is resolved inside one
|
||||
|
||||
Reference in New Issue
Block a user