Compare commits

..
4 Commits
Author SHA1 Message Date
Ansho Rei 8e7a3f1425 Fix tags in tui on narrow screen, and bump to 0.33.9 2026-11-06 17:45:49 +01:00
Ansho ReiandClaude Opus 5 fbd752afc9 (8a7fe6c) Read a flag by either spelling, on the prompt and in the fish rules, and bump to 0.33.8
`:mv --status ` offered the five statuses on the board and `:mv -s `
offered nothing: argument_at read the typed word with strip_prefix("--"),
so a word spelled with one hyphen was not a flag to it and fell through to
the positional arm, which counted a position that was not there.

long_name translates the letter through the command that holds the flag, so
the tables stay keyed on the long name and nothing here keeps a second list
of every option's letter. One letter, never a cluster: `mv -fs done` would
make the last letter the honest answer, but --title, --acceptance and a
comment body all take a leading hyphen on purpose, and a criterion typed as
`-fixes the offset` must not be answered with statuses.

The fish half had the same hole in its dynamic rules alone, which were
written as `-l <flag>`: `append -g <TAB>` offered nothing where
`append --tags <TAB>` offered the board's tags. fish_option reads the letter
off the definition per command, so an option given one tomorrow is offered
under it the day it is given. Clap's own generated rules already carried
both spellings, which is why a shell answered `mv -s ` and the board did
not.

a_short_flag_answers_what_its_long_spelling_answers walks every option with
both spellings on every command and nested command and pins that the two
answer the same, so this cannot come back one flag at a time.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-15 17:00:35 +02:00
Ansho ReiandClaude Opus 5 298e00eb33 (d7e493e) Draw the command's own usage line while the prompt is open, and bump to 0.33.7
The reader knows the grammar approximately: that mv takes a status, not
whether it is a positional or --status, and that set has a flag per section,
not whether the criteria one is --acceptance or --criteria. In a shell fish
answers that as the line is typed. On the board there was nothing, and
getting it wrong cost a rejected line and a guess.

usage_of walks the typed verb against the clap definition and renders its
usage, so a flag added to a command is described here the day it is added.
A table of synopses kept beside it would be a second grammar, and it would
go stale silently: nothing but a reader typing that verb would ever see the
two disagree. The Usage: label is dropped, being the name of a block in a
help page of several where this is one line beside the line it describes.

It takes the keys' slot. esc and enter are two keys a reader learns once,
against a synopsis that is different for every verb; a refusal still wins
over both while it is up, being what was just said about the line that is
still on the row. refusal is the half that says what is wrong where this
says what would have been right.

A verb that resolves to nothing draws nothing and complains about nothing,
since the line is half typed most of the time the row is looked at. A
group's child is walked when the second word names one, so campaign set
describes set; while that word is half typed the group's own usage stands.

Grey, and cut with an ellipsis rather than wrapped: the footer is one row
and a second would reflow the columns every time a verb resolved. There is
always at least the keys' width to cut into, because that width comes off
the row before the line is windowed, so the usage never takes a cell from
what is being typed.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-15 16:51:08 +02:00
Ansho ReiandClaude Opus 5 634a1f44c4 (07ac4e1) Filter campaign ls by state, and lay its listing out as a table, and bump to 0.33.6
campaign ls printed every campaign and offered no way to narrow it, and the
row was assembled by hand, so a long title pushed the standing out of line
with the row above it and the created date the file already carries was not
shown at all.

--state takes open, done or empty and matches against Standing::state(),
so the derived value keeps one definition: a campaign reads [open] in the
listing if and only if --state open lists it. --state rather than --status,
which names one of the five ticket statuses everywhere else and would
invite --state backlog here. empty is the third value because an empty
campaign derives None deliberately, and a filter that could not reach those
would leave what has been filed and forgotten answerable only by reading
the whole listing. A filter that matches nothing names the value back,
since a silent listing reads as the other empty case.

The filter reaches --ids as well, the way ls --ids keeps its own, and is
the only thing that makes that path count members: an unfiltered completion
is as cheap as it was.

The columns are measured on the raw values and padded before anything is
painted, the rule metadata_cells follows. The codename is measured with the
title rather than given a column of its own: a campaign filed without one
spends nothing on it, so a column for it would be one most rows pad into
and some leave empty, and what a reader lines up is where a name ends and
its progress begins.

A flag's possible values now come off the command that holds the flag, so
campaign ls --state reaches ls's own arguments rather than campaign's. The
prompt offered nothing there while fish offered the three values, which
made a liar of the rule that a ValueEnum added anywhere is typeable on the
board the day it is added.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-15 16:42:21 +02:00
17 changed files with 1024 additions and 75 deletions
Generated
+1 -1
View File
@@ -1563,7 +1563,7 @@ dependencies = [
[[package]]
name = "worklane"
version = "0.33.5"
version = "0.33.9"
dependencies = [
"anyhow",
"assert_cmd",
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "worklane"
version = "0.33.5"
version = "0.33.9"
edition = "2024"
[dependencies]
+1 -1
View File
@@ -21,7 +21,7 @@ Worklane is a local Kanban flow for agentic software development.
| `worklane campaign add` | Files a campaign in `.worklane/campaigns/` with `--title`, `--description`, `--codename` and `--owner`. A campaign has no status: its state is derived, open until every member is done. `--codename` is one word to call it by, `v1` or `beaver`, which is what the board draws on every card in it and what every command that takes a campaign will also resolve it by |
| `worklane campaign set <campaign>` | Replaces `--title`, which renames the file keeping the uuid, `--description` and `--codename`. At least one required. The way a campaign filed before codenames existed gets one, and the way a description filed with a typo in it gets fixed. Replacing a codename the campaign already has needs `--force`, since that is the word it is referred to by everywhere; setting the one it already has is a no-op either way. A description needs no `--force`: it is prose written to be revised. No `--clear` and no `--owner` |
| `worklane campaign append <campaign>` | Adds a paragraph to a campaign's description with `--description`, which is required. The other half of `campaign set --description`, so adding a line to a description does not mean retyping the rest of it. Repeat the flag for more lines within the one paragraph. Its own subcommand rather than the top-level `append`, which resolves a ticket |
| `worklane campaign ls` | Lists the campaigns as their short id, their codename, their title, how many members are done, and the state that count derives: `[open]` until every member is done and `[done]` after. A campaign nothing has been filed against reads `no members` and carries no state, being neither. `--ids` prints one per line as the id, a tab and the title, unstyled and without the counts, which read every ticket on the board, for a script or a completion |
| `worklane campaign ls` | Lists the campaigns as a table: when each was created, its short id, its codename, its title, how many members are done, and the state that count derives: `[open]` until every member is done and `[done]` after. A campaign nothing has been filed against reads `no members` and carries no state, being neither. The columns are padded to the widest value in each, so the rows line up whatever the titles are, and the codename is measured with the title rather than given a column of its own, since a campaign filed without one spends nothing on it. `--state` lists only the campaigns in one state, `open`, `done` or `empty` for one nothing has been filed against, and says so by name when nothing matches. `--ids` prints one per line as the id, a tab and the title, unstyled and without the counts, which read every ticket on the board, for a script or a completion; `--state` applies there too, and is the only thing that makes that path count members |
| `worklane campaign show <campaign>` | Shows a campaign and its members grouped by status, done included, since what is finished against what is left is the question a campaign asks |
| `worklane assign <campaign> <ticket>` | Puts a ticket in a campaign, the only command that writes the Campaign field. Campaign first and ticket second, after `chown`. A ticket is in at most one, so assigning one that already belongs somewhere moves it |
| `worklane tags` | Lists the tags the board carries as the tag, a tab and how many tickets carry it, one per line, unstyled and alphabetical. Case sensitive like `ls --tag`, so `bug` and `Bug` list separately and land next to each other. Every status, done included. The one command that answers what tags exist rather than what carries a tag already known |
+7
View File
@@ -168,6 +168,7 @@ fields; a goal is a campaign.
```
worklane campaign ls
worklane campaign ls --state empty # filed against nothing, which is the one to ask about
worklane campaign show v1
worklane campaign add --title "..." --codename v1 --description "..."
worklane campaign set v1 --title "..." # or --description or --codename, on one already filed
@@ -183,6 +184,12 @@ tui is usable on a narrow terminal" is a campaign. "The tui tickets" is a tag.
them in a container says nothing that the tag did not already say.
- **Check what exists first.** `campaign ls` before proposing a new one, or you will
propose a second container for a goal that already has one.
- **`--state empty` finds the containers nothing was ever filed against.** A campaign with
no members is neither open nor done, so it is invisible to `--state open` and reads as
just another row in the full listing. Either the tickets for that goal exist and were
never assigned to it, which is an `assign` away, or the goal is one nobody is working,
which is worth saying out loud. A campaign cannot be discarded, so an empty one stays on
the board until it has members.
- **A ticket is in at most one campaign**, and `assign` moves it rather than adding a
second. So two proposed campaigns that overlap are really one proposal to take members
out of the other, and it has to say so.
+1
View File
@@ -302,6 +302,7 @@ there is no such thing as a done campaign holding an open ticket.
worklane campaign add --title "First public release" --codename v1 \
--description "Everything that has to ship before the tag."
worklane campaign ls # every campaign, its codename, how far it has got
worklane campaign ls --state open # only the ones with work left: open, done, empty
worklane campaign ls --ids # id and title, tab separated, like ls --ids
worklane campaign show v1 # its body, then its members by status
worklane campaign set v1 --title "..." # replace the title, description or codename
+8 -1
View File
@@ -726,8 +726,14 @@ export const campaign_append = tool({
export const campaign_ls = tool({
description:
"List campaigns with how far each has got: id, codename or title, owner, and done members against total. Open until every member is done or discarded.",
"List campaigns with how far each has got: created, id, codename or title, and done members against total. Open until every member is done or discarded.",
args: {
state: tool.schema
.enum(["open", "done", "empty"])
.describe(
"Only campaigns in this state. A campaign with no members is neither open nor done, which is what 'empty' reaches.",
)
.optional(),
ids: tool.schema
.boolean()
.describe("Print only id and title, tab separated, one per line, for parsing.")
@@ -735,6 +741,7 @@ export const campaign_ls = tool({
},
async execute(args: Record<string, any>, context: ToolContext) {
const cmd = ["campaign", "ls"];
if (args.state) cmd.push("--state", String(args.state));
if (args.ids) cmd.push("--ids");
try {
return await run(cmd, context);
+5
View File
@@ -14,6 +14,11 @@ The container that groups tickets across the flow, and why its state is derived.
- **`Resolved` carries what `content_trim` cannot render from the file.** The relations block and the campaign cell both come from elsewhere on the board. A struct rather than two more parameters, so the next such field is one entry here instead of an edit at every call site
- `campaign show` lists **done** members, unlike `ls`, which leaves the done column out of its listing. What is finished against what is left is the whole question a campaign asks, so hiding half the answer is not an option. `ls --campaign` is the other way round: it is the ordinary board filtered, and keeps every rule `ls` already has
- `campaign ls` scans the status directories **once per campaign** to count members. That is a scan per row rather than one walk reused, and it is deliberate: the map-from-uuid version is worth writing when a board has enough campaigns to notice
- **`campaign ls --state` filters on `Standing::state()`, never on the counters.** The derived value has one definition, so a campaign reads `[open]` in the listing if and only if `--state open` lists it. `--state` and not `--status`: the word names one of the five ticket statuses everywhere else in the tool, and a campaign sits in no status directory. The third value is `empty`, matching the `None` an empty campaign derives, because a filter that could not reach those would leave "what has been filed and forgotten" answerable only by reading the whole listing. A filter that matches nothing says so and repeats the value back, since a silent listing reads as the other empty case, a board with no campaigns on it
- **The filter reaches `--ids` as well, and is the only thing that makes that path count members.** `ls --ids` keeps its own filters, so this one keeps its. An unfiltered completion is as cheap as it was: `kept` returns true without reading a ticket when there is no filter to answer
- **The listing is a table, measured on the raw values and padded before anything is painted**, the rule `metadata_cells` follows. A column sized on a painted value counts its escape sequences towards its width, which is what tilts a table when colour is on and leaves it straight when it is off — the one combination an integration test running through a pipe can never see, which is why `the_campaign_table_stands_in_the_same_columns_coloured_or_not` renders both ways in one process and compares them with the escapes taken back off
- **The codename is measured with the title rather than given a column of its own.** A campaign filed without one spends nothing on it, so a column for it would be a column most rows pad into and some rows leave empty. What a reader lines up is where one campaign's name ends and its progress begins, which is one field: the name is the codename and the title together
- **The created stamp is `format_created_at`'s, the same form `ls` prints**, rather than a second spelling of a date. An unparseable one is empty there and the column goes, exactly as it does for a ticket
- **The TUI got a card label and a frame, not a campaign tab.** 61879a4 decided it. A tab would have had to answer what its columns are, and a campaign groups *across* the flow rather than within one status, so the honest answer is the four statuses filtered — which is a filter on the board it already has rather than a fifth tab. So: a label on the card, a frame above the columns while one is selected, and `c` for the picker. The cost the earlier decision balked at, a campaigns read per reload, is paid once per project in `columns_of` and is what names the label; see [The Board View](tui-board.md)
- **A campaign is named by its codename on the board, and by its short id when it has none.** The uuid does not fit on a card and the title is a sentence, which is the gap `Codename` fills. `campaign_label` builds it in one place, as a `Cell`, so the CLI paints it and the board makes a span of it; the mark is `CAMPAIGN_MARK`, `~`, beside `#` for a tag
- **`campaign set` and `campaign append` are the only writers of a filed campaign's fields.** d637288 decided the command: a `set` rather than a flag on something narrower, because the file has more than one editable thing and the moment somebody wants to fix a typo in a title there would be a second command to design. `set` carries `--title`, which renames the file the way `set --title` does, `--description` and `--codename`; `append` carries `--description` alone. `campaign add` writing a field at creation is not a second writer, exactly as `add --title` and `set --title` coexist
+3
View File
@@ -18,6 +18,9 @@ The generated half, the fish half, and what keeps the two honest.
- **A `ValueEnum` is never listed twice, and `argument_at` is why the fish half's two hand-written value lists are the only ones.** clap emits the possible values of an *option*, so `mv --status` and `set --clear` need nothing here and the board reads them off the same definition with `Arg::get_possible_values`. The `ls` status and the `completions` shell are positionals, which the fish generator emits nothing for, so those two are written into the block from the enums — and the board reaches them through `get_positionals`, which needs no `Command::build` the way `get_index` would
- **`RELATION_KIND_FLAGS` is the one position clap cannot answer for.** `relate --clear` takes a kind and then a target, two values of different kinds under one flag, so possible values on it would refuse every target. Both renderers therefore say so themselves: the fish rule lists `RelationKind::ALL` and the table names the pair
- **`ls --ids` is the machine-readable listing**, and one of the three outputs in the tree meant to be parsed: the short id, a tab, the title, unstyled. Two fields because fish reads what follows a tab as the description and a script reads `cut -f1`. It includes done, which the decorated listing leaves out, because a completion has to be able to name a finished ticket, and it skips a missing status directory rather than refusing, because an error printed over a shell prompt is worse than no candidates. The filters still apply, and an unknown `--campaign` is still refused
- **A flag is recognised by either spelling, `--status` and `-s` alike.** `long_name` translates the letter through the command that holds the flag, so every table above stays keyed on the long name and nothing here keeps a second list of the letters. The prompt read a flag by its two hyphens until then: `mv --status ` offered the five statuses and `mv -s ` offered nothing. **One letter, never a cluster** — `mv -fs done` would be the honest reading of the last letter, but `--title`, `--acceptance` and a comment body all take a leading hyphen on purpose, and a criterion typed as `-fixes the offset` must not be answered with statuses. `a_short_flag_answers_what_its_long_spelling_answers` walks every option with both spellings on every command and nested command, so an option given a letter tomorrow is covered the day it is given one
- **The fish rules name the letter too, `-s g -l tags`.** The same hole on the other half: `append -g <TAB>` offered nothing where `append --tags <TAB>` offered the board's tags, because the dynamic rules were rendered with `-l` alone. `fish_option` reads the letter off the definition per command, so a rule for an option with none is what it always was. Clap's own generated half already emitted both spellings, which is why only the dynamic rules were short
- **A flag's possible values are read off the command that *holds* the flag, nested or not.** `argument_at` resolves the group's child when the second word names one, so `campaign ls --state` reaches `ls`'s own arguments rather than `campaign`'s, which carry no such flag. Without that the prompt offered nothing where fish offered the three values, and the promise that a `ValueEnum` added anywhere is typeable on the board the day it is added held only for a top-level command
- **`campaign ls --ids` is the same flag and the same two fields for the other object**, and it deliberately skips the member counting the decorated listing does: `members()` reads every ticket on the board, and the caller here is a shell filling in candidates on a keypress. It also prints nothing on an empty board, where the decorated listing prints a sentence, because a sentence offered as a candidate is worse than no candidates
- **`worklane tags` is the third, and it is a command rather than a mode on `ls`.** Two reasons: `ls --tag <tag>` answers what carries a tag and cannot answer what tags exist, which is the question a grooming sweep starts from, and a `--tags` beside a `--tag` is one letter from a filter that means something else. Alphabetical and case sensitive, matching the filter, so `bug` and `Bug` list separately and land next to each other, which is where a near-duplicate is spotted. Every status, done included: a tag that has fallen out of use is still part of what the vocabulary has been. `assets/PLAN.md` used to tell the agent to count tags with a `show` per ticket, and now points here
+5 -3
View File
@@ -20,7 +20,7 @@ The TUI: the columns, the cards, the frame, the pickers and the footer.
- **`wrapped_height` is the one measurement.** `last_offset` is it less the viewport and `page_indicator` takes the same two numbers, so the clamp and the indicator cannot disagree. A second `line_count` call, or a count of the raw lines, is a number free to drift, and an indicator that says there is more to read where the scroll refuses to move is worse than none
- **The furthest offset is the last page by definition, not by division.** The clamp stops at the wrapped height less the viewport, which is not a page boundary, so the final screenful is partial: `offset / step + 1` reads `pg 2/3` at the bottom of a 25 row ticket in a 10 row viewport and claims there is more below
- **The pages are counted in `scroll_step`, a screenful less the overlap line, not in whole screenfuls.** The step is what the keys take, so counting in it names only pages `pgdn` can land on. Counting by screenfuls puts a 30 row ticket in a 10 row viewport at `pg 3/3` two rows short of its end, since three presses are what it takes to get there
- The indicator is dropped whole on an overlay too narrow for it, the rule a corner and the tags row already follow, and absent entirely when nothing scrolls, the way an untagged card spends no row on tags
- The indicator is dropped whole on an overlay too narrow for it, the rule a corner follows, and absent entirely when nothing scrolls, the way an untagged card spends no row on tags
- `page_indicator` takes four numbers and returns an `Option<String>`, so every case above is pinned without a terminal. The drawn tests exist for the two things arithmetic cannot answer: which border it landed on and what colour it reached the screen in
- **Columns scroll to keep the selected card in view.** `Board::offsets` holds one offset per column, parallel to `columns` and resized in step by `reload`, so a column you leave stays where it was. The keypress aligns the focused column via `follow_selection(screen)`, taking the screen size for the same reason `scroll_detail` does: the visible height belongs to the terminal, which only the caller measures between draws
- Card heights are measured on `card_lines`, never assumed, on both the keypress and the draw side (`card_height`, and the `starts` vec as the cards are built). An alignment that trusted a fixed card height would drift from the renderer the first time the card changed shape
@@ -46,7 +46,7 @@ The TUI: the columns, the cards, the frame, the pickers and the footer.
- **The comment count is the same field discipline and the one entry on that pass that costs a directory listing.** The history lives outside the ticket file, so `count_comments` is a `read_dir` rather than a parse: `.md` only, the filter `read_history` applies, and no body is read, because a count needs none of them. **It counts comments and not entries**, off the kind in the filename, so a card still says how many things somebody said: a ticket that has moved three times has not been talked about, and counting the moves would put a number on every card on the board. `collect_ticket_items` derives the board from `status_path.parent()` instead of taking it as a second argument, so a status directory from one board cannot arrive with the history of another. `history_dir` spells the path once for the writer, the reader and the counter, the way `campaigns_dir` does. Zero draws nothing, not a `0` and not a blank: an uncommented card is the row it has always been, which `a_card_with_no_comments_spends_nothing_on_the_corner` pins to the exact spacing
- **The count is cyan and the mark is `COMMENT_MARK`, U+275E, a Dingbat.** It is the only coloured thing on a row whose owner and criteria count are grey, because two counts side by side otherwise read as one number in brackets and another that lost its brackets. Not U+1F4AC SPEECH BALLOON: emoji presentation and East Asian Width Wide, so it draws two cells where `spans_width` counts one character and every corner on the card lands a cell out. Not U+1F5E8 LEFT SPEECH BUBBLE either: text presentation and Neutral, but in a pictograph block most terminal fonts leave as tofu. Check both properties before swapping the glyph
- **`the_count_is_read_when_the_items_are_collected_and_not_per_draw` takes the history directory away after the board is built**, and is paired with `a_comment_added_after_the_board_was_built_reaches_the_card_on_reload`, because a count that never asks the filesystem again would pass the first test by never changing. The digest already moves when a comment lands, so the reload is what recounts
- **A card names its campaign on the label row, before the tags, in bold.** `labels_line` draws both, `CAMPAIGN_MARK` (`~`) for the campaign and `#` for a tag, and the campaign takes the row's width first: two cards in one campaign is what a reader looking for a campaign is looking for, and the tags are the context around it. So a row too narrow for both drops the tags whole and keeps the campaign, the order `corner_line` and `project_label` already follow, and a campaign the row will not hold at all goes whole too. A ticket in neither spends no row, so **a ticket in no campaign renders exactly as it did before campaigns reached the card**
- **A card names its campaign on the label row, before the tags, in bold.** `labels_line` draws both, `CAMPAIGN_MARK` (`~`) for the campaign and `#` for a tag, and the campaign takes the row's width first: two cards in one campaign is what a reader looking for a campaign is looking for, and the tags are the context around it. So a row too narrow for both gives up tags until the two fit and keeps the campaign, the order `corner_line` and `project_label` already follow, and a campaign the row will not hold at all goes whole too. A ticket in neither spends no row, so **a ticket in no campaign renders exactly as it did before campaigns reached the card**
- **`Card::campaign` is a resolved `Cell`, not a uuid**, settled at reload the way `project` and `blocked` are. `TicketItem::campaign` already carries the uuid off the pass that builds the card; the name is in another directory, so `columns_of` reads `CampaignIndex` once per project and hands it to every card. Never per draw, the rule `criteria` and `tags` already hold. The merge carries the resolved cell rather than looking it up again, for the reason it carries `blocked`: a campaign is addressed inside one `.worklane`, so a merged lookup could answer one project's uuid with another project's campaign
- **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
@@ -100,7 +100,9 @@ The TUI: the columns, the cards, the frame, the pickers and the footer.
- **`Tab::standing` is gone with it.** The frame's standing is the row's, because two counts of one number are two numbers free to drift — the rule `wrapped_height` holds for the scroll. `the_standings_are_read_when_the_cards_are_and_not_per_draw` takes the status directories away after the board is built, paired with `a_member_finished_after_the_board_was_built_completes_its_campaign` for the reason the comment count's two tests are paired: a standing that never asked the filesystem again would pass the first by never changing
- **`q` takes off one layer at a time, in the order they were put on**: the overlay, then the campaign filter, then the board. `Board::dismiss` holds all three, and it takes the screen now because clearing the filter reloads and has to follow the selection. Selecting a campaign closes an open ticket, the answer hiding the done column already gives: the ticket may not be on the filtered board at all, and swapping it for a different one without saying so is how a person acts on the wrong ticket
- **`digest` watches the campaigns directory** as well as the statuses and the history. A campaign filed elsewhere has to reach the picker and a codename edited by hand has to reach every card that names it, and a directory's own mtime would miss the edit
- **The tags go under the title, dimmed, each prefixed with `#`.** The field was invisible on the board: nothing said a ticket was tagged `bug` without opening it. The marker is what stops the row reading as a third line of the title, since a tag is an ordinary word and the title sits directly above it. The row is dropped whole when the column will not hold it, the rule a corner follows, and an untagged ticket spends no row at all, the way a short title spends no second one
- **The tags go under the title, dimmed, each prefixed with `#`.** The field was invisible on the board: nothing said a ticket was tagged `bug` without opening it. The marker is what stops the row reading as a third line of the title, since a tag is an ordinary word and the title sits directly above it. An untagged ticket spends no row at all, the way a short title spends no second one
- **A row the column will not hold draws the tags that fit and ends in `(+n)`**, the count of the ones it left out. Whole tags only, the rule a corner follows: `bug` and `bugfix` cut to the same width say the same thing. What changed in 39be95b2 is the other half of that rule — the row used to go whole, so a narrow column, which is exactly where a reader is scanning cards for a tag, showed no tags at all. A short row is allowed as long as it says it is short, and the indicator is the entire difference between a cut list and one that reads as the ticket's whole list. So a row with no room for one tag beside the count is still dropped whole: `(+3)` alone tells nobody anything, and a tag drawn without the count would lie. `tags_that_fit` measures the indicator as part of the row it counts rather than reserving it up front, because `(+9)` and `(+10)` are different widths and a list of under ten should not pay for the tenth
- **The count is grey and parenthesised**, not a colour of its own and not bracketed: it is a fact about the row rather than another tag on it, and `[n/m]` two rows below is the criteria count
- `tags` is a field on `TicketItem`, filled in `collect_ticket_items` through `parse_tags`, for the reason the criteria count is. `parse_tags` splits the comma-separated field into whole trimmed values, so a caller asking for `bug` is not answered by `bugfix`, and reads absent, `_None_` and empty as the same answer
- **A held-up card carries `BLOCKED_MARK`, `×`, after its id, in brightred.** The constant lives in `util.rs` and the relations block draws the same one, since both say the same word. A ticket its blocker has not moved out of the way of looked exactly like one that is ready, and the board is where the next thing to pick up is chosen. The mark is `mv`'s own rule asked one column ahead, so it says this cannot advance rather than that a dependency was ever recorded: a card in committed whose blocker is in reviewing is unmarked, because reviewing is where it may go, and the same card is marked once it sits in reviewing and only done is left. The two terminal columns have no next stage and nothing in them is drawn blocked. Not a fourth circle from Geometric Shapes: those belong to the priority meter two cells away and would read as part of that ramp. The multiplication sign is Latin-1, like the middle dot the unset priority draws, so it renders wherever the meter does
- **The mark goes after the id, not before it.** Ahead of the id it would push every id in the column out of line whenever one card was blocked, which costs more than one card's state is worth. It is measured before the project label and the due date, so both give way to it: those are context for a ticket somebody can start, and this is the one thing on a card that says not to. Dropped whole when the row cannot hold the identity and the mark together, the rule a corner follows
+4
View File
@@ -33,6 +33,10 @@ The three input modes on the board and the key that copies an id off it.
- **The selection is restored by uuid across that reload, never by index.** `mv` puts the card in another column, `set --title` renames its file, and a filter can drop it out of view entirely, so the slot is not the ticket. `Board::reselect` has three answers: the card is in a drawn column and the selection goes to it; it is on the board but in a column the rotation is hiding, which is where `--status done` lands by default, so the notice says where it went and which key shows it; or the filter no longer holds it, which is said too, since a card vanishing from under the highlight reads as a bug in the board
- **The merge tab is refused, for now.** It is the one tab that is not a board — its cards came from several `.worklane` directories and it is none of them — so `Board::current_project` answers `None` there and the command is refused rather than landing on whichever project came first. Routing by the card a command names is ebc5755. The project is resolved by index and not by the tab's name, which is a label two projects can share: e1d79c3 is exactly that, and a write routed by name would be that bug with a file changing at the end of it
- **`Notice` holds as many lines as the command used, and `Board::notice_on_row` decides where they go.** One line with nothing else holding the row draws on the footer, where a copy's notice has always drawn. Anything else — several lines, or any answer at all while the prompt is still open on an error — draws as a box at the foot of the columns, cut to what the columns leave with the dropped count on its last row. A box rather than more rows of footer, and that is the whole reason it is an overlay: a footer that grew and shrank as notices came and went would reflow the columns on every keypress, moving every card the reader is looking at. `draw` and `draw_footer` both ask `notice_on_row`, so the two cannot come to disagree and draw the message twice or not at all
- **The command's own usage line takes the keys' slot as soon as the verb resolves.** The reader knows the grammar approximately — that `mv` takes a status, not whether it is a positional or a flag, and that `set` has a flag per section, not whether the criteria one is `--acceptance` or `--criteria` — which is what a shell answers as the line is typed and the board answered with nothing. `usage_of` walks the typed verb against the clap definition and renders *its* usage, so a flag added to a command is described here the day it is added; a table of synopses kept beside it would be a second grammar going stale silently, since nothing but a reader typing that verb would see the two disagree. The `Usage: ` label is dropped, being a block name in a help page of several where this is one line beside the line it describes
- **`esc` and `enter` are what the row gives up for it.** Two keys a reader learns once, against a synopsis that is different for every verb. A refusal still wins over both while it is up, being what was just said about the line that is still on the row, and `refusal` is the half that says what is *wrong* where this says what would have been right
- **A verb that resolves to nothing draws nothing, and complains about nothing.** The line is half typed most of the time the row is looked at, so an error about `com` is noise where a reader is still typing. A group's child is walked when the second word names one, so `campaign set` describes `set`; while that second word is half typed the group's own `campaign <COMMAND>` stands, which is what has been typed so far
- **Grey, and cut with an ellipsis rather than wrapped.** Grey is the chrome colour and says the same thing the suggestion's does: this is not in your line. The footer is one row, and a second one would reflow the columns every time a verb resolved — the reason a notice of several lines is a box. There is always at least the keys' width to cut into, because that width comes off the row before the line is windowed, so the usage never takes a cell from what is being typed
- **What a refused line shows is clap's own message with the usage block cut off**, which is also what drops the `--help` line after it. `--help` is the exception: it parses as an error of the kind that means *print this* and what it would print is a page, so it is caught and answered in a row's worth of words, or clap's help lands on the alternate screen the way an unsunk `println!` would. `--version` goes through the ordinary path, because what it prints is one line by construction. `ColorChoice::Never` on the command, so nothing that reaches the row carries an escape
- **The keys' width comes off the row before the line is windowed**, so a long command does not push them off the end; a message takes the row from the keys instead, since the reader has just been told something and `esc` and `enter` still do what they did. `prompt_window` anchors the window on the cursor's right edge, which costs the text *after* the cursor on a long line: keeping both ends needs a scroll offset in state, and the draw is where the width is known and the state is not writable
- `: command` is named in every footer state, because the key works in every one of them, and the prompt's own key is drawn as `↵ run`
+55 -1
View File
@@ -238,6 +238,13 @@ pub fn members(worklane_dir: &Path, uuid: &str) -> Result<Vec<(&'static str, Vec
Ok(grouped)
}
/// A campaign with work outstanding, beside [`DONE`] for one with none left.
///
/// Not a [`Status`]: no ticket is ever in it and no directory is named for it. It is the
/// campaign's own two-word vocabulary, and it is a const because the listing prints it,
/// [`Standing::state`] derives it and [`CampaignState`] filters on it.
pub const OPEN: &str = "open";
/// How far a campaign has got: members done against members held.
///
/// `Copy` because the board carries one on every `CampaignRow`, settled at reload: two
@@ -282,7 +289,54 @@ impl Standing {
match (self.total, self.done == self.total) {
(0, _) => None,
(_, true) => Some(DONE),
(_, false) => Some("open"),
(_, false) => Some(OPEN),
}
}
}
/// The state a campaign is in, as `campaign ls --state` accepts it.
///
/// A `ValueEnum` for the reason [`Status`] is one: an unknown value is clap's to refuse
/// at parse time with the three listed, no handler has to check, and every shell that
/// completes possible values gets them for free.
///
/// `--state` and not `--status`, which names one of the five ticket statuses everywhere
/// else in the tool. A campaign sits in no status directory, and borrowing the word for
/// a different vocabulary is how a reader comes to type `--status backlog` here.
///
/// `Empty` is the third value because [`Standing::state`] answers `None` for a campaign
/// nothing has been filed against, deliberately, and a filter that could not reach those
/// would leave the one question a grooming sweep asks — what has been filed and forgotten
/// — answerable only by reading the whole listing.
#[derive(Debug, Clone, Copy, PartialEq, Eq, clap::ValueEnum)]
pub enum CampaignState {
/// Holds members, and at least one of them is not finished
Open,
/// Holds members, and every one of them is done or discarded
Done,
/// Holds no members at all, so it is neither open nor done
Empty,
}
impl CampaignState {
/// The value as it is typed, which is what a message naming the filter repeats back.
pub fn as_str(self) -> &'static str {
match self {
Self::Open => OPEN,
Self::Done => DONE,
Self::Empty => "empty",
}
}
/// Whether a campaign in this standing is the one the filter asked for.
///
/// Matched against [`Standing::state`] rather than against the counters, so the
/// derived value has one definition: a campaign reads `[open]` in the listing if and
/// only if `--state open` lists it.
pub fn holds(self, standing: &Standing) -> bool {
match self {
Self::Empty => standing.state().is_none(),
wanted => standing.state() == Some(wanted.as_str()),
}
}
}
+12
View File
@@ -4,6 +4,7 @@ use std::sync::LazyLock;
use chrono::NaiveDate;
use crate::campaign::CampaignState;
use crate::util::{Clearable, PRIORITY_RANGE, RelationKind, Status, priority_legend};
/// clap wants a `&str` with a long enough lifetime, and the legend is built from
@@ -430,6 +431,17 @@ pub enum CampaignCommand {
/// candidate list on a keypress
#[arg(long)]
ids: bool,
/// Only campaigns in this state: open, done, or empty for one nothing has been
/// filed against
///
/// A campaign's state is derived from its members, so this is a match against the
/// value the listing already computes and shows in brackets. `--state` rather than
/// `--status`, which names one of the five ticket statuses everywhere else; a
/// campaign sits in no status directory. It applies to `--ids` as well, where the
/// member counts it needs are read only because a filter was given
#[arg(long, value_name = "STATE")]
state: Option<CampaignState>,
},
/// Show a campaign and its members grouped by status
+170 -9
View File
@@ -111,6 +111,36 @@ pub const TAG_NESTED_COMMANDS: [(&str, &str); 1] = [("tags", "set")];
/// every target.
pub const RELATION_KIND_FLAGS: [(&str, &str); 1] = [("relate", "clear")];
/// The long name of the flag a typed word spells, or nothing where it is not a flag.
///
/// `--status` is its own name and `-s` is clap's to translate, off the command that holds
/// the flag: a table of the shorts kept here would be a second list of every option the
/// tool has, and it would go wrong the first time one was given a letter.
///
/// **One letter, never a cluster.** `mv -fs done` is force and status and it is `status`
/// that takes the word after it, so the last letter of a cluster would be the honest
/// answer — but `--title`, `--description`, `--acceptance`, `--plan` and a comment body all
/// take a leading hyphen on purpose, and reading `-fixes the offset` as a cluster would
/// offer statuses inside a criterion. A clustered short is rare on a board where the line
/// is typed a word at a time; a hyphen-leading prose value is a documented feature.
fn long_name(arg: &str, holder: Option<&clap::Command>) -> Option<String> {
if let Some(long) = arg.strip_prefix("--") {
return (!long.is_empty()).then(|| long.to_string());
}
let mut letters = arg.strip_prefix('-')?.chars();
let short = match (letters.next(), letters.next()) {
(Some(letter), None) => letter,
_ => return None,
};
holder?
.get_arguments()
.find(|option| option.get_short() == Some(short))
.and_then(|option| option.get_long())
.map(str::to_string)
}
/// What an argument of a typed line names, where worklane can answer what goes there.
///
/// The board's command prompt completes against this: the tables above say *what* the
@@ -167,9 +197,21 @@ pub fn argument_at(args: &[String], index: usize) -> Option<Argument> {
let verb = args.first().map(String::as_str)?;
let group = cli.find_subcommand(verb);
// The command a flag belongs to, which is the *nested* one where a group's child
// carries it: `--state` is `campaign ls`'s and clap holds it on `ls`, not on
// `campaign`. Falls back to the group itself, which is where every other flag is, and
// to nothing for a line whose second word names no subcommand — `mv 1b78a24 --status`
// reaches `mv`'s own arguments as it always did.
let holder = args
.get(1)
.and_then(|child| group.and_then(|group| group.find_subcommand(child)))
.or(group);
// A flag's value is the argument after it, which is where the flag sits whether the
// value is half typed or has not been started.
if let Some(flag) = args.get(index - 1).and_then(|arg| arg.strip_prefix("--")) {
// value is half typed or has not been started. Spelled long or short: `-s` is the same
// flag as `--status` and the row has to answer both, which is what `long_name` is for.
if let Some(flag) = args.get(index - 1).and_then(|arg| long_name(arg, holder)) {
let flag = flag.as_str();
if TICKET_FLAGS.contains(&(verb, flag)) {
return Some(Argument::Ticket);
}
@@ -187,7 +229,9 @@ pub fn argument_at(args: &[String], index: usize) -> Option<Argument> {
// And everything else the flag could take, which is whatever clap knows: `--status`
// and `set --clear` are both `ValueEnum`s, so their values are already written down
// once, in the enum.
let arg = group?.get_arguments().find(|arg| arg.get_long() == Some(flag))?;
let arg = holder?
.get_arguments()
.find(|arg| arg.get_long() == Some(flag))?;
return fixed(arg);
}
@@ -269,8 +313,9 @@ fn fish_dynamic() -> String {
let ticket_flags = TICKET_FLAGS
.iter()
.map(|(command, flag)| {
let option = fish_option(command, flag);
format!(
"complete -c worklane -n '__worklane_command_is {command}' -l {flag} \\\n \
"complete -c worklane -n '__worklane_command_is {command}' {option} \\\n \
-x -a '(worklane ls --ids)'"
)
})
@@ -287,12 +332,13 @@ fn fish_dynamic() -> String {
.map(|(parent, child)| format!("__worklane_nested_arg_of {parent} {child}"))
.collect::<Vec<_>>()
.join("; or ");
let campaign_flags = flag_list(&CAMPAIGN_FLAGS);
let campaign_flags = flag_list("ls", &CAMPAIGN_FLAGS);
let tag_flags = TAG_FLAGS
.iter()
.map(|(command, flag)| {
let option = fish_option(command, flag);
format!(
"complete -c worklane -n '__worklane_command_is {command}' -l {flag} \\\n \
"complete -c worklane -n '__worklane_command_is {command}' {option} \\\n \
-x -a '(worklane tags | cut -f1,3)'"
)
})
@@ -430,15 +476,40 @@ complete -c worklane -n '__worklane_first_arg_of install-skill' -a '{skills}' -d
)
}
/// Option names as fish wants them on a `complete` line, `-l one -l two`.
fn flag_list(flags: &[&str]) -> String {
/// Option names as fish wants them on a `complete` line, `-s o -l one -l two`, for the
/// options of one command.
fn flag_list(command: &str, flags: &[&str]) -> String {
flags
.iter()
.map(|flag| format!("-l {flag}"))
.map(|flag| fish_option(command, flag))
.collect::<Vec<_>>()
.join(" ")
}
/// One option as fish names it: its long name, and its letter where clap gave it one.
///
/// `-s g -l tags` rather than `-l tags` alone, or `append -g <TAB>` offers nothing where
/// `append --tags <TAB>` offers the board's tags — the same hole the board's own prompt had
/// until `long_name`, and the reason one table answers both halves is that neither may
/// answer a spelling the other does not. The letter is read off the definition and never
/// written here, so an option given one tomorrow is offered under it the day it is given.
fn fish_option(command: &str, flag: &str) -> String {
let cli = crate::command::Cli::command();
let short = cli
.find_subcommand(command)
.and_then(|command| {
command
.get_arguments()
.find(|option| option.get_long() == Some(flag))
})
.and_then(|option| option.get_short());
match short {
Some(letter) => format!("-s {letter} -l {flag}"),
None => format!("-l {flag}"),
}
}
/// The names a `ValueEnum` accepts, for a fish `-a` list.
///
/// Read off the enum rather than written out, so a status or a shell added to either one
@@ -762,6 +833,96 @@ mod tests {
assert!(shells.contains(&"fish".to_string()), "{shells:?}");
}
/// The fish half names an option by its letter too, wherever clap gave it one, so a
/// dynamic rule answers both spellings the way the prompt does.
#[test]
fn a_fish_rule_names_the_option_by_its_letter_as_well() {
let script = fish_dynamic();
// `append --tags` is the one flag in these tables with a letter, and it is the
// whole reason the rule is rendered rather than written: `-g` offered nothing.
assert!(
script.contains("-s g -l tags"),
"the tags rule does not name its letter:\n{script}"
);
// And one without stays as it was, rather than gaining an empty `-s`.
assert!(script.contains("-l campaign"), "{script}");
assert!(!script.contains("-s "), "an option with no letter got one:\n{script}");
// Read off the definition, never written here.
assert_eq!(fish_option("append", "tags"), "-s g -l tags");
assert_eq!(fish_option("ls", "tag"), "-l tag");
assert_eq!(fish_option("ls", "nosuchflag"), "-l nosuchflag");
}
/// A flag spelled short answers exactly what the same flag spelled long answers, on
/// every command and every option that has both.
///
/// Walked off the clap definition rather than listed, so an option given a letter
/// tomorrow is covered the day it is given one. `-s` was the report: `mv --status `
/// offered the five statuses and `mv -s ` offered nothing, because the row read a flag
/// by its two hyphens. A boolean's two spellings agree as well, both answering nothing,
/// which is the same statement about a value that is not there.
#[test]
fn a_short_flag_answers_what_its_long_spelling_answers() {
let cli = crate::command::Cli::command();
let mut seen = 0;
for command in cli.get_subcommands() {
let children: Vec<(String, &clap::Command)> = command
.get_subcommands()
.map(|child| (format!("{} {}", command.get_name(), child.get_name()), child))
.collect();
for (line, holder) in
std::iter::once((command.get_name().to_string(), command)).chain(children)
{
for option in holder.get_arguments() {
let (Some(short), Some(long)) = (option.get_short(), option.get_long()) else {
continue;
};
seen += 1;
assert_eq!(
at_cursor(&format!("{line} -{short} ")),
at_cursor(&format!("{line} --{long} ")),
"`-{short}` and `--{long}` answer differently on `{line}`"
);
}
}
}
assert!(seen > 20, "only {seen} options had both spellings, which is too few");
}
/// The two the report named, spelled out, so the walk above cannot pass by finding
/// nothing on either spelling.
#[test]
fn a_short_flag_reaches_the_values_and_the_board() {
let listed: Vec<String> = Status::ALL.iter().map(|s| s.as_str().to_string()).collect();
assert_eq!(values("mv -s "), Some(listed), "`-s` offers no statuses");
assert_eq!(values("mv -s bac"), values("mv --status bac"), "half typed");
// A tag, which comes off the board rather than out of the enum.
assert_eq!(at_cursor("append -g "), Some(Argument::Tag { declared: false }));
// And a cluster is deliberately not read, because `--title`, `--acceptance` and a
// comment body all take a leading hyphen: a value spelled `-fixes the offset` must
// not be read as `-s` and answered with statuses.
assert_eq!(at_cursor("mv -fs "), None);
assert_eq!(at_cursor("comment 1b78a24 -fs "), None);
}
/// The flag on a nested command is answered the same way, from the enum: nothing here
/// knows what a campaign's states are, and the values reach the prompt and fish alike
/// the day a fourth one is added to `CampaignState`.
#[test]
fn campaign_ls_state_is_offered_the_enums_own_values() {
let states = values("campaign ls --state ").expect("--state takes a state");
assert_eq!(states, vec!["open", "done", "empty"], "{states:?}");
}
/// `relate --clear` takes the kind and then the target, which is the one argument clap
/// cannot answer for: possible values on the flag would refuse every target.
#[test]
+183 -18
View File
@@ -1486,21 +1486,43 @@ pub fn cmd_campaign_add(args: &CampaignAddArgs, start: &Path, sink: &mut Sink) -
Ok(())
}
/// List the campaigns with how far each has got.
/// List the campaigns with how far each has got, as a table.
///
/// The counts come from one pass over the status directories per campaign. That is a
/// scan per row rather than one scan reused, and it is deliberate: the alternative is a
/// map from campaign uuid to counts built in a single walk, which is worth writing when
/// a board has enough campaigns to notice and is premature now.
pub fn cmd_campaign_ls(worklane_dir: &Path, ids: bool, sink: &mut Sink) -> Result<()> {
///
/// **The columns are measured on the raw values and padded before anything is styled**,
/// the rule `metadata_cells` follows: a padded coloured value counts its escape
/// sequences towards its width, which tilts a table when colour is on and not when it is
/// off.
///
/// The codename is measured with the title rather than given a column of its own. A
/// campaign filed without one spends nothing on it, so a column for it would be a column
/// most rows pad into and some rows leave empty; what a reader is lining up is where one
/// campaign's name ends and its progress begins.
pub fn cmd_campaign_ls(
worklane_dir: &Path,
ids: bool,
state: Option<CampaignState>,
sink: &mut Sink,
) -> Result<()> {
let index = CampaignIndex::load(worklane_dir)?;
let colored = sink.use_color;
// Ahead of the empty check, which prints prose: a completion must offer nothing
// rather than offer a sentence, the same bargain `list_ids` takes with a missing
// status directory.
//
// The filter reaches here too, the way `ls --ids` keeps its own filters. The counts
// it needs are what `--ids` exists to avoid reading, so they are read only when a
// filter was given: an unfiltered completion is as cheap as it was.
if ids {
for campaign in index.iter() {
if !kept(worklane_dir, &campaign.uuid, state)? {
continue;
}
sink.writeln(&format!("{}\t{}", short_id(&campaign.uuid), campaign.title))?;
}
return Ok(());
@@ -1511,33 +1533,85 @@ pub fn cmd_campaign_ls(worklane_dir: &Path, ids: bool, sink: &mut Sink) -> Resul
return Ok(());
}
sink.writeln("Campaigns:\n")?;
// Built whole before anything is written, because no column can be sized until every
// row has been seen. `CampaignRow` holds the raw values, so the widths are measured
// on what a reader sees rather than on what an escape sequence costs.
let mut rows: Vec<CampaignRow> = Vec::new();
for campaign in index.iter() {
let standing = Standing::of(&members(worklane_dir, &campaign.uuid)?);
let state = match standing.state() {
Some(state) => format!(" [{}]", paint(state, Color::Orange, colored)),
None => String::new(),
};
if state.is_some_and(|wanted| !wanted.holds(&standing)) {
continue;
}
// The codename between the id and the title, in the colour the board draws it in
// and with the same mark: the answer to "which campaign is this" is one word, and
// it should be the same word wherever it is read. A campaign filed without one
// spends nothing on it, the way an untagged card spends no row.
let codename = match campaign.codename.is_some() {
true => {
let label = campaign_label(&campaign.uuid, campaign.codename.as_deref());
format!("{} ", paint_cells(&[label], colored))
}
let name = match campaign.codename.is_some() {
true => vec![
campaign_label(&campaign.uuid, campaign.codename.as_deref()),
Cell::plain(format!(" {}", campaign.title)),
],
false => vec![Cell::plain(&campaign.title)],
};
rows.push(CampaignRow {
created: format_created_at(&parse_ticket_field(&campaign.content, "Created At")),
id: short_id(&campaign.uuid).to_string(),
width: name.iter().map(|cell| cell.text.chars().count()).sum(),
name,
label: standing.label(),
state: standing.state(),
});
}
// A filter that matches nothing says so, naming what was asked for: a listing that
// went silent reads as a board with no campaigns on it, which is the other message.
if rows.is_empty() {
let wanted = state.map(CampaignState::as_str).unwrap_or_default();
sink.writeln(&format!("No campaigns matching `--state {wanted}`."))?;
return Ok(());
}
sink.writeln("Campaigns:\n")?;
let name_width = rows.iter().map(|row| row.width).max().unwrap_or(0);
let label_width = rows
.iter()
.map(|row| row.label.chars().count())
.max()
.unwrap_or(0);
// Every stamp is the same width, so the column is either there or it is not: a
// campaign whose Created At cannot be parsed drops it, the way a ticket's does.
let dated = rows.iter().any(|row| !row.created.is_empty());
let created_width = rows
.iter()
.map(|row| row.created.chars().count())
.max()
.unwrap_or(0);
for row in &rows {
let created = match dated {
true => format!(
"{}{} ",
paint(&row.created, Color::Cyan, colored),
" ".repeat(created_width - row.created.chars().count()),
),
false => String::new(),
};
let state = match row.state {
Some(state) => format!(" [{}]", paint(state, Color::Orange, colored)),
None => String::new(),
};
sink.writeln(&format!(
" ({}) {}{} | {}{}",
paint(short_id(&campaign.uuid), Color::Red, colored),
codename,
campaign.title,
standing.label(),
" {}({}) {}{} | {}{}{}",
created,
paint(&row.id, Color::Red, colored),
paint_cells(&row.name, colored),
" ".repeat(name_width - row.width),
row.label,
" ".repeat(label_width - row.label.chars().count()),
state,
))?;
}
@@ -1545,6 +1619,35 @@ pub fn cmd_campaign_ls(worklane_dir: &Path, ids: bool, sink: &mut Sink) -> Resul
Ok(())
}
/// One row of the `campaign ls` table, as its raw values.
///
/// The widths are measured off these and the painting happens after, which is the whole
/// reason the row is held rather than written as it is built: a column sized on a
/// coloured string counts its escape sequences towards its width.
struct CampaignRow {
created: String,
id: String,
/// The codename and the title, as the cells they are drawn in.
name: Vec<Cell>,
/// The width of `name` in characters, which is what the column is sized on.
width: usize,
label: String,
state: Option<&'static str>,
}
/// Whether one campaign survives the `--state` filter, reading its members only when
/// there is a filter to answer.
///
/// The counts cost a pass over the status directories, and `--ids` is called on a
/// keypress by a shell filling in a candidate list.
fn kept(worklane_dir: &Path, uuid: &str, state: Option<CampaignState>) -> Result<bool> {
let Some(wanted) = state else {
return Ok(true);
};
Ok(wanted.holds(&Standing::of(&members(worklane_dir, uuid)?)))
}
/// Every tag on the board: the ones the tickets carry, the ones the file declares, and
/// what each declared one means.
///
@@ -2296,6 +2399,68 @@ mod sink_tests {
root
}
/// A campaign file as `campaign add` writes one, for a listing test that needs two
/// of them with titles of different lengths.
fn campaign(dir: &Path, title: &str, codename: Option<&str>, uuid: &str) {
let id = uuid::Uuid::parse_str(uuid).unwrap();
let body = campaign_body(title, &[], codename, &id, None, "2026-08-21 02:10:17");
fs::write(dir.join("campaigns").join(format!("{uuid}_{}.md", slug(title))), body).unwrap();
}
/// The table is laid out on the raw values, so the columns stand in the same place
/// whether the row is coloured or not.
///
/// Rendered both ways in one process and compared with the escapes taken back off,
/// which is what `metadata_cells` is pinned by: a column measured on a painted value
/// counts its escape sequences towards its width, and the listing then tilts when
/// colour is on and stands straight when it is off, which is the one combination a
/// piped test can never see.
#[test]
fn the_campaign_table_stands_in_the_same_columns_coloured_or_not() {
let dir = temp_worklane();
ticket(&dir, "backlog", "11111111-1111-4111-8111-111111111111");
campaign(
&dir,
"A campaign nothing was filed against",
None,
"aa11bb22-0000-4000-8000-000000000000",
);
campaign(&dir, "Short", Some("v1"), "bb22cc33-0000-4000-8000-000000000000");
let mut plain = Vec::new();
{
let mut sink = Sink::new(Box::new(&mut plain), false);
cmd_campaign_ls(&dir, false, None, &mut sink).unwrap();
}
let mut painted = Vec::new();
{
let mut sink = Sink::new(Box::new(&mut painted), true);
cmd_campaign_ls(&dir, false, None, &mut sink).unwrap();
}
let plain = String::from_utf8(plain).unwrap();
let painted = String::from_utf8(painted).unwrap();
assert!(painted.contains('\u{1b}'), "the coloured sink wrote no colour");
assert_eq!(
without_escapes(&painted),
plain,
"the columns moved when the values were painted"
);
// And they are columns: the gutter before the member count sits at one offset on
// every row, whatever the title before it was.
let gutters: Vec<Option<usize>> = plain
.lines()
.filter(|line| line.contains(" | "))
.map(|line| line.find(" | "))
.collect();
assert_eq!(gutters.len(), 2, "both campaigns should be listed:\n{plain}");
assert!(
gutters.iter().all(|at| *at == gutters[0]),
"the gutter is ragged:\n{plain}"
);
}
/// A handler writes through the sink it is handed, and a caller can read the bytes
/// back without a terminal or a real stdout.
#[test]
+2 -2
View File
@@ -121,9 +121,9 @@ pub fn dispatch(command: &Command, start: &Path, by: Attribution, sink: &mut Sin
} => cmd_comment(ticket, body, actor, *actor_from_git, start, by, sink),
Command::Campaign { command } => match command {
CampaignCommand::Add(args) => cmd_campaign_add(args, start, sink),
CampaignCommand::Ls { ids } => {
CampaignCommand::Ls { ids, state } => {
let worklane_dir = find_worklane_dir(start)?;
cmd_campaign_ls(&worklane_dir, *ids, sink)
cmd_campaign_ls(&worklane_dir, *ids, *state, sink)
}
CampaignCommand::Set(args) => cmd_campaign_set(args, start, sink),
CampaignCommand::Append(args) => cmd_campaign_append(args, start, sink),
+417 -34
View File
@@ -980,12 +980,57 @@ fn command_name(matches: &clap::ArgMatches) -> Option<String> {
})
}
/// The usage line clap renders for the command the typed line names, or nothing while the
/// verb names none.
///
/// **Clap's own rendering, off the definition the parse uses**, so a flag added to a
/// command is described here the day it is added. A table of synopses kept beside it would
/// be a second grammar, and it would go stale silently: nothing but a reader typing that
/// verb would ever see the two disagree.
///
/// A verb that resolves to nothing answers `None`. The line is half typed most of the time
/// it is looked at, and a complaint about `com` is noise on a row the reader is typing on;
/// `refusal` is where a line that was actually entered is answered.
///
/// A group's child is walked when the second word names one, so `campaign set` describes
/// `set` and not `campaign`. While that second word is still half typed the group's own
/// usage stands, which is the honest answer: `campaign <COMMAND>` is what has been typed
/// so far.
///
/// The `Usage: ` label is dropped and the rest is kept verbatim. The label names the block
/// in a help page of several; this row is one line beside the line it describes, and the
/// cells are worth more than the word.
fn usage_of(args: &[String]) -> Option<String> {
// Colour off for the same reason the parse turns it off: what this row draws is a
// ratatui span, and an escape inside one is printed rather than obeyed.
let cli = <Cli as clap::CommandFactory>::command().color(clap::ColorChoice::Never);
let command = cli.find_subcommand(args.first()?)?;
// The child by exact name, which is what clap will resolve too. A half-typed one
// matches nothing and leaves the group's usage on the row.
let command = match args.get(1).and_then(|word| command.find_subcommand(word)) {
Some(child) => child,
None => command,
};
let usage = command.clone().render_usage().to_string();
Some(
usage
.strip_prefix("Usage: ")
.unwrap_or(&usage)
.trim()
.to_string(),
)
}
/// The one line the row carries for a line clap would not take.
///
/// Clap's own message, because the grammar is clap's: a complaint written here would
/// describe a rule this file does not own. What is dropped is the usage block and the
/// `--help` line after it, which are a paragraph — the synopsis is d7e493e's, and until
/// then the row says what is wrong rather than what would have been right.
/// `--help` line after it, which are a paragraph: this row says what is wrong, and
/// `usage_of` is what says what would have been right, on the same row for as long as the
/// verb resolves. A refusal wins the slot while it is up, being what was just said about
/// the line that is still there.
///
/// `--help` is the exception. It parses as an error of the kind that means *print this*,
/// and what it would print is a page: caught here, or clap's help lands on the alternate
@@ -2520,6 +2565,19 @@ impl Board {
.map(str::to_string)
}
/// The usage line of the command the prompt's line names, for the row to draw in place
/// of the keys.
///
/// Derived on every draw and held nowhere, the way `completion` is: what is on the row
/// is a function of what is in the line, so the two cannot come to disagree and there
/// is no state to clear when the line is edited. The walk is over the clap definition
/// alone and reads nothing off the board, since a keypress must not go to disk.
fn usage(&self) -> Option<String> {
let prompt = self.prompt.as_ref()?;
let split = split_line(&prompt.line, prompt.cursor);
usage_of(&split.args)
}
/// `tab`: take what every candidate agrees on, and then step through them one press at
/// a time.
///
@@ -4499,11 +4557,19 @@ fn card_lines(card: &Card, selected: bool, width: u16) -> Vec<Line<'static>> {
/// use — the stronger fact takes the row and the weaker one gives way. Bold is what stops
/// it reading as another tag when a card carries five.
///
/// A row the column will not hold is dropped whole, the rule `corner_line` applies to a
/// corner: a cut list reads as a shorter one, and `bug` and `bugfix` truncated to the
/// same width say the same thing. A ticket with neither a campaign nor a tag spends no row
/// at all, the way a short title spends no second one, so a ticket in no campaign renders
/// exactly as it did before campaigns reached the card.
/// A row that will not hold every tag draws the ones it can and ends in `(+n)`, the count
/// of the ones it left out. No tag is ever cut in half, the rule `corner_line` applies to
/// a corner: `bug` and `bugfix` truncated to the same width say the same thing. What the
/// row may do is be short, as long as it says so — the indicator is the whole difference
/// between a list that was cut and one that reads as complete, which is why the row is
/// dropped whole when it cannot hold one tag and the indicator together. A cut list
/// without the count is the thing this must never draw. Parentheses rather than brackets,
/// which are the criteria count's two rows below, and grey like the owner and that count,
/// because it is a fact about the row rather than another tag on it.
///
/// A ticket with neither a campaign nor a tag spends no row at all, the way a short title
/// spends no second one, so a ticket in no campaign renders exactly as it did before
/// campaigns reached the card.
///
/// Each tag carries its own colour, from `tag_color`, so the same tag is the same
/// colour on every card in every column, and the campaign carries its own from
@@ -4520,21 +4586,13 @@ fn labels_line(campaign: Option<&Cell>, tags: &[String], width: u16) -> Option<L
// The space between the campaign and the first tag, which the row has to hold too.
let room = width.saturating_sub(used + usize::from(campaign.is_some()));
let row = tags
.iter()
.map(|tag| format!("#{tag}"))
.collect::<Vec<_>>()
.join(" ");
let tags: &[String] = match !row.is_empty() && row.chars().count() <= room {
true => tags,
false => &[],
};
let (tags, omitted) = tags_that_fit(tags, room);
if campaign.is_none() && tags.is_empty() {
return None;
}
let mut spans = Vec::with_capacity(tags.len() * 2 + 2);
let mut spans = Vec::with_capacity(tags.len() * 2 + 3);
if let Some(cell) = campaign {
spans
.push(span_of(cell.clone()).patch_style(Style::default().add_modifier(Modifier::BOLD)));
@@ -4547,9 +4605,70 @@ fn labels_line(campaign: Option<&Cell>, tags: &[String], width: u16) -> Option<L
spans.push(Span::styled(format!("#{tag}"), Style::default().fg(tag_color(tag).into())));
}
if omitted > 0 {
spans.push(Span::raw(" "));
spans.push(Span::styled(
omitted_label(omitted),
Style::default().fg(Color::Grey.into()),
));
}
Some(Line::from(spans))
}
/// How many tags `room` cells will hold, and how many that leaves over.
///
/// Whole tags only, single spaced, in the order the ticket carries them: the first tags
/// are the ones a reader is scanning for, and reordering them would mean the same ticket
/// reads differently in two columns of different widths.
///
/// The indicator is measured as part of the row it counts, not added to a row that was
/// already full, so the answer is the largest prefix whose tags **and** `(+n)` fit. It
/// shrinks as tags are dropped — `(+9)` for nine and `(+10)` for ten — so the fit is
/// recomputed against each candidate rather than reserved once up front, which would
/// spend a cell the row does not owe on every list of under ten.
///
/// A prefix of nothing and a count of everything is a row saying only how much it is not
/// showing, which is no use to anybody, so that case comes back as no tags at all and the
/// caller spends no row on it. Every other answer either shows every tag or says how many
/// it left out; a short list that reads as a complete one is the one thing this cannot
/// return.
fn tags_that_fit(tags: &[String], room: usize) -> (&[String], usize) {
// The whole list first, which is the common case and the only one that draws no
// indicator at all.
// The hash and the space before the next tag, less the space the first one does not pay.
let whole = tags
.iter()
.map(|tag| tag.chars().count() + 2)
.sum::<usize>()
.saturating_sub(1);
if !tags.is_empty() && whole <= room {
return (tags, 0);
}
let mut width = 0;
let mut kept = 0;
for (n, tag) in tags.iter().enumerate() {
// The space before this tag, which the first one does not pay.
width += tag.chars().count() + 1 + usize::from(n > 0);
// The space before the indicator is its own, the way the space before a tag is.
if width + 1 + omitted_label(tags.len() - n - 1).chars().count() > room {
break;
}
kept = n + 1;
}
match kept {
0 => (&[], 0),
kept => (&tags[..kept], tags.len() - kept),
}
}
/// The count of the tags a row left out, as it is drawn.
fn omitted_label(omitted: usize) -> String {
format!("(+{omitted})")
}
/// The project name as it fits beside whatever the row already carries.
///
/// The mark, the id and the blocked mark are the ticket's identity and its state, and
@@ -4766,7 +4885,13 @@ fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
// and is asked first: an input cannot be covered, and it is the newest of the three
// things that can hold the row. Only one of the two prompts can be open at a time.
if let Some(prompt) = &board.prompt {
draw_prompt(frame, prompt, board.suggestion().as_deref(), area);
draw_prompt(
frame,
prompt,
board.suggestion().as_deref(),
board.usage().as_deref(),
area,
);
return;
}
@@ -4979,7 +5104,26 @@ const PROMPT_OPENING: &str = " :";
/// of the field rather than a field of its own, so a long command loses the offer instead
/// of pushing the keys off the row. The terminal cursor sits on its first cell, which is
/// where the cursor already was: what is under a cursor is still what will be typed over.
fn draw_prompt(frame: &mut Frame, prompt: &Prompt, suggestion: Option<&str>, area: Rect) {
///
/// **The usage line takes the keys' slot as soon as the verb resolves.** The reader knows
/// the grammar approximately — that `mv` takes a status, not whether it is a positional or
/// a flag — and in a shell fish answers that as the line is typed. `esc` and `enter` are
/// what the row gives up for it: they are two keys a reader learns once, and the synopsis
/// is the thing that is different for every verb. A refusal still wins over both, being
/// what was just said about the line that is still on the row.
///
/// It is grey, the chrome colour: it is not in the line, nothing here is a value, and the
/// reader has to tell it from what they typed at a glance. Cut to what the row leaves with
/// an ellipsis, never wrapped: the footer is one line, and a second row would reflow the
/// columns every time a verb resolved. There is always at least the keys' width for it,
/// since that width was taken off the row before the line was windowed.
fn draw_prompt(
frame: &mut Frame,
prompt: &Prompt,
suggestion: Option<&str>,
usage: Option<&str>,
area: Rect,
) {
let keys = key_hints(&[("↵", "run"), ("esc", "cancel")]);
let spent: usize = PROMPT_OPENING.chars().count()
+ KEY_GAP.chars().count()
@@ -4994,6 +5138,7 @@ fn draw_prompt(frame: &mut Frame, prompt: &Prompt, suggestion: Option<&str>, are
let (visible, at) = prompt_window(&prompt.line, prompt.cursor, room);
let mut spans = vec![Span::raw(format!("{PROMPT_OPENING}{visible}"))];
let mut drawn = PROMPT_OPENING.chars().count() + visible.chars().count();
// Only ever drawn where the cursor is at the end of the line, which is what `visible`
// then ends at, so this follows the cursor rather than landing in front of the tail of
@@ -5002,16 +5147,30 @@ fn draw_prompt(frame: &mut Frame, prompt: &Prompt, suggestion: Option<&str>, are
let left = room.saturating_sub(visible.chars().count());
let shown: String = rest.chars().take(left).collect();
if !shown.is_empty() {
drawn += shown.chars().count();
spans.push(Span::styled(shown, Style::default().fg(Color::Grey.into())));
}
}
match &prompt.refused {
Some(message) => spans.push(Span::styled(
match (&prompt.refused, usage) {
(Some(message), _) => spans.push(Span::styled(
format!("{KEY_GAP}{message}"),
Style::default().fg(Color::BrightRed.into()),
)),
None => {
(None, Some(usage)) => {
// What the row leaves after the line and the gap. Nothing at all on a terminal
// too narrow to hold a cell of it, the bargain the suggestion already takes.
let left = (area.width as usize).saturating_sub(drawn + KEY_GAP.chars().count());
if left > 0 {
let shown = match usage.chars().count() <= left {
true => usage.to_string(),
false => with_ellipsis(usage, left),
};
spans.push(Span::raw(KEY_GAP));
spans.push(Span::styled(shown, Style::default().fg(Color::Grey.into())));
}
}
(None, None) => {
spans.push(Span::raw(KEY_GAP));
spans.extend(keys);
}
@@ -6438,23 +6597,101 @@ mod tests {
assert!(!rows.iter().any(|row| row.contains('#')), "{rows:?}");
}
/// A row too wide for the column goes whole, the rule a corner follows: a cut list
/// reads as a shorter one, and bug and bugfix cut to the same width say the same
/// thing.
/// A row that holds every tag draws every tag and says nothing about a count, which
/// is the common card and the one the indicator must not appear on.
#[test]
fn a_tag_row_too_wide_for_the_column_is_dropped_whole() {
fn a_row_that_holds_every_tag_spends_nothing_saying_so() {
let dir = board_dir();
write_tagged_card(&dir, "Short", "2026-12-31", "- [ ] One", "frontend, operations");
// One character short of "#frontend #operations", and one over it.
let narrow = only_card_at(&dir, 20);
assert_eq!(narrow.len(), 4, "the row was kept: {narrow:?}");
assert!(!narrow.iter().any(|row| row.contains('#')), "{narrow:?}");
// Exactly "#frontend #operations".
let fits = only_card_at(&dir, 21);
assert_eq!(fits[2], "#frontend #operations", "{fits:?}");
}
/// One character short of the whole list, the card draws what it can and counts the
/// rest. The row used to go whole there, so a narrow column — which is exactly where
/// a reader is scanning cards for a tag — showed no tags at all.
#[test]
fn a_row_too_narrow_for_every_tag_keeps_what_fits_and_counts_the_rest() {
let dir = board_dir();
write_tagged_card(&dir, "Short", "2026-12-31", "- [ ] One", "frontend, operations");
let narrow = only_card_at(&dir, 20);
assert_eq!(narrow.len(), 5, "the row was dropped: {narrow:?}");
assert_eq!(narrow[2], "#frontend (+1)", "{narrow:?}");
}
/// Whole tags only: half a tag is a different tag, and `bug` and `bugfix` cut to the
/// same width say the same thing. So the row gives up a tag before it gives up a
/// character of one, and what it draws stays inside the column.
#[test]
fn a_cut_row_cuts_whole_tags_and_stays_inside_the_column() {
let dir = board_dir();
write_tagged_card(&dir, "Short", "2026-12-31", "- [ ] One", "cli, tui, docs, tests");
for inner in 5..=23u16 {
let rows = only_card_at(&dir, inner);
let row = rows.iter().find(|row| row.contains('#'));
let Some(row) = row else { continue };
assert!(
row.chars().count() <= inner as usize,
"past the column at {inner}: {row:?}"
);
for word in row.split_whitespace().filter(|word| word.starts_with('#')) {
assert!(
["#cli", "#tui", "#docs", "#tests"].contains(&word),
"a tag was cut at {inner}: {row:?}"
);
}
}
}
/// The count is of the tags left out, not of the tags on the ticket, and it grows as
/// the column narrows rather than standing for whatever the first cut happened to be.
#[test]
fn the_indicator_counts_the_tags_the_row_left_out() {
let dir = board_dir();
write_tagged_card(&dir, "Short", "2026-12-31", "- [ ] One", "cli, tui, docs, tests");
assert_eq!(only_card_at(&dir, 20)[2], "#cli #tui #docs (+1)");
assert_eq!(only_card_at(&dir, 16)[2], "#cli #tui (+2)");
assert_eq!(only_card_at(&dir, 11)[2], "#cli (+3)");
}
/// A row with no room for one tag beside the count goes whole, as it always did: a
/// row saying only how many tags it is not showing is no use to anybody, and a tag
/// drawn without the count would read as the ticket's whole list.
#[test]
fn a_row_too_narrow_for_one_tag_and_the_count_is_dropped_whole() {
let dir = board_dir();
write_tagged_card(&dir, "Short", "2026-12-31", "- [ ] One", "frontend, operations");
// One short of "#frontend (+1)".
let narrow = only_card_at(&dir, 13);
assert_eq!(narrow.len(), 4, "the row was kept: {narrow:?}");
assert!(!narrow.iter().any(|row| row.contains('#')), "{narrow:?}");
}
/// The count is grey like the owner and the criteria count, not a colour of its own:
/// it is a fact about the row rather than another tag on it.
#[test]
fn the_indicator_is_drawn_in_grey_rather_than_as_a_tag() {
let dir = board_dir();
write_tagged_card(&dir, "Short", "2026-12-31", "- [ ] One", "frontend, operations");
let board = one_board(&dir);
let card = board.selected().expect("no card");
let colour = card_lines(card, false, 20)
.into_iter()
.flat_map(|line| line.spans)
.find(|span| span.content == "(+1)")
.map(|span| span.style.fg)
.expect("no indicator on the row");
assert_eq!(colour, Some(Color::Grey.into()));
}
/// And a title that fits gets one row, or the second is wasted on every short
/// ticket in the column.
#[test]
@@ -8199,6 +8436,132 @@ approach";
assert_eq!(at.y, SCREEN.height - 1, "the cursor left the prompt row");
}
/// The grammar, where the key list was, as soon as the verb resolves: the reader knows
/// `mv` takes a status and not whether it is a positional or a flag, which is what a
/// shell answers as the line is typed and the board answered with nothing.
#[test]
fn the_row_shows_the_usage_of_the_command_being_typed() {
let dir = searchable();
let mut board = one_board(&dir);
board.open_prompt();
// Nothing typed yet, so there is no command to describe and the keys have the slot.
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(row.contains("esc cancel"), "{row}");
type_line(&mut board, "mv ");
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(
row.contains("mv [OPTIONS] --status <STATUS> <TICKET>"),
"the usage is not on the row: {row}"
);
assert!(
!row.contains("esc cancel"),
"the keys and the usage both took the slot: {row}"
);
// And it is the grammar of the verb in the line, not of the one typed before it.
type_line(&mut board, "1111111");
board.prompt_key(ctrl('w'), SCREEN);
for _ in 0.."mv ".len() {
board.prompt_key(typed(KeyCode::Backspace), SCREEN);
}
type_line(&mut board, "comment ");
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(row.contains("comment"), "{row}");
assert!(!row.contains("--status"), "the previous verb's usage stayed: {row}");
// Closing the prompt gives the board's own key list back.
board.prompt_key(typed(KeyCode::Esc), SCREEN);
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(row.contains("quit"), "the key list did not come back: {row}");
assert!(!row.contains("--status"), "the usage outlived the prompt: {row}");
}
/// The resolve step on its own: what a verb names, what a group's child names, and what
/// a word that names nothing yet does.
///
/// The values are clap's own rendering off the definition the parse uses, which is why
/// this asserts on flags rather than on a synopsis written out here: a table of those
/// kept beside the command would go stale the first time a flag was added, and silently,
/// since nothing but a reader typing that verb would ever see the two disagree.
#[test]
fn a_usage_is_clap_s_own_and_a_nested_command_describes_itself() {
let usage = |line: &str| {
let words: Vec<String> = line.split_whitespace().map(str::to_string).collect();
usage_of(&words)
};
let mv = usage("mv").expect("mv names a command");
assert!(mv.starts_with("mv "), "the label survived: {mv}");
assert!(mv.contains("--status <STATUS>"), "{mv}");
assert!(mv.contains("<TICKET>"), "{mv}");
// The question the ticket is about: which flag the criteria section is under.
assert!(usage("set").is_some_and(|set| set.contains("--acceptance")));
// A group's child describes itself rather than its parent, once both words are
// there. `campaign set` takes a campaign; `campaign` alone takes a command.
let group = usage("campaign").expect("campaign names a command");
assert!(group.contains("<COMMAND>"), "{group}");
let child = usage("campaign set").expect("campaign set names a command");
assert!(child.contains("<CAMPAIGN>"), "{child}");
assert!(!child.contains("<COMMAND>"), "the parent's usage was drawn: {child}");
// A second word that names no child leaves the group's own usage up, which is what
// has been typed so far.
assert_eq!(usage("campaign se"), Some(group.clone()));
// And a verb that names nothing has nothing to say about it.
assert_eq!(usage("com"), None);
assert_eq!(usage(""), None);
assert_eq!(usage_of(&[]), None);
}
/// A line half typed is the state the row is looked at in, so a verb that resolves to
/// nothing draws nothing and complains about nothing.
#[test]
fn a_half_typed_verb_shows_no_usage_and_no_complaint() {
let dir = searchable();
let mut board = one_board(&dir);
board.open_prompt();
type_line(&mut board, "com");
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(row.contains("esc cancel"), "the keys lost the slot: {row}");
assert!(refused(&board).is_none(), "a half typed verb was refused");
assert!(!row.contains("Usage"), "a label reached the row: {row}");
}
/// The footer is one row, whatever the usage is: a second row would reflow the columns
/// every time a verb resolved, which is the same reason a notice of several lines is a
/// box rather than more footer.
#[test]
fn a_usage_wider_than_the_row_is_cut_and_leaves_the_columns_alone() {
let dir = searchable();
let mut board = one_board(&dir);
// `set` has the longest synopsis in the tool, a flag per section and one per scalar.
let narrow = 60;
let before = render(&board, narrow, SCREEN.height);
board.open_prompt();
type_line(&mut board, "set ");
let after = render(&board, narrow, SCREEN.height);
assert_eq!(before.len(), after.len(), "the row count changed");
assert_eq!(
before[..before.len() - 1],
after[..after.len() - 1],
"the columns moved to make room for the usage"
);
let row = after.last().expect("no rows rendered");
assert!(row.chars().count() <= narrow as usize, "the row ran over: {row}");
assert!(row.contains('…'), "a usage too wide for the row was not cut: {row}");
assert!(row.contains(" :set "), "the line lost its cells to the usage: {row}");
}
/// The line is edited where the cursor is, not at its end, which is the difference
/// between a command line and the search prompt's append-only query.
#[test]
@@ -8969,8 +9332,21 @@ approach";
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(!row.contains(":mv"), "the head of the line held the row: {row}");
// The slot at the end of the row keeps its width whatever is typed into the line,
// which is what taking it off the row before windowing is for. `mv` resolves, so
// what holds it is the usage; a verb that resolves to nothing leaves the keys.
assert!(row.contains("mv [OPTIONS]"), "a long line pushed the usage off: {row}");
board.dismiss(SCREEN);
board.open_prompt();
type_line(&mut board, &format!("nosuchverb {}", "a".repeat(200)));
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(row.contains("esc cancel"), "a long line pushed the keys off: {row}");
board.dismiss(SCREEN);
board.open_prompt();
type_line(&mut board, &format!("mv {}", "a".repeat(200)));
let mut terminal = Terminal::new(TestBackend::new(SCREEN.width, SCREEN.height)).unwrap();
terminal.draw(|frame| draw(frame, &board)).unwrap();
assert!(
@@ -12319,7 +12695,9 @@ approach";
/// The campaign takes the row first and the tags give way, the order a corner and a
/// project label already follow: two cards in one campaign is what a reader looking
/// for a campaign is looking for, and the tags are the context around it.
/// for a campaign is looking for, and the tags are the context around it. They give
/// way a tag at a time, with the count for the ones that went, and give way whole
/// only when what the campaign left will not hold one tag and the count.
#[test]
fn the_campaign_keeps_the_row_and_the_tags_give_way() {
let dir = board_dir();
@@ -12327,11 +12705,16 @@ approach";
write_member_card(&dir, "Short", "frontend, operations", V1);
// One character short of "~v1 #frontend #operations", and one over it.
let narrow = only_card_at(&dir, 24);
assert_eq!(narrow[2], "~v1", "the tags took the row from the campaign: {narrow:?}");
let cut = only_card_at(&dir, 24);
assert_eq!(cut[2], "~v1 #frontend (+1)", "{cut:?}");
let fits = only_card_at(&dir, 25);
assert_eq!(fits[2], "~v1 #frontend #operations", "{fits:?}");
// One character short of "~v1 #frontend (+1)", where the tags have nothing left
// to give up and the campaign keeps the row alone.
let narrow = only_card_at(&dir, 17);
assert_eq!(narrow[2], "~v1", "the tags took the row from the campaign: {narrow:?}");
}
/// And a campaign the row will not hold goes whole, never cut: half a codename is a
+149 -4
View File
@@ -131,6 +131,21 @@ fn stderr(out: &std::process::Output) -> String {
String::from_utf8_lossy(&out.stderr).to_string()
}
/// A listing with its column padding collapsed, for an assertion about what a row says
/// rather than about where its columns sit.
///
/// The alignment is the subject of `campaign_ls_lines_its_columns_up_whatever_the_titles_are`
/// and of the colour test beside `cmd_campaign_ls`; every other test is about the words,
/// and one that spelled the padding out would have to be edited whenever a fixture gained
/// a longer title.
fn squeezed(listing: &str) -> String {
listing
.lines()
.map(|line| line.split_whitespace().collect::<Vec<_>>().join(" "))
.collect::<Vec<_>>()
.join("\n")
}
fn find(worklane: &Path, uuid: &str) -> PathBuf {
for status in ["backlog", "committed", "reviewing", "done"] {
for entry in fs::read_dir(worklane.join(status))
@@ -433,7 +448,7 @@ fn campaign_ls_lists_campaigns_with_their_member_counts() {
let out = run(&temp, &["campaign", "ls"]);
assert!(out.status.success(), "{}", stderr(&out));
let listing = stdout(&out);
let listing = squeezed(&stdout(&out));
// One of the two members is in done, so the campaign is open and half finished.
assert!(listing.contains("v1 release | 1/2 done [open]"), "{listing}");
// Nothing has been filed against the other one.
@@ -481,6 +496,136 @@ fn campaign_ls_ids_says_nothing_on_a_board_with_no_campaigns() {
assert!(stdout(&run(&temp, &["campaign", "ls"])).contains("No campaigns yet"));
}
/// The state filter, against the same three answers `Standing::state` gives: a campaign
/// with work left, one with none, and one nothing has been filed against.
#[test]
fn campaign_ls_state_lists_only_the_campaigns_in_that_state() {
let temp = TempDir::new().unwrap();
let _worklane = board(&temp);
// v1 holds a backlog member and v2 holds a done one, so the two are open and done.
run(&temp, &["assign", "v1 release", MEMBER]);
run(&temp, &["assign", "v2 release", OTHER]);
run(&temp, &["campaign", "add", "--title", "Nothing filed yet"]);
let open = squeezed(&stdout(&run(&temp, &["campaign", "ls", "--state", "open"])));
assert!(open.contains("v1 release | 0/1 done [open]"), "{open}");
assert!(!open.contains("v2 release"), "a done campaign was listed as open: {open}");
assert!(!open.contains("Nothing filed yet"), "{open}");
let done = squeezed(&stdout(&run(&temp, &["campaign", "ls", "--state", "done"])));
assert!(done.contains("v2 release | 1/1 done [done]"), "{done}");
assert!(!done.contains("v1 release"), "{done}");
// The third value, which is what makes every campaign on the board reachable: a
// memberless one is neither open nor done, deliberately, and it is the one a
// grooming sweep is looking for.
let empty = squeezed(&stdout(&run(&temp, &["campaign", "ls", "--state", "empty"])));
assert!(empty.contains("Nothing filed yet | no members"), "{empty}");
assert!(!empty.contains("v1 release"), "{empty}");
assert!(!empty.contains("v2 release"), "{empty}");
// And it reaches the machine-readable listing the way `ls --ids` keeps its filters.
let ids = stdout(&run(&temp, &["campaign", "ls", "--ids", "--state", "empty"]));
assert_eq!(ids.lines().count(), 1, "{ids}");
assert!(ids.contains("Nothing filed yet"), "{ids}");
}
/// A value the enum does not hold is clap's to refuse, so nothing is read and the exit
/// code is the usage error's.
#[test]
fn campaign_ls_refuses_a_state_that_is_not_one() {
let temp = TempDir::new().unwrap();
let _worklane = board(&temp);
let out = run(&temp, &["campaign", "ls", "--state", "backlog"]);
assert_eq!(out.status.code(), Some(2), "{}", stderr(&out));
let said = stderr(&out);
assert!(said.contains("open"), "{said}");
assert!(said.contains("empty"), "{said}");
}
/// A filter that matches nothing says so and names what was asked for. Going silent
/// would read as the other empty case, a board with no campaigns on it, which has a
/// message of its own.
#[test]
fn campaign_ls_says_when_the_filter_matched_nothing() {
let temp = TempDir::new().unwrap();
let _worklane = board(&temp);
let out = run(&temp, &["campaign", "ls", "--state", "done"]);
assert!(out.status.success(), "{}", stderr(&out));
let said = stdout(&out);
assert!(said.contains("--state done"), "the filter is not named: {said}");
assert!(!said.contains("No campaigns yet"), "the other empty case: {said}");
// The completion path stays silent, filtered or not.
assert_eq!(stdout(&run(&temp, &["campaign", "ls", "--ids", "--state", "done"])), "");
}
/// The columns line up whatever the titles are, which is what the padding is for. The
/// fixture's two titles are the same length, so this one files a third with a long title
/// and a codename: the row that pushes the column is the row that proves it moved for
/// every other row too.
#[test]
fn campaign_ls_lines_its_columns_up_whatever_the_titles_are() {
let temp = TempDir::new().unwrap();
let _worklane = board(&temp);
run(
&temp,
&[
"campaign",
"add",
"--title",
"A campaign with a much longer title than the others",
"--codename",
"beaver",
],
);
run(&temp, &["assign", "v1 release", MEMBER]);
let listing = stdout(&run(&temp, &["campaign", "ls"]));
let rows: Vec<&str> = listing.lines().filter(|line| line.contains(" | ")).collect();
assert_eq!(rows.len(), 3, "{listing}");
for column in [" (", " | "] {
let offsets: Vec<Option<usize>> = rows.iter().map(|row| row.find(column)).collect();
assert!(
offsets.iter().all(|at| *at == offsets[0]),
"`{column}` is ragged across the rows:\n{listing}"
);
}
// The state sits at one offset too, on the rows that have one: a campaign with no
// members has nothing in brackets and pads to where the next row's bracket is.
let states: Vec<Option<usize>> = rows
.iter()
.filter(|row| row.contains('['))
.map(|row| row.find('['))
.collect();
assert!(!states.is_empty(), "no row carried a state: {listing}");
assert!(
states.iter().all(|at| *at == states[0]),
"the state column is ragged:\n{listing}"
);
}
/// The created stamp the campaign file already carries, in the form `ls` prints one in
/// rather than a second spelling of a date.
#[test]
fn campaign_ls_shows_the_created_date() {
let temp = TempDir::new().unwrap();
let _worklane = board(&temp);
let listing = stdout(&run(&temp, &["campaign", "ls"]));
assert!(listing.contains("26-08-21:02"), "no created stamp: {listing}");
// Not in the machine-readable listing, which is the id and the title and nothing else.
let ids = stdout(&run(&temp, &["campaign", "ls", "--ids"]));
assert!(!ids.contains("26-08-21"), "{ids}");
}
/// A campaign is done when it holds members and every one of them is done. An empty one
/// is neither, which is why it reads `no members` rather than `0/0 done`.
#[test]
@@ -490,7 +635,7 @@ fn a_campaign_whose_every_member_is_done_reads_done() {
run(&temp, &["assign", "v1 release", OTHER]);
let listing = stdout(&run(&temp, &["campaign", "ls"]));
let listing = squeezed(&stdout(&run(&temp, &["campaign", "ls"])));
assert!(listing.contains("v1 release | 1/1 done [done]"), "{listing}");
}
@@ -1726,13 +1871,13 @@ fn a_discarded_member_counts_as_finished() {
run(&temp, &["assign", "v1 release", OTHER]);
// Two members, one done and one in the backlog: open and half finished.
let listing = stdout(&run(&temp, &["campaign", "ls"]));
let listing = squeezed(&stdout(&run(&temp, &["campaign", "ls"])));
assert!(listing.contains("v1 release | 1/2 done [open]"), "{listing}");
let discarded = run(&temp, &["mv", MEMBER, "--status", "discarded"]);
assert!(discarded.status.success(), "{}", stderr(&discarded));
let listing = stdout(&run(&temp, &["campaign", "ls"]));
let listing = squeezed(&stdout(&run(&temp, &["campaign", "ls"])));
assert!(listing.contains("v1 release | 2/2 done [done]"), "{listing}");
}