Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7994d98913 | ||
|
|
d1a0f0ee27 |
@@ -256,14 +256,18 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- **A campaign the board does not hold labels nothing**, the answer `mark_blocked` gives a dangling blocker. `campaign_cells` renders that case as `_missing_` because a metadata table is a place to report a dangling reference; a card is not
|
||||
- **`c` opens the campaign picker, and taking a campaign filters the tab's columns to its members.** Not a fifth tab: a campaign groups across the flow, so the shape of the answer is the statuses with fewer cards in them, which is what `campaign show` already answers the question in. Every column is kept, empty ones included. The filter is applied in `reload`, where the columns are built, so nothing downstream has to ask whether a campaign is selected — the board simply holds fewer cards, and `first_match`, `column_count` and the copy key all keep working unchanged
|
||||
- **`Tab::campaign` is a uuid on the tab, not on the `Board`.** A campaign belongs to one `.worklane`, so a filter carried onto another project's tab would empty it and say nothing about why. It is looked up by uuid rather than held as an index, and a selection whose campaign has left the board is cleared by `reload` rather than left filtering the board to nothing
|
||||
- **The frame above the columns has two heights, and `Chrome` is what every measurement takes.** `Chrome::campaign` is an `Option<FrameSize>`, not a bool: `None` for a tab showing the whole board, and `Collapsed` or `Expanded` for one filtered to a campaign, because both heights have to be measured the same way by everything that measures the board. `frame_rows` grew a row, so the two bools that decide the geometry became one `Chrome`, copied from `Board::chrome`: adjacent same-typed parameters are what the Rust Style rule warns about, and the draw and `follow_selection` have to measure one answer or a keypress scrolls against a board the next frame does not draw. The row indices are named (`TAB_ROW`, `CAMPAIGN_ROW`, `BOARD_ROW`, `FOOTER_ROW`), since an index written out by hand goes on meaning what it used to
|
||||
- **The frame above the columns has two heights, and `Chrome` is what every measurement takes.** `Chrome::frame` is an `Option<FrameSize>`, not a bool: `None` for a tab showing the whole board, and `Collapsed` or `Expanded` for one filtered to a campaign or a tag, because both heights have to be measured the same way by everything that measures the board. `screen_rows` grew a row, so the two bools that decide the geometry became one `Chrome`, copied from `Board::chrome`: adjacent same-typed parameters are what the Rust Style rule warns about, and the draw and `follow_selection` have to measure one answer or a keypress scrolls against a board the next frame does not draw. The row indices are named (`TAB_ROW`, `FRAME_ROW`, `BOARD_ROW`, `FOOTER_ROW`), since an index written out by hand goes on meaning what it used to. **Nothing in the geometry is named after campaigns**, because the slot is the tag filter's too: `Chrome::frame` says how tall the frame is and never which filter filled it, so a measurement of the board never has to ask
|
||||
- **The whole description is carried off the one read, and the cut is on the view.** `section_prose` replaced `section_opening`, which cut to the opening line at read time: the campaign file is only in hand while the campaigns directory is being read, so what that read has to carry is everything a view might want, and `CampaignRow::summary` takes the one line the picker draws back off it. Two fields, one cut from the other, are two strings free to come from different reads of the same file
|
||||
- **`CAMPAIGN_PROSE_ROWS` is the collapsed height, and it is a constant rather than a height fitted to the description.** Three rows of prose plus a border either side. A frame that grew and shrank with the campaign would resize every column whenever the filter changed, and a reader would look for a card where the previous campaign's description had put it. It does not have to be right for the longest description, because scrolling is what covers the rest — which is also why three was affordable where one row was not
|
||||
- **The expanded height is a share, not a second constant: half of what the frame and the columns divide.** That is the screen less the tab row and the footer, so the split is even between the two of them rather than even against rows neither gets all of. Half rather than most of it for the same reason the frame is not an overlay: the columns below are the campaign's members, and a reader inspecting the campaign has to go on seeing what it is made of. Floored, so the odd row goes to the cards. `Chrome::campaign_rows` takes the height because of this, and `frame_rows` is where it is called, since that is the one place that already has an area to take a share of — which is what keeps `Chrome` itself pure and copyable from `Board::chrome` with no screen to hand
|
||||
- **The share is bounded at both ends, and `COLUMN_MIN_ROWS` is why.** `Constraint::Min(COLUMN_MIN_ROWS)` would take rows back from a frame that asked for too many, silently, and the frame's own measurement would then disagree with what is drawn — the fault `Chrome` exists to prevent. So the share is capped at what leaves the columns those rows, and floored at `CAMPAIGN_ROWS`, since expanding must never shrink the frame. On a board too short to divide, `enter` gives the collapsed height back rather than a height nothing measured. `the_expanded_share_is_bounded_at_both_ends` sweeps every height from 4 to 60, tabbed and not, because one screen that happens to work says nothing about the arithmetic
|
||||
- **`FRAME_PROSE_ROWS` is the collapsed height, and it is a constant rather than a height fitted to the description.** Three rows of prose plus a border either side. A frame that grew and shrank with the campaign would resize every column whenever the filter changed, and a reader would look for a card where the previous campaign's description had put it. It does not have to be right for the longest description, because scrolling is what covers the rest — which is also why three was affordable where one row was not
|
||||
- **The expanded height is a share, not a second constant: half of what the frame and the columns divide.** That is the screen less the tab row and the footer, so the split is even between the two of them rather than even against rows neither gets all of. Half rather than most of it for the same reason the frame is not an overlay: the columns below are the campaign's members, and a reader inspecting the campaign has to go on seeing what it is made of. Floored, so the odd row goes to the cards. `Chrome::frame_rows` takes the height because of this, and `screen_rows` is where it is called, since that is the one place that already has an area to take a share of — which is what keeps `Chrome` itself pure and copyable from `Board::chrome` with no screen to hand
|
||||
- **The share is bounded at both ends, and `COLUMN_MIN_ROWS` is why.** `Constraint::Min(COLUMN_MIN_ROWS)` would take rows back from a frame that asked for too many, silently, and the frame's own measurement would then disagree with what is drawn — the fault `Chrome` exists to prevent. So the share is capped at what leaves the columns those rows, and floored at `FRAME_ROWS`, since expanding must never shrink the frame. On a board too short to divide, `enter` gives the collapsed height back rather than a height nothing measured. `the_expanded_share_is_bounded_at_both_ends` sweeps every height from 4 to 60, tabbed and not, because one screen that happens to work says nothing about the arithmetic
|
||||
- **The frame says the rest of what it has to say on its borders**, the trade the detail overlay makes with its title and its page indicator: `(id) ~codename · Name` on the top one, the standing on the bottom right, and `q board` then the page indicator on the bottom left. Every row spent here is a row of cards
|
||||
- **The frame's page indicator goes on the bottom border beside `q board`, not on the top beside the title.** The title is cut against the border it sits 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 the indicator is only where the reader has got to in it. Dropped before `q board` when the two cannot both fit, since with a campaign selected the footer's last slot names `ctrl-c quit` and the border is the only place that says `q` gives the board back
|
||||
- **`Focus` is the third place the selection can be, and `Tab` is what holds it.** The board had a column and a card and `select_card` clamped at zero; up from the top card now reaches the frame and down returns to the column it left, since the column index is never what changed. Per tab beside the filter and the offset, so switching away and back returns to where the tab was left. `Focus::Frame` while no campaign is selected is the one state that must never exist — `select_campaign` and `reload` are what keep it from arising
|
||||
- **The frame slot is shared between the two filters, not doubled.** One filter is on at a time, per `Filter`, so a tag frame is the campaign frame with its three slots filled differently: `#tag` in `tag_color` on the top border where the campaign's identity goes, how many tickets carry it on the bottom right where the standing goes, and the annotation in the prose rows. `FrameContent` is what the two are told apart into, and **`frame_content` is the one place they are told apart at all** — the borders, the colour, `q board`, the page indicator, the scroll and the focus are all the campaign frame's, and a second `match` on the filter below that is how the two frames come to behave differently in a way nobody decided
|
||||
- **A tag frame draws the annotation, which is the payoff for declaring a tag.** Whoever is browsing a tag is deciding whether the next ticket belongs in it, and the sentence saying when the tag is appropriate is then on the screen at that moment rather than in `tags.md`, which they would have to know to open. An undeclared tag draws `NO_ANNOTATION` in grey, which is also the frame saying the word was never agreed on — the vocabulary file's own placeholder rather than the description section's, so the frame and the file say the same thing about the same tag. A tag declared with nothing said about it draws the same, since here the two have the same nothing to show; the picker's sections are where the difference is actionable
|
||||
- **A tag has no id, so `y` on its frame copies the word.** A tag *is* its name, matched whole by `ls --tag`, so there are no seven characters to shorten and the `#` the border draws is not part of it — `--tag "#bug"` matches nothing. The footer says `y copy tag` there for the same reason: naming it an id would send the reader looking for a short id on a border that prints a word
|
||||
- **The count on a tag frame is every column's, drawn or not**, the rule the standing holds. With the filter on, those columns *are* the tickets carrying the tag, so it counts what is below it without counting it a second way. The noun is spelled out and pluralised, because a bare number on a border says nothing about what was counted, and there is no derived state beside it: a tag is a word and not a piece of work, so there is no `[open]` to be in
|
||||
- **The frame's page indicator goes on the bottom border beside `q board`, not on the top beside the title.** The title is cut against the border it sits 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 the indicator is only where the reader has got to in it. Dropped before `q board` when the two cannot both fit, since with either filter on the footer's last slot names `ctrl-c quit` and the border is the only place that says `q` gives the board back
|
||||
- **`Focus` is the third place the selection can be, and `Tab` is what holds it.** The board had a column and a card and `select_card` clamped at zero; up from the top card now reaches the frame and down returns to the column it left, since the column index is never what changed. Per tab beside the filter and the offset, so switching away and back returns to where the tab was left. `Focus::Frame` while no filter is on is the one state that must never exist — `select_filter` and `reload` are what keep it from arising, off `Filter::is_whole` rather than off which filter it is, since either draws a frame to hold it
|
||||
- **`Tab::selected` hands back nothing while the frame holds the selection.** Every key that acts on a card has to answer for the frame. `←→` are inert, because the frame spans the width of the board and moving the column underneath would change nothing on screen. `y` is the exception that earns its place: it copies the campaign's short id, so `y copy id` means the id of the selected thing in every state the selection can be in. No card is drawn reversed there either, since that highlight is what says which ticket a key is about
|
||||
- **`enter` routes on the focus through `Board::toggle_focused`: the frame's height on the frame, the overlay on a card.** It used to be inert on the frame for free, because `Tab::selected` hands back nothing and `toggle_detail` therefore had nothing to open. That is no longer an answer, and the routing is in `Board` rather than in the `main.rs` arm for the reason `dismiss` and `scroll_page` are
|
||||
- **`q` does not gain a layer for the expanded frame, and up and down do not take it back.** The expanded frame is the frame at its other height, not a thing laid over the board, so `q` goes on taking the campaign filter off from either height and `enter` is the only key that undoes what `enter` did. The height outlives the selection for the same reason: it is a view of the campaign the reader chose, so the columns stay short with the selection on a card. `Tab::expanded` sits beside the filter and resets where `select_campaign` and `reload` reset the focus and the offset — a different campaign opens collapsed and at the top of its own description
|
||||
@@ -271,8 +275,8 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- **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
|
||||
- **`c` is named in the footer only on a closed board with nothing selected**, which is where a reader has to find it. Over an open ticket and on a filtered board it is left out: the frame's border then says how to put the campaign away, and the row has no cells to spare. 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`, 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
|
||||
- **`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
|
||||
- **`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
|
||||
@@ -338,7 +342,11 @@ and this file is for what someone changing worklane's own code needs.
|
||||
|
||||
### The Relations Block
|
||||
- **One builder, two painters.** `relation_rows` decides which edges there are, what they are called and which direction comes first; `relation_cells` decides the layout, the mark and the colours; `paint_cells` turns cells into escapes for the CLI and `span_of` turns the same cells into ratatui spans for the board. Two builders producing one block in two shapes is a pair free to disagree about ordering or padding, which is what this shape exists to prevent
|
||||
- **`Cell` is the unit both renderers take**: a run of text and the colour it is drawn in, `None` for the default foreground. The same trick as the palette itself, where `Color::ansi()` and `From<Color> for ratatui::style::Color` keep one colour from existing for one renderer and not the other
|
||||
- **`Cell` is the unit both renderers take**: a run of text, the colour it is drawn in and the modifier it carries, `None` for the default foreground and for text drawn as it stands. The same trick as the palette itself, where `Color::ansi()` and `From<Color> for ratatui::style::Color` keep one colour from existing for one renderer and not the other, and `Modifier` is that trick a second time for the styles that are not colours
|
||||
- **`Modifier` is the first style on a cell that is not a colour**, and it is an enum with one variant for the reason the palette is one: `Modifier::ansi()` is SGR 9 and `From<Modifier> for ratatui::style::Modifier` is `CROSSED_OUT`, so a style that exists for one renderer and not the other is a compile error. Bold is not in it, because bold rides inside `Color::Magenta.ansi()` and `span_from` adds it back from the colour alone; a second modifier goes here beside the strike. It is independent of the colour, so a struck run keeps whatever colour its column already gave it
|
||||
- **`Cell::struck` is a builder, not a third constructor.** The strike is decided a whole row at a time and the cells of that row are built by the layout that already chose their colours, so `relation_cells` maps it over the row it has just finished rather than threading the decision through every cell it makes
|
||||
- **`RESET` is a constant both writers share.** `paint` opens a colour and `paint_cell` may open a modifier ahead of one, and a reset that only knew about the colour would leave the strike running to the end of the line
|
||||
- **`Body::push_cell` merges on the whole style, not the colour alone.** Nothing outside the relations block carries a modifier today, and a merge keyed on the colour would silently strike a plain run through the moment one did
|
||||
- **`reference_cells` is the one spelling of a cross reference.** The relations block and the Campaign field both go through it, so a dangling reference reads the same way wherever it is shown. There was a `reference_cell` beside it that painted the cells for the CLI; once the whole body became cells the Campaign field stopped needing a string and it was the last caller, so it is gone
|
||||
- **A row carries two marks, kind then status**: what sort of edge this is, then how far the ticket at the other end has got. `blocked by × ◐ (6ce2c47) Title`. Two questions are asked of this block and one glyph could not answer both: which rows hold this ticket up, and whether the ones that do are finished
|
||||
- The status went through one bad shape first. It was a rising bar, `▁▄▆█`, as the only mark, which read as an undifferentiated column of blocks and left the kind to five long words that blur when a ticket carries several. Then the kind took the column alone and the status was lost. Both, in that order, is the answer
|
||||
@@ -379,7 +387,7 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- `Card` wraps a `TicketItem` with the project it came from, `Some` only on the merge tab. Decided at reload rather than passed down to `card_lines` as a "which tab is this" flag. `TicketItem` is therefore `Clone`: the merge holds a second copy rather than re-reading every tree
|
||||
- **The project follows the id, on the card and on the overlay border.** Across boards the id is not an address: two projects can hold the same title, and seven characters do not say where they live. `project_label` takes what the row has left after the mark and the id and ends in an ellipsis, and it is measured before the due date, so on the merge the project wins the narrow column and the date is what `corner_line` drops
|
||||
- `tab` and `shift+tab` cycle rather than clamp, unlike the cards and columns: a row of tabs is a ring, and there is no end of a list to run off. Both were free of every other binding — the columns took `hjkl` and the arrows
|
||||
- **The tab row is drawn only when there is more than one board**, so a single board is the view it has always been. `frame_rows()` gives it `Length(0)` otherwise, which keeps the row indices the same for both cases and is shared with `card_width` and `column_text_height` for the reason `column_areas` is: geometry reproduced by hand drifts from the draw
|
||||
- **The tab row is drawn only when there is more than one board**, so a single board is the view it has always been. `screen_rows()` gives it `Length(0)` otherwise, which keeps the row indices the same for both cases and is shared with `card_width` and `column_text_height` for the reason `column_areas` is: geometry reproduced by hand drifts from the draw
|
||||
- `digest_of` hashes each board's `digest` into one value, so a change in any of them redraws. Do not watch only the first
|
||||
|
||||
### Who Wrote an Entry
|
||||
@@ -457,6 +465,8 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- Priority ramp → brightred (1), red (2), orange (3), cyan (4), grey (5). Green is deliberately absent: it means title
|
||||
- Relation kind mark → brightred `×` blocked by and blocks, cyan `→` relates to, orange `←` regression of and regressed by. A small ramp inside one column, the way the priority meter is: the mark says which kind of edge the row is, so none of these three is a colour standing in for the uuid or the title beside it. Brightred on the cross rather than red, because the id one cell to its right is red and the two would blend. It is the colour and the glyph a held-up card already carries, which is the point: one vocabulary for blocking
|
||||
- Relation status mark → grey `○` backlog, orange `◐` committed, cyan `◐` reviewing, green `●` done, grey `●` discarded, grey `?` for a target the board does not hold. Discarded takes the full circle of done in the grey of the untouched pile: nothing is left to do, and it is not an achievement. The *pair* is what has to be unique, which is the same bargain the two half circles already take, and `every_status_has_a_mark` pins it against `status_dirs`. The second ramp in that column: the shape says how far the target has got and the colour tells the two middle stages apart, since both are half circles. **Green is here and deliberately absent from the priority ramp**, where it would sit on a whole line and read as a title; on a one-cell mark with no title behind it, it is the obvious colour for finished and nothing else wants it. Orange keeps the meaning it already has, Status, and grey keeps unset for the one row with no status to show
|
||||
- **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, 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
|
||||
|
||||
Generated
+1
-1
@@ -1503,7 +1503,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "worklane"
|
||||
version = "0.31.3"
|
||||
version = "0.31.5"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"assert_cmd",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "worklane"
|
||||
version = "0.31.3"
|
||||
version = "0.31.5"
|
||||
edition = "2024"
|
||||
|
||||
[dependencies]
|
||||
|
||||
@@ -231,6 +231,10 @@ pair shares a glyph, and **your output is a pipe, so you do not get the colour**
|
||||
`◐` as under way and `●` as nothing left to do, and if it matters which of the two,
|
||||
`worklane show` on that target says so in its Status field. `○` is unambiguous without it.
|
||||
|
||||
A row pointing at a **discarded** target is struck through on a terminal, since a
|
||||
relation to abandoned work otherwise reads as a live dependency. That is a style rather
|
||||
than a character, so a pipe does not get it either: ask the target's Status field.
|
||||
|
||||
## Campaigns
|
||||
|
||||
A campaign groups the tickets that have to be finished together: a release, a migration,
|
||||
|
||||
+765
-200
File diff suppressed because it is too large
Load Diff
+257
-14
@@ -245,13 +245,55 @@ impl From<Color> for ratatui::style::Color {
|
||||
}
|
||||
}
|
||||
|
||||
/// The escape that closes a run, whatever was opened: a colour, a modifier or both.
|
||||
///
|
||||
/// One spelling for the two writers. `paint` opens a colour and `paint_cell` may open a
|
||||
/// modifier ahead of it, and a reset that only knew about the colour would leave the
|
||||
/// strikethrough running to the end of the line.
|
||||
pub const RESET: &str = "\x1b[0m";
|
||||
|
||||
/// A style that is not a colour, which is the other half of what a [`Cell`] carries.
|
||||
///
|
||||
/// An enum with one variant rather than a `bool`, for the reason the palette is an enum:
|
||||
/// the CLI needs an SGR sequence and the board needs a `ratatui` modifier, so a style
|
||||
/// that exists for one renderer and not the other is a compile error. Bold is not here,
|
||||
/// because bold rides inside `Color::Magenta.ansi()` and is added back on the board's
|
||||
/// side from the colour alone; a second modifier would be added here beside this one.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum Modifier {
|
||||
/// What a row about a discarded ticket is drawn with: the relation is still
|
||||
/// recorded, and no longer stands for anything.
|
||||
Strikethrough,
|
||||
}
|
||||
|
||||
impl Modifier {
|
||||
/// The SGR sequence the CLI writes. Closed by [`RESET`], like a colour.
|
||||
pub fn ansi(self) -> &'static str {
|
||||
match self {
|
||||
Modifier::Strikethrough => "\x1b[9m",
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The same modifier as ratatui sees it, the other half of [`Modifier::ansi`].
|
||||
///
|
||||
/// SGR 9 and `CROSSED_OUT` are the same request, so the two renderers cannot come to
|
||||
/// draw one struck row and one plain one.
|
||||
impl From<Modifier> for ratatui::style::Modifier {
|
||||
fn from(modifier: Modifier) -> Self {
|
||||
match modifier {
|
||||
Modifier::Strikethrough => ratatui::style::Modifier::CROSSED_OUT,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// `color_text` with the decision passed in rather than asked for.
|
||||
///
|
||||
/// The seam matters for anything that aligns columns: a caller has to be able to
|
||||
/// render both ways in one process to prove the padding does not depend on it.
|
||||
pub fn paint(text: &str, color: Color, enabled: bool) -> String {
|
||||
if enabled {
|
||||
format!("{}{}{}", color.ansi(), text, "\x1b[0m")
|
||||
format!("{}{}{}", color.ansi(), text, RESET)
|
||||
} else {
|
||||
text.to_string()
|
||||
}
|
||||
@@ -722,11 +764,15 @@ impl Body {
|
||||
self.push_cell(Cell::plain(c.to_string()));
|
||||
}
|
||||
|
||||
/// One run, merged into the trailing cell when it is the same colour.
|
||||
/// One run, merged into the trailing cell when it is drawn the same way.
|
||||
///
|
||||
/// Merging is not an optimisation. The board draws a span per cell, and the body is
|
||||
/// pushed a character at a time in places, so without this a plain line arrives as
|
||||
/// forty single-character spans for ratatui to wrap.
|
||||
///
|
||||
/// On the whole style and not the colour alone: nothing outside the relations block
|
||||
/// carries a modifier today, and a merge keyed on the colour would silently strike a
|
||||
/// plain run through the moment one did.
|
||||
fn push_cell(&mut self, cell: Cell) {
|
||||
if cell.text.is_empty() {
|
||||
return;
|
||||
@@ -734,7 +780,9 @@ impl Body {
|
||||
|
||||
match self.parts.last_mut() {
|
||||
Some(BodyPart::Cells(cells)) => match cells.last_mut() {
|
||||
Some(last) if last.color == cell.color => last.text.push_str(&cell.text),
|
||||
Some(last) if last.color == cell.color && last.modifier == cell.modifier => {
|
||||
last.text.push_str(&cell.text)
|
||||
}
|
||||
_ => cells.push(cell),
|
||||
},
|
||||
_ => self.parts.push(BodyPart::Cells(vec![cell])),
|
||||
@@ -2268,13 +2316,38 @@ pub fn reference_cells(uuid: &str, name: Option<&str>) -> Vec<Cell> {
|
||||
|
||||
/// Cells as the CLI prints them: each one painted, or carried through as it stands.
|
||||
pub fn paint_cells(cells: &[Cell], colored: bool) -> String {
|
||||
cells
|
||||
.iter()
|
||||
.map(|cell| match cell.color {
|
||||
Some(color) => paint(&cell.text, color, colored),
|
||||
None => cell.text.clone(),
|
||||
})
|
||||
.collect()
|
||||
cells.iter().map(|cell| paint_cell(cell, colored)).collect()
|
||||
}
|
||||
|
||||
/// One cell as an escape sequence, its modifier ahead of its colour and one [`RESET`]
|
||||
/// closing both.
|
||||
///
|
||||
/// The modifier is under the same flag the colour is, so a piped `show` and the board's
|
||||
/// own unpainted pass carry no escape at all, per the guideline: a function that takes
|
||||
/// an `enabled` flag has to use it all the way down. The cost is that a pipe cannot see
|
||||
/// a struck row, the same bargain committed and reviewing already take for being told
|
||||
/// apart by colour alone.
|
||||
fn paint_cell(cell: &Cell, colored: bool) -> String {
|
||||
if !colored {
|
||||
return cell.text.clone();
|
||||
}
|
||||
|
||||
// Built rather than matched over the four combinations: either half may be absent,
|
||||
// and a cell with neither has to come back byte for byte as it went in, since the
|
||||
// CLI's output is pinned against what it printed before the cells conversion.
|
||||
let mut opened = String::new();
|
||||
if let Some(modifier) = cell.modifier {
|
||||
opened.push_str(modifier.ansi());
|
||||
}
|
||||
if let Some(color) = cell.color {
|
||||
opened.push_str(color.ansi());
|
||||
}
|
||||
|
||||
if opened.is_empty() {
|
||||
return cell.text.clone();
|
||||
}
|
||||
|
||||
format!("{opened}{}{RESET}", cell.text)
|
||||
}
|
||||
|
||||
/// The mark a blocking relation carries, and a card waiting on one.
|
||||
@@ -2395,19 +2468,39 @@ pub struct RelationTarget {
|
||||
pub struct Cell {
|
||||
pub text: String,
|
||||
pub color: Option<Color>,
|
||||
/// The style that is not the colour, `None` for text drawn as it stands. Kept
|
||||
/// beside the colour rather than folded into it: a struck run keeps whatever colour
|
||||
/// its column already gave it, so the two are independent.
|
||||
pub modifier: Option<Modifier>,
|
||||
}
|
||||
|
||||
impl Cell {
|
||||
pub fn plain(text: impl Into<String>) -> Self {
|
||||
Cell { text: text.into(), color: None }
|
||||
Cell {
|
||||
text: text.into(),
|
||||
color: None,
|
||||
modifier: None,
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn colored(text: impl Into<String>, color: Color) -> Self {
|
||||
Cell {
|
||||
text: text.into(),
|
||||
color: Some(color),
|
||||
modifier: None,
|
||||
}
|
||||
}
|
||||
|
||||
/// The same cell, struck through.
|
||||
///
|
||||
/// A builder rather than a third constructor, because the strike is decided a whole
|
||||
/// row at a time and the cells of that row are built by the layout that already
|
||||
/// chose their colours. `relation_cells` maps this over the row it has just built,
|
||||
/// so nothing has to thread the decision through every cell it makes.
|
||||
pub(crate) fn struck(mut self) -> Self {
|
||||
self.modifier = Some(Modifier::Strikethrough);
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
/// The relations of one ticket, both directions, in the order they are shown.
|
||||
@@ -2468,8 +2561,8 @@ pub fn relation_cells(rows: &[RelationRow]) -> Vec<Vec<Cell>> {
|
||||
rows.iter()
|
||||
.map(|row| {
|
||||
let (kind, kind_colour) = relation_mark(row.kind);
|
||||
let (status, status_colour) =
|
||||
status_mark(row.target.as_ref().map(|target| target.status.as_str()));
|
||||
let status_of = row.target.as_ref().map(|target| target.status.as_str());
|
||||
let (status, status_colour) = status_mark(status_of);
|
||||
let padding = " ".repeat(width - row.label.chars().count());
|
||||
|
||||
// Kind, then state, then who: what sort of edge this is, how far the ticket
|
||||
@@ -2489,7 +2582,16 @@ pub fn relation_cells(rows: &[RelationRow]) -> Vec<Vec<Cell>> {
|
||||
row.target.as_ref().map(|target| target.title.as_str()),
|
||||
));
|
||||
|
||||
cells
|
||||
// The whole row, gutter and padding included, so the line runs unbroken from
|
||||
// the label to the end of the title. The strike is what says the target was
|
||||
// discarded, since the status mark cannot: it is one cell in a column of five
|
||||
// states, and a row pointing at abandoned work otherwise reads as a live
|
||||
// dependency, which is exactly what it is not. The relation stays recorded,
|
||||
// for completeness and for the case the target is moved back out.
|
||||
match status_of {
|
||||
Some(DISCARDED) => cells.into_iter().map(Cell::struck).collect(),
|
||||
_ => cells,
|
||||
}
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
@@ -5236,9 +5338,150 @@ Plain line with **bold** and a [link](http://x.test/a).
|
||||
assert_eq!(status_mark(Some("committed")), ("\u{25d0}", Color::Orange));
|
||||
assert_eq!(status_mark(Some("reviewing")), ("\u{25d0}", Color::Cyan));
|
||||
assert_eq!(status_mark(Some("done")), ("\u{25cf}", Color::Green));
|
||||
assert_eq!(status_mark(Some("discarded")), ("\u{25cf}", Color::Grey));
|
||||
assert_eq!(status_mark(None), ("?", Color::Grey));
|
||||
}
|
||||
|
||||
/// The strike is what says the target will never be done, because the status mark
|
||||
/// cannot: it is one cell in a column of five states, and a row pointing at abandoned
|
||||
/// work otherwise reads as a live dependency, which is exactly what it is not.
|
||||
///
|
||||
/// On every cell of the row, gutter and padding included, so the line runs unbroken
|
||||
/// from the label to the end of the title. A cell left out would draw a gap.
|
||||
#[test]
|
||||
fn a_row_pointing_at_a_discarded_target_is_struck_through() {
|
||||
let rows = vec![row(
|
||||
RelationKind::BlockedBy,
|
||||
"blocked by",
|
||||
TARGET,
|
||||
"Dropped",
|
||||
DISCARDED,
|
||||
)];
|
||||
let cells = relation_cells(&rows);
|
||||
|
||||
assert_eq!(cells.len(), 1, "{cells:?}");
|
||||
for cell in &cells[0] {
|
||||
assert_eq!(
|
||||
cell.modifier,
|
||||
Some(Modifier::Strikethrough),
|
||||
"{:?} is not struck, so the line breaks mid row",
|
||||
cell.text
|
||||
);
|
||||
}
|
||||
|
||||
// Every run opened, since a cell is closed by its own reset: the CLI writes one
|
||||
// `\x1b[9m` per cell or the strike stops at the first colour change.
|
||||
let rendered = render_relations(&rows, true);
|
||||
assert_eq!(
|
||||
rendered.matches(Modifier::Strikethrough.ansi()).count(),
|
||||
cells[0].len(),
|
||||
"the CLI did not open the strike on every run:\n{rendered:?}"
|
||||
);
|
||||
}
|
||||
|
||||
/// Only discarded. A row to a live target is drawn as it always was, done included:
|
||||
/// the strike says the relation no longer stands for anything, and a blocker that
|
||||
/// landed still stands for the fact that it was one.
|
||||
///
|
||||
/// Over `status_dirs` rather than the four names, so a status added later is decided
|
||||
/// here rather than inheriting the strike or the plain row by accident.
|
||||
#[test]
|
||||
fn a_row_to_a_live_target_is_not_struck() {
|
||||
let live = status_dirs().into_iter().filter(|status| *status != DISCARDED);
|
||||
|
||||
for status in live {
|
||||
let rows = vec![row(
|
||||
RelationKind::BlockedBy,
|
||||
"blocked by",
|
||||
TARGET,
|
||||
"Alive",
|
||||
status,
|
||||
)];
|
||||
|
||||
for cell in relation_cells(&rows).concat() {
|
||||
assert_eq!(cell.modifier, None, "{status} is struck: {:?}", cell.text);
|
||||
}
|
||||
assert!(
|
||||
!render_relations(&rows, true).contains(Modifier::Strikethrough.ansi()),
|
||||
"{status} is struck through in show"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/// A target the board no longer holds is not struck either. `?` and `_missing_` say
|
||||
/// the row cannot be resolved, which is a different fact from a target that was
|
||||
/// resolved and abandoned, and striking both would fold the two together.
|
||||
#[test]
|
||||
fn a_row_to_a_missing_target_is_not_struck() {
|
||||
let rows = vec![RelationRow {
|
||||
kind: RelationKind::BlockedBy,
|
||||
label: "blocked by",
|
||||
uuid: TARGET.to_string(),
|
||||
target: None,
|
||||
}];
|
||||
|
||||
for cell in relation_cells(&rows).concat() {
|
||||
assert_eq!(cell.modifier, None, "{:?}", cell.text);
|
||||
}
|
||||
}
|
||||
|
||||
/// Paired the way the guideline demands, and both halves are load bearing. The strike
|
||||
/// is an escape sequence like a colour, so it is under the same flag: a piped `show`
|
||||
/// carries none of it, the same bargain committed and reviewing already take for
|
||||
/// being told apart by colour alone. A renderer that never struck anything would pass
|
||||
/// the absence on its own.
|
||||
#[test]
|
||||
fn the_strike_is_under_the_colour_flag_like_every_other_escape() {
|
||||
let rows = vec![row(
|
||||
RelationKind::BlockedBy,
|
||||
"blocked by",
|
||||
TARGET,
|
||||
"Dropped",
|
||||
DISCARDED,
|
||||
)];
|
||||
|
||||
assert!(
|
||||
render_relations(&rows, true).contains(Modifier::Strikethrough.ansi()),
|
||||
"nothing was struck at all, so the guard below is vacuous"
|
||||
);
|
||||
assert!(
|
||||
!render_relations(&rows, false).contains('\x1b'),
|
||||
"an escape survived the colour being off: {:?}",
|
||||
render_relations(&rows, false)
|
||||
);
|
||||
}
|
||||
|
||||
/// Both halves of the modifier, the way the palette is pinned from both ends. SGR 9
|
||||
/// and `CROSSED_OUT` are the same request, so one renderer cannot come to draw a
|
||||
/// struck row plain while the other strikes it.
|
||||
#[test]
|
||||
fn the_strikethrough_is_the_same_request_in_both_renderers() {
|
||||
assert_eq!(Modifier::Strikethrough.ansi(), "\x1b[9m");
|
||||
assert_eq!(
|
||||
ratatui::style::Modifier::from(Modifier::Strikethrough),
|
||||
ratatui::style::Modifier::CROSSED_OUT
|
||||
);
|
||||
}
|
||||
|
||||
/// The modifier opens ahead of the colour and one reset closes both, which is why the
|
||||
/// reset is a constant the two writers share. A cell carrying neither comes back byte
|
||||
/// for byte as it went in, since the CLI's output is pinned against what it printed
|
||||
/// before the cells conversion.
|
||||
#[test]
|
||||
fn a_cell_opens_its_modifier_ahead_of_its_colour_and_closes_once() {
|
||||
let struck_and_coloured = Cell::colored("x", Color::Red).struck();
|
||||
assert_eq!(
|
||||
paint_cells(&[struck_and_coloured], true),
|
||||
format!("\x1b[9m\x1b[31mx{RESET}")
|
||||
);
|
||||
|
||||
let struck_only = Cell::plain("x").struck();
|
||||
assert_eq!(paint_cells(&[struck_only], true), format!("\x1b[9mx{RESET}"));
|
||||
|
||||
assert_eq!(paint_cells(&[Cell::plain("x")], true), "x");
|
||||
assert_eq!(paint_cells(&[Cell::plain("x").struck()], false), "x");
|
||||
}
|
||||
|
||||
/// Every status the board holds is told apart from the other three. The shape does
|
||||
/// not do it alone, since committed and reviewing are both half circles, so it is the
|
||||
/// pair that has to be unique. Pinned against `status_dirs` rather than the four
|
||||
|
||||
Reference in New Issue
Block a user