Compare commits

..
13 Commits
Author SHA1 Message Date
Ansho ReiandClaude Opus 5 bf7d8e05d8 (54fde0b) Split a typed command line into arguments the way a shell does, and bump to 0.32.14
The command prompt reads one string and clap reads an argv, so a line has
to be tokenised before anything can parse it: `comment 1b78a24 the offset
was never passed` split on whitespace is five arguments and `comment`
takes two.

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

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

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-27 20:13:01 +02:00
Ansho Rei 30a2b3429e Specify in skill that set overwrites and to use append when that is not desired 2026-08-27 14:11:59 +02:00
Ansho Rei 69bc2feef5 (fa5662a) Write handler output through a caller-supplied sink, and bump to 0.32.13 2026-08-27 08:13:32 +02:00
Ansho Rei 8675f22209 (21713c5) Follow the picker highlight in the draw, not only on the keypress, and bump to 0.32.12 2026-08-26 12:51:21 +02:00
Ansho Rei f183d4635a (e61619a) Stage a new ticket through write_then_replace like every other write, and bump to 0.32.11 2026-08-26 12:39:08 +02:00
Ansho Rei 668263605c (8a2abf1) Give the wrapper tools for relate, campaign, assign and tags, and bump to 0.32.10 2026-08-26 12:32:15 +02:00
Ansho Rei d0a8f9a284 (10a07b8) Filter the board to the tickets in no campaign, from the campaign picker, and bump to 0.32.9 2026-08-26 02:07:16 +02:00
Ansho Rei c3efebe9b3 (86c6d27) Say the statuses, not four, where completions.rs describes what clap emits 2026-08-26 01:17:36 +02:00
Ansho Rei e26e5893f7 (ca2a124) Add --actor-from-git beside every --actor, and bump to 0.32.8 2026-08-25 17:12:25 +02:00
Ansho Rei bfce4cf2f4 (5a46b59) Say campaign where a campaign write fails, and bump to 0.32.7 2026-08-25 16:14:15 +02:00
Ansho Rei b439ad9c41 (7f772a7) Repair a Status field that lags its directory on mv, and bump to 0.32.6 2026-08-25 16:14:05 +02:00
Ansho Rei 455f04d136 (3ca1d0c) Record the tag picker's design in the Board View section 2026-08-25 16:13:38 +02:00
Ansho Rei cac21a94f5 (8f650fc) Refuse a tab in a tag annotation, and bump to 0.32.5 2026-08-25 15:26:08 +02:00
20 changed files with 2785 additions and 433 deletions
+33 -12
View File
@@ -9,6 +9,7 @@
- `src/campaign.rs` - the campaign file format, its resolution, its index and its members
- `src/history.rs` - the history log: the path, the kinds, the reader, the writer, the card's counter and the block `show` and the board both render
- `src/tui.rs` - board state, the change digest, and the ratatui draw
- `src/split.rs` - one pure function turning a typed line into arguments the way a shell does, plus what the half-typed line is still inside and where the cursor sits among them
- `src/clipboard.rs` - the OSC 52 write and the base64 it carries, the board's only way out to the clipboard
- `src/install.rs` - the embedded agent assets and the compare-and-refuse install
- `assets/SKILL.md` - the agent skill for the CLI itself, embedded with `include_str!`
@@ -85,7 +86,7 @@ and this file is for what someone changing worklane's own code needs.
- Prefer explicit `match` over `unwrap_or_default()` for clarity
- Use `unwrap_or_else(|| expr)` for lazy defaults, `unwrap_or(val)` for eager defaults
- Use `anyhow!()` with context strings that include identifying info (e.g. UUID, title) not bare values
- A command whose arguments run past a handful takes a clap `Args` struct, not an inline variant with a matching parameter list: `AddArgs`, `SetArgs`, `AppendArgs`, `CheckArgs`. `add` was nine positional parameters threaded from `main` before it became `AddArgs`, and the handler destructures the struct so the body reads the same as before
- A command whose arguments run past a handful takes a clap `Args` struct, not an inline variant with a matching parameter list: `AddArgs`, `SetArgs`, `AppendArgs`, `CheckArgs`, `MvArgs`. `add` was nine positional parameters threaded from `main` before it became `AddArgs`, and the handler destructures the struct so the body reads the same as before. `mv` was the last inline variant to carry an `--actor`, and `--actor-from-git` pushed its list past the line
### CLI Arguments
- The prose arguments carry `allow_hyphen_values`, via the `PROSE` constant in `command.rs`: `add --title`, `--description`, `--acceptance`, `--plan`, and the `comment` body. Ticket text quotes flag names constantly, and without it a criterion reading `--print is supported` is parsed as a flag and the whole ticket is refused with nothing written
@@ -270,14 +271,14 @@ and this file is for what someone changing worklane's own code needs.
- **`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
- **`Tab::campaign` is a uuid on the tab, not on the `Board`.** A campaign belongs to one `.worklane`, so a filter carried onto another project's tab would empty it and say nothing about why. It is looked up by uuid rather than held as an index, and a selection whose campaign has left the board is cleared by `reload` rather than left filtering the board to nothing
- **A campaign filter is a uuid on the tab, not on the `Board`.** `Tab::filter` is a `Filter`, and a campaign belongs to one `.worklane`, so a filter carried onto another project's tab would empty it and say nothing about why. It is looked up by uuid rather than held as an index, and a selection whose campaign has left the board is cleared by `reload` rather than left filtering the board to nothing
- **The frame above the columns has two heights, and `Chrome` is what every measurement takes.** `Chrome::frame` is an `Option<FrameSize>`, not a bool: `None` for a tab showing the whole board, and `Collapsed` or `Expanded` for one filtered to a campaign or a tag, because both heights have to be measured the same way by everything that measures the board. `screen_rows` grew a row, so the two bools that decide the geometry became one `Chrome`, copied from `Board::chrome`: adjacent same-typed parameters are what the Rust Style rule warns about, and the draw and `follow_selection` have to measure one answer or a keypress scrolls against a board the next frame does not draw. The row indices are named (`TAB_ROW`, `FRAME_ROW`, `BOARD_ROW`, `FOOTER_ROW`), since an index written out by hand goes on meaning what it used to. **Nothing in the geometry is named after campaigns**, because the slot is the tag filter's too: `Chrome::frame` says how tall the frame is and never which filter filled it, so a measurement of the board never has to ask
- **The whole description is carried off the one read, and the cut is on the view.** `section_prose` replaced `section_opening`, which cut to the opening line at read time: the campaign file is only in hand while the campaigns directory is being read, so what that read has to carry is everything a view might want, and `CampaignRow::summary` takes the one line the picker draws back off it. Two fields, one cut from the other, are two strings free to come from different reads of the same file
- **`FRAME_PROSE_ROWS` is the collapsed height, and it is a constant rather than a height fitted to the description.** Three rows of prose plus a border either side. A frame that grew and shrank with the campaign would resize every column whenever the filter changed, and a reader would look for a card where the previous campaign's description had put it. It does not have to be right for the longest description, because scrolling is what covers the rest — which is also why three was affordable where one row was not
- **The expanded height is a share, not a second constant: half of what the frame and the columns divide.** That is the screen less the tab row and the footer, so the split is even between the two of them rather than even against rows neither gets all of. Half rather than most of it for the same reason the frame is not an overlay: the columns below are the campaign's members, and a reader inspecting the campaign has to go on seeing what it is made of. Floored, so the odd row goes to the cards. `Chrome::frame_rows` takes the height because of this, and `screen_rows` is where it is called, since that is the one place that already has an area to take a share of — which is what keeps `Chrome` itself pure and copyable from `Board::chrome` with no screen to hand
- **The share is bounded at both ends, and `COLUMN_MIN_ROWS` is why.** `Constraint::Min(COLUMN_MIN_ROWS)` would take rows back from a frame that asked for too many, silently, and the frame's own measurement would then disagree with what is drawn — the fault `Chrome` exists to prevent. So the share is capped at what leaves the columns those rows, and floored at `FRAME_ROWS`, since expanding must never shrink the frame. On a board too short to divide, `enter` gives the collapsed height back rather than a height nothing measured. `the_expanded_share_is_bounded_at_both_ends` sweeps every height from 4 to 60, tabbed and not, because one screen that happens to work says nothing about the arithmetic
- **The frame says the rest of what it has to say on its borders**, the trade the detail overlay makes with its title and its page indicator: `(id) ~codename · Name` on the top one, the standing on the bottom right, and `q board` then the page indicator on the bottom left. Every row spent here is a row of cards
- **The frame slot is shared between the two filters, not doubled.** One filter is on at a time, per `Filter`, so a tag frame is the campaign frame with its three slots filled differently: `#tag` in `tag_color` on the top border where the campaign's identity goes, how many tickets carry it on the bottom right where the standing goes, and the annotation in the prose rows. `FrameContent` is what the two are told apart into, and **`frame_content` is the one place they are told apart at all** — the borders, the colour, `q board`, the page indicator, the scroll and the focus are all the campaign frame's, and a second `match` on the filter below that is how the two frames come to behave differently in a way nobody decided
- **The frame slot is shared between the filters, not doubled.** One filter is on at a time, per `Filter`, so a tag frame is the campaign frame with its three slots filled differently: `#tag` in `tag_color` on the top border where the campaign's identity goes, how many tickets carry it on the bottom right where the standing goes, and the annotation in the prose rows. `FrameContent` is what they are told apart into, and **`frame_content` is the one place they are told apart at all** — the borders, the colour, `q board`, the page indicator, the scroll and the focus are all the campaign frame's, and a second `match` on the filter below that is how the frames come to behave differently in a way nobody decided
- **A tag frame draws the annotation, which is the payoff for declaring a tag.** Whoever is browsing a tag is deciding whether the next ticket belongs in it, and the sentence saying when the tag is appropriate is then on the screen at that moment rather than in `tags.md`, which they would have to know to open. An undeclared tag draws `NO_ANNOTATION` in grey, which is also the frame saying the word was never agreed on — the vocabulary file's own placeholder rather than the description section's, so the frame and the file say the same thing about the same tag. A tag declared with nothing said about it draws the same, since here the two have the same nothing to show; the picker's sections are where the difference is actionable
- **A tag has no id, so `y` on its frame copies the word.** A tag *is* its name, matched whole by `ls --tag`, so there are no seven characters to shorten and the `#` the border draws is not part of it — `--tag "#bug"` matches nothing. The footer says `y copy tag` there for the same reason: naming it an id would send the reader looking for a short id on a border that prints a word
- **The count on a tag frame is every column's, drawn or not**, the rule the standing holds. With the filter on, those columns *are* the tickets carrying the tag, so it counts what is below it without counting it a second way. The noun is spelled out and pluralised, because a bare number on a border says nothing about what was counted, and there is no derived state beside it: a tag is a word and not a piece of work, so there is no `[open]` to be in
@@ -294,16 +295,25 @@ and this file is for what someone changing worklane's own code needs.
- **The footer has three states, because the selection has three places to be.** An open ticket, the frame, and the cards. On the frame it names `↓ board`, `↵ expand` or `↵ collapse`, the two scroll keys and `y copy id` — `y copy tag` on a tag frame — and leaves out `←→` because they do nothing there. It has to say which way `↵` goes, since the key is a toggle and the frame is always at one of its two heights. `↑ frame` is not named on the board, on the same trade `c` is dropped on: the frame is drawn directly above the columns and up is the key that reaches it. Nor is the way to collapse an expanded frame named from the cards, which is the same trade again — the frame is right there and `↑` reaches it
- **`picker: Option<Picker>` is the whole mode**, the shape `search` and `detail` use, and `Board::picker_key` runs beside `search_key` ahead of the action arms for the same reason: an open list owns the keyboard, so `d` must not toggle done and `q` must not quit while a campaign is being chosen. `ctrl-c` is the one key it declines and every other control combination is swallowed, or `ctrl-d` would reach the arm bound to `d`
- **The picker's rows are `Tab::campaigns`, not a copy taken when it opened**, so a campaign filed elsewhere appears in an open picker on the next tick. It opens on the campaign already selected, so `c` on a filtered board says where you are as well as offering somewhere to go, and a board with no campaigns gets a `Notice` rather than an empty box that has to be dismissed to learn it was empty
- **`t` opens the same picker over the tags instead, and taking a tag filters every column to the cards carrying it.** Every tag the board declares or carries, matched whole and case sensitively the way `ls --tag` matches — the box completes the filter, so offering what the filter would refuse is the one bug it must not have. It opens on the tag already applied, the courtesy `c` pays a campaign-filtered board, and a board carrying no tag gets the same `Notice` a board with no campaigns gets
- **A picker row draws a real codename only.** The row opens with the short id, so the card's `~<id>` fallback would print it twice and say nothing the second time
- **One picker serves both lists, and `PickerRow::key` is what keeps it one.** A second picker would have been a second keyboard, query and highlight to keep in step with the first; instead `PickerKind` decides only which list is built, and everything between the keypress and the filter runs once against the key — which since the pile arrived is a `PickerKey` enum rather than a bare string, because one of the answers filters on an *absence* and carries no string to hand back. `take_picked` reads the kind off the answer rather than off which list was open. Picking any of them clears the others without either setter remembering to, because `select_filter` replaces one `Filter`: one field, which is the same reason the frame slot is shared
- **The campaign picker opens with a row for the tickets in no campaign**, above both sections and never truncated: the pile is the one question about a board of campaigns that no single campaign answers, and on a board whose completed tail is being kept back it would be pushed off the box if it listed among them. It draws its count where a campaign row draws its standing, so picking an empty pile is seen coming; under a query it answers "no campaign" and "none" and hides like any other row. **It selects `Filter::NoCampaign`, its own variant** — `retain_campaign` compares the field to the uuid it is given, so the absence case is a different predicate beside it (`retain_no_campaign`) and not a different value in it, and a magic uuid meaning none is exactly the thing that later matches a real one. A dangling uuid is *set* wrongly and stays out of the view, as it draws `_missing_` on its card rather than nothing at all
- **The pile crosses boards where a campaign cannot, so it is pickable on the merge tab.** An unset field means the same thing in every `.worklane`, the property that lets a tag filter travel there; the count adds across boards, taken at reload off the unfiltered columns like the standings are (`Tab::no_campaign`), never per draw and never off the filtered columns, which would answer zero about themselves
- **The opening highlight still lands on the first campaign, not on the pile.** Campaigns are what this list opens for; the row sits above the list without claiming it — one step up reaches it, it holds the highlight whenever it was the row selected, and only when every campaign is hidden does it take the opening one
- **The frame speaks for the pile in its own words, because the frame question stays `is_whole()`.** Exempting one variant from either half of that rule would be a state where the selection rests on a frame that is not drawn — the one thing `Focus` exists to make unrepresentable. So the title is grey `no campaign` (no id to shorten and no mark, which keeps `~` meaning a campaign and `#` a tag), the standing corner takes the count, and the prose is one grey sentence the board owns, since no file holds words for an absence
- **`y` has nothing to copy from the pile's frame** — no id to shorten and no word a command line takes, `ls --campaign` being unable to say none — so the footer leaves the key out rather than naming it into a notice, and pressing it anyway still answers "nothing to copy"
- **The picker draws two sections, open campaigns above completed, and truncates the completed tail.** One flat list by title put the finished campaigns among the open ones forever, and the tail only grows, so on a board that has run for a while the campaigns worth picking were pushed towards the bottom of the box and eventually off it. Open keeps the index's order, which is by title; completed is by `Created At` newest first, because what a reader recognises about a finished campaign is that it was finished recently. `COMPLETED_SHOWN` of them survive, behind a grey line naming how many older ones are being kept back — rows that are simply gone read as a board that never held them. An unstamped campaign sinks below every stamped one, the rule `by_status_order` holds for a column
- **The tag sections are declared above undeclared, and truncate neither.** The same two-section shape with the opposite reason for the second: a completed campaign is finished with, so its tail is kept back before it pushes the pickable campaigns off the box, while an undeclared tag — a word somebody typed onto a ticket that the board never agreed on — is the row a reader most wants to see. A declared tag no ticket carries stays a row too: `tags.md` is what the board intends, and the vocabulary the listing reports is the one the picker offers. `campaign` and `campaigns` would have sat one under the other here, in different sections, the day the second was invented
- **`picker_list` is the one place that decides what a picker row is**, and `Picker::row` counts *drawn* rows. The sections reorder the campaigns and add rows of their own, so `Tab::campaigns` and the drawn list agree about no number past the first heading, and a row number that meant one thing to the draw and another to a keypress is how a highlight comes to name a campaign nobody chose. The list is derived on every draw and every keypress and never held, which is what keeps a campaign filed elsewhere reaching an open picker on the next tick
- **A heading is drawn only over rows that exist**, the bargain an untagged card's label row already makes, and it says which kind its rows are for as long as they are there — which is what a query filtering down to completed campaigns alone has to go on saying
- **`open` and `completed`, not `open` and `done`.** The split is taken from `Standing::state`, so the section a campaign lands in and the state the frame draws cannot come to disagree about what finished means, but the word is the section's own: a campaign sits in no status directory, so it is not *in* done the way a ticket under that heading is. A campaign with no members is neither, per that method, and lists as open — completed means every member is done, and it holds none to be done
- **Headings and the truncation line take no number: the highlight moves over campaigns only.** `stepped_picker_row` walks past the chrome rather than stopping on it, since a highlight resting on a heading gives `enter` nothing to do, and a step that runs out of campaigns is no move at all, the way a card at the end of a column clamps rather than cycling
- **`/` in the picker is the key it already is on the board**, and `picker_key` can take it because printable keys used to fall through `_ => {}`. Typing filters case insensitively against the short id, the codename and the title — the three things the row draws and the three a campaign is chosen by. Not the summary: a query that matched prose would answer `disk` with every campaign whose description mentions one. **An empty query matches everything**, the opposite of `first_match`'s answer and right for the opposite reason: a jump with nothing typed has nowhere to go, while a filter with nothing typed is not filtering, and pressing `/` must not empty the list
- **`/` in the picker is the key it already is on the board**, and `picker_key` can take it because printable keys used to fall through `_ => {}`. Typing filters case insensitively against the short id, the codename and the title — the three things the row draws and the three a campaign is chosen by. Not the summary: a query that matched prose would answer `disk` with every campaign whose description mentions one. A tag answers by itself or by its annotation, which is a reader who cannot remember the word finding it by what it was for — case insensitive here though `--tag` is not, because matching a tag is the filter and searching for one is a reader typing. **An empty query matches everything**, the opposite of `first_match`'s answer and right for the opposite reason: a jump with nothing typed has nowhere to go, while a filter with nothing typed is not filtering, and pressing `/` must not empty the list
- **A query turns the truncation off**, which is the point of having one: the campaign a reader is searching for is exactly the one the truncation hid
- **The query is a layer, and `esc` takes it off before it takes the picker off**, the order `dismiss` closes the board's own layers in. So the list is whole again after that press, not still filtered with nothing on screen saying why. Movement and `enter` stay live under an open query, because a filtered list nothing can move in is a list nothing can be chosen from; every *printable* key goes into the buffer, so `q` types and so does `j`
- **The highlight follows its campaign, not its row number.** `place_picker` takes a uuid, the answer `Tab::campaign` already gives for the filter: typing, clearing the query and a tick that finishes a campaign all reshape the list, and a number kept across that names whichever campaign now sits at it. One the list no longer holds drops the highlight to the first row that does, which is where an incremental filter puts it. `reload` reads the highlighted uuid before the lists are rebuilt and puts it back after
- **The highlight follows its row, not its row number.** `place_picker` takes a key — whichever answer `PickerRow::key` hands back, the same shape `Tab::filter` holds for any of them: typing, clearing the query and a tick that finishes a campaign all reshape the list, and a number kept across that names whichever campaign now sits at it. One the list no longer holds drops the highlight to the first row that does, which is where an incremental filter puts it. `reload` reads the highlighted key before the lists are rebuilt and puts it back after
- **Both ends bring the highlight into the window.** Opening aligns against the screen the dispatch hands `open_picker`, and the draw follows the highlight again through `aligned_offset` on the geometry it is actually drawing — a resize between that keypress and the frame, or a tick that put the highlight back without touching the scroll, cannot leave it below the fold until some later keypress fixes it. The stored offset is left alone, the way a column's is: what is drawn is corrected immediately and the next navigation writes the correction back
- **A miss is a row in the box, `no match` in brightred**, where the search prompt puts its own, and `enter` on it leaves the picker and the query exactly as they are so the query can be corrected in place. An empty box says nothing about why it is empty
- **The picker's footer becomes its query**, the trade `draw_search` makes: with every printable key going into a buffer, a list of keys describes nothing that works. `/ search` is named only on the closed query, and the open one names what `esc` does to *it* rather than what it does to the picker
- **The title says both counts while a query is open**, `campaigns (2 of 6)`. The bare total is what the box is, but over a list a query has cut down it is a lie about what is on screen
@@ -341,6 +351,15 @@ and this file is for what someone changing worklane's own code needs.
- Both closed footers name `/`, since the jump works with a ticket open as well: it moves the selection and the overlay follows
- Out of scope on purpose, each its own ticket once the input mode exists: `n` and `N` for the next and previous match, searching the description, tags or owner, regex, and filtering the board down to matches rather than selecting one
### Splitting a Typed Line
- **`split_line` is the whole module, and it knows nothing about `Board`.** The command prompt reads one string and clap reads an argv, so `comment 1b78a24 the offset was never passed` has to be tokenised before anything can parse it: split on whitespace it is five arguments and `comment` takes two. A pure function over the line and the cursor is what makes every rule reachable from a unit test, and it is in a file of its own rather than in `tui.rs`, which is eleven thousand lines already
- **The rules are the shell's, because that is what the prompt promises**: the line is spelled there exactly as it is spelled in the shell. Runs of whitespace separate arguments, single and double quotes group one, a backslash escapes the next character *except* inside single quotes where it is a backslash, and an explicitly empty `''` is an argument that exists and is empty — which is what `--title ""` being a usage error rather than a silent clear depends on. A leading hyphen is not special here: whether `--foo` is a flag or the text of a criterion is clap's question, and `PROSE` already answers it
- **Written rather than pulled in, for the two answers a shell's own splitter does not owe anybody.** A line being typed is half finished, so an unterminated quote is a state to report and not an error to raise: `Unclosed` says which quote is open, or that the line ends on a backslash with nothing yet to escape, and the arguments up to that point are handed back anyway, because that is what a hint or a completion has to work from. And completion needs the cursor: which argument it is in counting from the verb, and whether nothing of that argument lies before it, which is the difference between completing an argument and starting one. Both fall out of the one scan and neither is reachable afterwards from the arguments alone
- **`Some("")` is an argument that has been opened and is still empty**, which is the only thing that tells `''` from nothing typed at all. The cursor's answer is taken *before* the last argument is pushed, so a cursor at the end of the line is in the argument being typed rather than one past it
- The cursor is a byte offset, because that is what the prompt's own cursor is: a `String` inserts and removes at byte indices. Past the end reads as the end and inside a multi-byte character reads as after it, so nothing panics and no caller has to clamp first
- `Unclosed::Escape` wins over an open quote, being the inner of the two, and either answer refuses the line
- The binary's own name is not among the arguments: prepending it before `Cli::try_parse_from` is the caller's, since only the caller knows what it is calling
### The Copy Key
- **`y` copies the selected card's short id, over OSC 52 written by hand.** The board is where a ticket is found and the CLI is where it is acted on, and the only thing joining them was seven characters retyped off the screen. `y` reads as yank to the readers a keyboard board is for, and was the letter left: `q`, `esc`, `enter`, `space`, `hjkl`, the arrows, `pgup`, `pgdn`, `tab`, `backtab`, `d` and `/` were taken
- **The mechanism was chosen against ssh**, which is where a board is often read. An escape sequence is the only one of the three ways that crosses the connection, since it is the terminal at the reader's end that owns the clipboard. A crate (`arboard` and its kind) wants X11 and Wayland libraries at build time, and on X11 the selection belongs to the process that set it: copy an id, quit, and the paste buffer is empty, which is precisely this flow. Shelling out to `wl-copy`, `xclip` or `pbcopy` is platform sniffing plus a process spawn, and does nothing on a machine where none of them is installed or on the far end of a connection. crossterm 0.28 is what ratatui 0.29 pins and it ships no clipboard command, and the backend types have to match whatever ratatui pins, so a newer crossterm cannot be picked up on its own
@@ -407,8 +426,9 @@ and this file is for what someone changing worklane's own code needs.
### Who Wrote an Entry
- **Identity is supplied, not detected.** Every option that needs no cooperation fails: a harness variable such as `CLAUDECODE` names the tool rather than the instance and breaks across versions, walking the parent process is platform specific and also only names the harness, and a terminal check separates interactive from not, which a human piping output is too. So the actor is `WORKLANE_ACTOR`, set once per session, with `--actor` as the per-call override
- **Precedence: flag, then `WORKLANE_ACTOR`, then `get_git_user()`, then `unknown`.** `resolve_actor` is the only caller of `get_git_user` for an entry's author, and every entry the CLI writes goes through it. The two halves are separate pure functions, `session_actor` and `entry_actor`, tested without touching the process environment for the reason `colors_wanted` is split that way
- **The session half is cached in a `OnceLock`, the way `should_use_colors` is:** neither the variable nor the git user can change mid-run, and the fallback costs a `git config` subprocess. `session_actor` takes the git user as a closure so that subprocess is not run when the variable already answered
- **Precedence: flag, then `WORKLANE_ACTOR`, then `get_git_user()`, then `unknown`.** With `--actor-from-git` and no explicit value the git user is lifted *above* the variable rather than added beneath it — the flag says attribute this to the human, and a machine with no git user configured reads `unknown` instead of quietly attributing back to the agent. An explicit `--actor` wins outright either way. `resolve_actor` is the only caller of `get_git_user` for an entry's author, and every entry the CLI writes goes through it. The halves are separate pure functions, `session_actor` (the variable alone now) and `entry_actor`, tested without touching the process environment for the reason `colors_wanted` is split that way
- **The variable half is cached in a `OnceLock` and the git user in another**, the way `should_use_colors` is: neither input can change mid-run, and the git user costs a subprocess. Two caches rather than one is the whole point: baking the git user into the session's answer would make `--actor-from-git` read whatever the run's *first* call produced, since with the variable set that call never fetched git at all. `entry_actor` takes the git user as a closure so the subprocess is not run when something ahead of it already answered
- **The two flags are refused together at parse time**, clap `conflicts_with`: both answer who the entry is attributed to, and last-wins would be a silent answer to a contradictory call. `every_actor_command_takes_actor_from_git` walks the clap definition so the pair travels together onto any command that grows an `--actor`
- An **empty `WORKLANE_ACTOR` counts as unset**, the convention `colors_wanted` follows for `NO_COLOR`, so a wrapper script can clear an inherited one. Whitespace counts the same, since a shell quoting a missing value writes one
- **The actor is free text, checked against nothing**, like the `chown` user: there is no registry of actors, and the same reason `ls --tag` refuses to validate a tag
- **It was `comment --owner`, renamed with no alias.** Owner is the ticket's assignee and has one writer, `chown`; this names the writer of the entry, which is a different field. Pre-1.0, and two names for one thing is what splitting `set` and `chown` avoided. `the_owner_flag_is_gone` pins the refusal, since an alias kept "for now" is what makes the wrong name permanent
@@ -428,7 +448,7 @@ and this file is for what someone changing worklane's own code needs.
- **The stamp leads the filename and the kind follows it**, so the lexicographic sort in `read_history` stays chronological however many kinds there are. The collision suffix goes last, after the kind, and is a number, so it matches no slug and the counter skips it
- **A mechanical entry renders as one line and a comment as it always did.** A field change is one fact, and a paragraph for it would bury the comments it sits between. The labels are padded to `Kind::LABEL_WIDTH`, `campaign` being the longest of the four, so the bodies line up under each other
- **A campaign entry records `Campaign::name`, the codename or failing that the title, never the uuid the field holds.** Settled when the entry is written, not left to the renderer: a log is a record, and resolving at read time would let an entry change meaning when a campaign is renamed. A `before` uuid the board no longer has reads `_missing_`, the way the Campaign field itself renders a dangling one, and a ticket never assigned starts from `_Not set_` (f774a33)
- **`--actor` is on every command that writes an entry**, spelled from one `ACTOR_HELP` in `command.rs`: a flag documented differently on each command reads as four flags. On `chown` it sits beside `user`, which is the ticket's new assignee — the two are different questions and that command answers both
- **`--actor` is on every command that writes an entry**, spelled from one `ACTOR_HELP` in `command.rs`: a flag documented differently on each command reads as four flags. `--actor-from-git` rides beside it from its own one string, the same way. On `chown` it sits beside `user`, which is the ticket's new assignee — the two are different questions and that command answers both
- **`set --actor` reaches only the entry `--tags` writes**, since tags are the one field of that command's that is logged. Documented on the flag rather than left for a reader to notice from the absence of entries
### Shipping the Agent Assets
@@ -451,11 +471,11 @@ and this file is for what someone changing worklane's own code needs.
- `.opencode/agent/feature-planner-agent.md` is **deliberately not folded into `PLAN.md`**. It decomposes a feature request into new tickets, which is intake; `PLAN.md` orders the tickets that already exist. Merging them would give one document two jobs and a frontmatter description that fits neither, which is the same reason the review skill is its own document
- **`install-tool` is a second command, not a flag on `install-skill`, because the two artifacts are not alike.** A skill is inert markdown that any agent can read and it reaches both from one path; the tool is executable TypeScript that reaches opencode alone. Claude Code has no directory it scans for a tool definition at all: `claude mcp add` with a `stdio`, `sse` or `http` transport is the only way a tool enters its tool list, and its plugin system adopts `agents`, `hooks`, `monitors`, `workflows`, `output-styles` and `themes` and nothing named tools. So an MCP server, a different artifact, would be what reached it. Verified against Claude Code 2.1.238
- **`tools_root()` follows `XDG_CONFIG_HOME`, `skills_root()` does not.** `~/.claude` is not an XDG path and opencode's config root is: `opencode debug paths` reports `$XDG_CONFIG_HOME/opencode` with the variable set and `~/.config/opencode` without. An empty value counts as unset, the convention `colors_wanted` follows for `NO_COLOR`. `opencode_tool_dir` takes both variables as arguments for the reason `colors_wanted` does, since a threaded test binary cannot mutate the process environment to reach one branch at a time
- **Singular `tool`, and it was measured, not guessed.** opencode 1.15.10 loads `~/.config/opencode/tool/` and `~/.config/opencode/tools/` both: each was served in turn from a directory outside any project and `/experimental/tool/ids` registered all eleven worklane tools. The singular is the spelling opencode's own documentation puts first, the way it writes `agent(s)` and `skill(s)`. `opencode serve` plus that endpoint is how to check this again; there is no `opencode debug tool` to ask
- **`worklane.ts` is the file name the tool ids are built from.** opencode names each tool as the file then the export, so the file's eleven `export const` lines become `worklane_add` through `worklane_uncheck`. Renaming the file renames every tool and every permission rule that mentions one, which is why `TOOL.relative` is pinned by a test rather than left as a detail
- **The tool needs nothing installed beside opencode**, which is worth stating because the file is executable and reads as though it wants a toolchain. It is loaded into opencode's own Bun runtime and the `@opencode-ai/plugin` import resolves there: a copy in a project with no `node_modules` anywhere above it registered all eleven tools, on a machine with no `bun` on `PATH`. c092ea7's criterion 6 named those two as runtime requirements and it was wrong about both
- **Singular `tool`, and it was measured, not guessed.** opencode 1.15.10 loads `~/.config/opencode/tool/` and `~/.config/opencode/tools/` both: each was served in turn from a directory outside any project and `/experimental/tool/ids` registered every worklane tool the file carried, eleven at the time and twenty-one at the recheck after the wrapper caught up with the CLI. The singular is the spelling opencode's own documentation puts first, the way it writes `agent(s)` and `skill(s)`. `opencode serve` plus that endpoint is how to check this again; there is no `opencode debug tool` to ask
- **`worklane.ts` is the file name the tool ids are built from.** opencode names each tool as the file then the export, so the file's twenty-one `export const` lines become `worklane_add` through `worklane_tags_set`. Renaming the file renames every tool and every permission rule that mentions one, which is why `TOOL.relative` is pinned by a test rather than left as a detail
- **The tool needs nothing installed beside opencode**, which is worth stating because the file is executable and reads as though it wants a toolchain. It is loaded into opencode's own Bun runtime and the `@opencode-ai/plugin` import resolves there: a copy in a project with no `node_modules` anywhere above it registered all of its tools, on a machine with no `bun` on `PATH`. c092ea7's criterion 6 named those two as runtime requirements and it was wrong about both
- **The closing line differs from the skills', and that is not a wording choice.** opencode reads its config once at startup and never reloads it, so a running one keeps the tools it began with; the skills' "on their next session" would be a claim that is not true here
- **The wrapper is behind the CLI and nothing guards it.** It has no tool for `relate`, `campaign`, `assign` or `tags`, so an agent holding the tools cannot reach campaigns or relations at all. `every_tool_the_wrapper_exports_is_a_real_subcommand` catches the drift in the direction that breaks at call time, a tool for a command that no longer exists, and deliberately not the reverse: the gap is real, nobody has decided to close it, and a test asserting it would fail on that decision rather than on a mistake
- **The wrapper walks clap in both directions now; until this ticket nothing did.** It was behind by four commands — `relate`, `campaign`, `assign` and `tags` had no tool, so an agent holding the tools could not reach campaigns or relations at all — and nothing compared the file to the CLI, which is how the gap opened and stayed open. `every_tool_the_wrapper_exports_is_a_real_subcommand` catches a tool for a command that has been renamed or dropped, which fails only when an agent finally calls it; `every_subcommand_outside_the_exceptions_has_a_tool` catches the other direction, a subcommand with no tool, through the same walk off clap the completion lists take. Its exception list carries a reason per entry rather than being bare, and one of those reasons was learned from the test's first run: a bare `worklane campaign` is refused by the CLI, its subcommand required, so there is no command for a `campaign` tool to wrap and the five `campaign_*` tools are the command
- **Installing it globally reproduces fb3dec6 for the wrapper.** Global tools apply in every project including this one, so once `install-tool` has run, an agent working on worklane uses the installed copy of `assets/TOOL.ts` and not the tree it is editing. Same trap as the `worklane` on `PATH`, second instance
- `every_agent_facing_subcommand_is_documented` stays on `SKILL` alone. It owns the CLI surface; a role document uses the handful of commands its job needs, and requiring the rest would fill a review document with `init` and campaigns to satisfy a test. The two checks that do run over every document are the frontmatter and that no document shows a command that does not exist
- **The README command table has the same guard, `every_subcommand_has_a_row_in_the_readme_command_table` in `command.rs`.** The skill and the table are the two places a command is discovered, one by an agent and one by a person, and the skill was the only one under test: `campaign` and `assign` shipped in 0.12.0 and were still absent from the table at 0.20.0, e6e3a1b, along with the `--campaign` flag on the `ls` row. It walks clap's own subcommands, one level of nesting included, against the `|` lines of `README.md`, so a new command fails the suite until the table lists it. `help` is excluded, being clap's. The tag subcommands are named in a `PENDING` list rather than skipped, since f7dd1a1 rewrites that row and emptying the list is part of closing it
@@ -511,6 +531,7 @@ and this file is for what someone changing worklane's own code needs.
- `resolve_ticket()` scans all status directories — it's the single source for ticket lookup by UUID prefix, title, or filename
- `parse_ticket_field()` handles extracting metadata values from markdown format
- `move_ticket_file()` stages the updated content in a temp file under `.worklane/`, renames it over the source, and only then renames the file into the target directory. Do not reorder these: renaming first and writing second leaves a ticket in its new directory claiming the old status, and writing to the target then deleting the source puts it in two directories at once. The temp lives outside the status directories so a leftover is never read as a ticket. A failure at the last step leaves the ticket in its old directory with a Status one move ahead, which the next `mv` corrects
- **A move whose target equals the directory the file already sits in repairs a Status field that disagrees with it, instead of refusing as a no-op.** `resolve_ticket` reads the current status off the directory, so the old comparison was the directory agreeing with itself and could never see the field; a hand-moved file was stuck with moving it away and back to fix it. Now the field is compared first: agreement is the ordinary already-in-status report with nothing written, disagreement rewrites the field alone through the same in-place save every edit uses, and reports it as a correction rather than a move. It is gated on neither `-f` nor the dependency guards behind them, because it is not a transition; it writes no stamp, since presence still answers how far the work got and the work arrived nowhere new; and it logs nothing, because an entry shaped like a transition would record a journey the ticket never took. The mirror case is unchanged: a field ahead of its directory after a crash mid-move is corrected by the next real `mv`, because there the target is a status the ticket is not sitting in
- Field lookup, read and write, is scoped to the lines under the `## Metadata` heading and anchored to the start of the line. Prose above it is free text: tickets in this repo quote field markers in their descriptions, and an unscoped search reads or rewrites those instead. `set_status_field()` carries the same scoping
### Ticket Resolution
Generated
+1 -1
View File
@@ -1503,7 +1503,7 @@ dependencies = [
[[package]]
name = "worklane"
version = "0.32.4"
version = "0.32.14"
dependencies = [
"anyhow",
"assert_cmd",
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "worklane"
version = "0.32.4"
version = "0.32.14"
edition = "2024"
[dependencies]
+3 -3
View File
@@ -17,7 +17,7 @@ Worklane is a local Kanban flow for agentic software development.
| `worklane chown <user> <ticket>` | Sets the Owner field, the only command that writes it. Free text, checked against nothing. User first and ticket second, after Unix `chown`. `worklane chown --clear <ticket>` returns the field to unset, taking the ticket in the flag since there is no user to give, and not to the git user `add` falls back to. Records an `owner` entry in the ticket's history, with the owner before and after; `--actor` names who made the change, which is not the same as the user argument |
| `worklane check <ticket> [criteria...]` | Ticks acceptance criteria, each by number as shown by `show` or by a substring. Several in one call, or `all` for every one of them. Prompts with the numbered list if none is given, or errors with it when there is no terminal |
| `worklane uncheck <ticket> [criteria...]` | Unticks acceptance criteria, addressed the same way |
| `worklane comment <ticket> <body>` | Adds a comment to a ticket by UUID or title. The author is `--actor`, or `WORKLANE_ACTOR`, or the git user, in that order |
| `worklane comment <ticket> <body>` | Adds a comment to a ticket by UUID or title. The author is `--actor`, or `WORKLANE_ACTOR`, or the git user, in that order; `--actor-from-git` lifts the git user over `WORKLANE_ACTOR`, for acting on the person's behalf without knowing how they spell themselves, and is refused beside `--actor` |
| `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 |
@@ -27,13 +27,13 @@ Worklane is a local Kanban flow for agentic software development.
| `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 |
| `worklane completions <shell>` | Prints a completion script for `fish`, `bash`, `zsh`, `elvish` or `powershell`. See below |
| `worklane install-skill [skill]` | Writes the embedded agent skills to `~/.claude/skills/<skill>/SKILL.md`, which Claude Code and opencode both read. Four ship: `worklane` teaches the CLI, `worklane-review` reviews a finished ticket against the code that claims to close it, `worklane-plan` grooms the board as a whole, its priorities, due dates, tags and campaigns, and `worklane-admin` sets a board up and repairs one, its tag vocabulary and the faults a board can develop. Every document unless one is named. Leaves a modified copy alone unless `--force`; `--print` writes one to stdout instead and needs the name |
| `worklane install-tool` | Writes the embedded opencode tool definitions to `$XDG_CONFIG_HOME/opencode/tool/worklane.ts`, or `~/.config/opencode/tool/` without it, where opencode loads them for every project. One file and so no name to pass. `--force` and `--print` behave as they do for a skill. opencode only: it registers the eleven `worklane_*` tools from the file name and its exports, and Claude Code has no directory it scans for a tool definition, so reaching it would mean an MCP server rather than this. Restart opencode after installing, since it reads its config at startup and never reloads it. Nothing else to install: the file runs inside opencode's own runtime, so neither Bun nor `@opencode-ai/plugin` has to be on the machine |
| `worklane install-tool` | Writes the embedded opencode tool definitions to `$XDG_CONFIG_HOME/opencode/tool/worklane.ts`, or `~/.config/opencode/tool/` without it, where opencode loads them for every project. One file and so no name to pass. `--force` and `--print` behave as they do for a skill. opencode only: it registers the twenty-one `worklane_*` tools from the file name and its exports, and Claude Code has no directory it scans for a tool definition, so reaching it would mean an MCP server rather than this. Restart opencode after installing, since it reads its config at startup and never reloads it. Nothing else to install: the file runs inside opencode's own runtime, so neither Bun nor `@opencode-ai/plugin` has to be on the machine |
## Environment
| Variable | Effect |
|----------|--------|
| `WORKLANE_ACTOR` | Who every entry the CLI writes is attributed to: a comment, and the `status`, `owner` and `tags` entries `mv`, `chown` and `set --tags` record. Set it once, in the environment an agent runs in, and every call it makes is attributed to it instead of to the git user of whoever's machine it is on. `--actor` overrides it per call, an empty value counts as unset, and with neither supplied the author is the git user and then `unknown`. Free text, checked against nothing |
| `WORKLANE_ACTOR` | Who every entry the CLI writes is attributed to: a comment, and the `status`, `owner` and `tags` entries `mv`, `chown` and `set --tags` record. Set it once, in the environment an agent runs in, and every call it makes is attributed to it instead of to the git user of whoever's machine it is on. `--actor` overrides it per call and `--actor-from-git` lifts the git user over it per call (the two flags are refused together), an empty value counts as unset, and with neither supplied the author is the git user and then `unknown`. Free text, checked against nothing |
| `NO_COLOR` | Set and non-empty turns colour off, whatever the value, per no-color.org. Colour is also off when output is not a terminal, and when `TERM` is `dumb` or empty |
| `XDG_CONFIG_HOME` | Where `install-tool` looks for opencode's config root, `$XDG_CONFIG_HOME/opencode`, defaulting to `~/.config`. `install-skill` does not follow it: `~/.claude` is not an XDG path |
+14 -6
View File
@@ -233,17 +233,25 @@ two exceptions below are files no command owns, and they are marked as such.
first check `worklane ls done`. If it is there and should not be, its file has been moved
into the wrong directory by hand or by a restore.
The repair is two moves, not one:
`mv` reads the current status from the *directory*, so one move puts both halves right:
move the ticket to the status it belongs in and the field travels with it.
```
worklane mv 1b78a24 --status reviewing -f
worklane mv 1b78a24 --status done -f
```
`mv` reads the current status from the *directory*, so moving it to the status the
directory already says it is in is refused as a no-op and the field stays wrong. Moving it
away and back rewrites the field. Check with `worklane show 1b78a24`, whose `Status` line
is read from the file rather than from where it sits.
If the file is where it belongs and only the `Status` field inside is stale — a hand move
that forgot the field, or a half-finished restore — name the directory the file actually
sits in: a move there finds the field disagreeing with the directory and rewrites just
the field, reporting the correction instead of refusing as a no-op.
```
worklane mv 1b78a24 --status done
```
That repair changes only the field: no stamp is written and no history entry either,
because the work went nowhere. Check either repair with `worklane show 1b78a24`, whose
`Status` line is read from the file rather than from where it sits.
### A command says the id matches several tickets
+16 -6
View File
@@ -173,10 +173,12 @@ worklane chown alice 1b78a24 # hand the ticket to someone
worklane chown --clear 1b78a24 # hand it back to nobody
```
`set` replaces, `append` adds, `--clear` empties. Neither `set` nor `append` has
`--owner` or `--status`: owner is `chown`'s and status is `mv`'s, so each field has
exactly one writer. A field set to the value it already holds is reported unchanged and
nothing is written, and so is a field cleared that was already unset.
`set` replaces, `append` adds, `--clear` empties. `set --tags` overwrites the whole
field: to add a tag to a ticket that already carries one, replace the value with every
tag separated by commas. Neither `set` nor `append` has `--owner` or `--status`: owner
is `chown`'s and status is `mv`'s, so each field has exactly one writer. A field set to
the value it already holds is reported unchanged and nothing is written, and so is a
field cleared that was already unset.
**`--clear` takes the field as its value**, one of `due`, `tags`, `priority`,
`description`, `acceptance` or `plan`, and repeats. It writes back exactly what `add`
@@ -374,12 +376,20 @@ Code, and the environment opencode is started with for opencode, since it passes
environment to the tools it runs.
**Reach for `--actor` only when the entry is somebody else's action**: the person asked
you to move a ticket, or to put words on the board as their comment, so name them on the
flag — the move was theirs and the words are theirs, and an entry carrying your name
you to move a ticket, or to put words on the board as their comment, so name them on
the flag — the move was theirs and the words are theirs, and an entry carrying your name
reads later as though you decided both. Otherwise leave it off, unless your instructions
say to use it. It is spelled the same on every command that writes an entry: `comment`,
`mv`, `chown`, `set` and `assign`.
Acting for the person without knowing how they spell themselves? `--actor-from-git`
attributes the entry to the detected git user instead of `WORKLANE_ACTOR`, so their name
is never needed. It cannot be combined with `--actor`, and a machine with no git user
configured has nobody to name: the entry reads `unknown` rather than falling back to your
variable.
```
worklane mv 1b78a24 --status done --actor "Ansho Rei"
```
worklane mv 1b78a24 --status done --actor "Ansho Rei"
```
+373
View File
@@ -497,3 +497,376 @@ function checkboxTool(verb: "check" | "uncheck") {
export const check = checkboxTool("check");
export const uncheck = checkboxTool("uncheck");
/**
* relate is the only writer of the Relations section, so the tool mirrors it rather
* than folding relations into set.
*
* The clear half is one argument per kind rather than a free-text "kind target" line,
* which is what the CLI's single --clear flag would force here. A kind inside a value
* cannot be typed by the schema, a target is a search that may itself contain spaces,
* and splitting the pair apart by hand re-parses what clap already refuses to guess at.
* Per kind the target stays a plain line, the way every other list argument works.
*/
export const relate = tool({
description:
"Record a relation from one ticket to another, or take one off. Kinds: blocked-by means this one waits on that one and its moves are refused while the target is open; regression-of means this one broke that one's fix; relates-to is a neighbour with no dependency. The edge is stored on the ticket you name alone, and show derives the other end for the target, so never record both directions.",
args: {
ticket: tool.schema
.string()
.describe("Ticket UUID prefix (4+ chars) or title substring (required)"),
blocked_by: tool.schema
.string()
.describe("Target tickets this one waits on, one per line.")
.optional(),
regression_of: tool.schema
.string()
.describe("Target tickets whose fix this one broke, one per line.")
.optional(),
relates_to: tool.schema
.string()
.describe("Target tickets this one merely relates to, one per line.")
.optional(),
clear_blocked_by: tool.schema
.string()
.describe("Targets whose blocked-by edge comes off this ticket, one per line.")
.optional(),
clear_regression_of: tool.schema
.string()
.describe("Targets whose regression-of edge comes off this ticket, one per line.")
.optional(),
clear_relates_to: tool.schema
.string()
.describe("Targets whose relates-to edge comes off this ticket, one per line.")
.optional(),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.ticket) {
return "Error relating tickets: ticket is required";
}
const cmd: string[] = ["relate", args.ticket];
if (args.blocked_by) itemLines(args.blocked_by).forEach((line) => cmd.push("--blocked-by", line));
if (args.regression_of) {
itemLines(args.regression_of).forEach((line) => cmd.push("--regression-of", line));
}
if (args.relates_to) itemLines(args.relates_to).forEach((line) => cmd.push("--relates-to", line));
// The kind is spelled the way the flag records it, not the way show prints it:
// the CLI takes either, and the flag spelling is the one with no space in it.
if (args.clear_blocked_by) {
itemLines(args.clear_blocked_by).forEach((line) => cmd.push("--clear", "blocked-by", line));
}
if (args.clear_regression_of) {
itemLines(args.clear_regression_of).forEach((line) => cmd.push("--clear", "regression-of", line));
}
if (args.clear_relates_to) {
itemLines(args.clear_relates_to).forEach((line) => cmd.push("--clear", "relates-to", line));
}
if (cmd.length === 2) {
return "Error relating tickets: name a relation to record or one to clear";
}
try {
return await run(cmd, context);
} catch (err: any) {
return `Error relating tickets: ${err.message}`;
}
},
});
/**
* Five tools for the five campaign subcommands, one export each.
*
* One tool taking an action argument would mirror the CLI nesting, but the schema
* could then no longer say which arguments belong to which action: campaign_set's
* force only means something beside --codename, and campaign_append's description is
* required where add's is not. Separate exports keep each schema true, and the ids
* read as the CLI path anyway, since opencode builds them from this file name plus
* the export: worklane_campaign_set.
*/
export const campaign_add = tool({
description:
"File a new campaign: several separate tickets that have to be finished together for one goal. Its state is derived from its members, so there is nothing to move or close. Give a codename when you can: one word the board draws on every card in the campaign and the shortest thing that addresses it.",
args: {
title: tool.schema
.string()
.describe("Campaign title (required)"),
description: tool.schema
.string()
.describe("What the campaign is for. Use newlines between paragraphs.")
.optional(),
codename: tool.schema
.string()
.describe("One word to call the campaign by, e.g. 'v1' or 'beaver'.")
.optional(),
owner: tool.schema
.string()
.describe("Campaign owner name. If omitted, defaults to the git user.")
.optional(),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.title) {
return "Error adding campaign: title is required";
}
const cmd: string[] = ["campaign", "add", "--title", args.title];
if (args.description) {
descriptionLines(args.description).forEach((line: string) =>
cmd.push("--description", line),
);
}
if (args.codename) cmd.push("--codename", String(args.codename));
if (args.owner) cmd.push("--owner", args.owner);
try {
return await run(cmd, context);
} catch (err: any) {
return `Error adding campaign: ${err.message}`;
}
},
});
export const campaign_set = tool({
description:
"Replace fields on an existing campaign: its title, its description or its codename. Replacing a codename the campaign already has needs force, since everything refers to the campaign by that word once it exists; setting the codename it already carries is a no-op either way. Membership is not set here, use assign.",
args: {
campaign: tool.schema
.string()
.describe("Campaign UUID prefix, codename or title substring (required)"),
title: tool.schema
.string()
.describe("New title. The file is renamed to match, keeping the UUID.")
.optional(),
description: tool.schema
.string()
.describe("New description, replacing the whole section. Use newlines between paragraphs.")
.optional(),
codename: tool.schema
.string()
.describe("New codename, one word. Replacing an existing one needs force.")
.optional(),
force: tool.schema
.boolean()
.describe("Allow replacing a codename the campaign already has.")
.optional(),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.campaign) {
return "Error setting campaign fields: campaign is required";
}
const cmd: string[] = ["campaign", "set", args.campaign];
if (args.title) cmd.push("--title", args.title);
if (args.description) {
descriptionLines(args.description).forEach((line: string) =>
cmd.push("--description", line),
);
}
if (args.codename) cmd.push("--codename", String(args.codename));
if (args.force) cmd.push("--force");
if (cmd.length === 3) {
return "Error setting campaign fields: give at least one field to change";
}
try {
return await run(cmd, context);
} catch (err: any) {
return `Error setting campaign fields: ${err.message}`;
}
},
});
export const campaign_append = tool({
description:
"Add a paragraph to a campaign's description without replacing what is already written. To replace the whole description, use campaign_set.",
args: {
campaign: tool.schema
.string()
.describe("Campaign UUID prefix, codename or title substring (required)"),
description: tool.schema
.string()
.describe("Text to add as a new paragraph at the end of the description (required)."),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.campaign) {
return "Error appending to campaign: campaign is required";
}
if (!args.description) {
return "Error appending to campaign: description is required";
}
const cmd: string[] = ["campaign", "append", args.campaign];
descriptionLines(args.description).forEach((line: string) =>
cmd.push("--description", line),
);
try {
return await run(cmd, context);
} catch (err: any) {
return `Error appending to campaign: ${err.message}`;
}
},
});
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.",
args: {
ids: tool.schema
.boolean()
.describe("Print only id and title, tab separated, one per line, for parsing.")
.optional(),
},
async execute(args: Record<string, any>, context: ToolContext) {
const cmd = ["campaign", "ls"];
if (args.ids) cmd.push("--ids");
try {
return await run(cmd, context);
} catch (err: any) {
return `Error listing campaigns: ${err.message}, Dir: ${resolveWorklaneDir(context)}`;
}
},
});
export const campaign_show = tool({
description:
"Show a campaign's body and its members grouped by status, done included, so what is finished against what is left is one answer.",
args: {
campaign: tool.schema
.string()
.describe("Campaign UUID prefix, codename or title substring (required)"),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.campaign) {
return "Error showing campaign: campaign is required";
}
try {
return await run(["campaign", "show", args.campaign], context);
} catch (err: any) {
return `Error showing campaign: ${err.message}`;
}
},
});
export const assign = tool({
description:
"Put a ticket in a campaign, moving it out of whichever campaign it was in: a ticket is in at most one. Note the order, campaign first and ticket second, after chown.",
args: {
campaign: tool.schema
.string()
.describe("Campaign UUID prefix, codename or title substring (required)"),
ticket: tool.schema
.string()
.describe("Ticket UUID prefix (4+ chars) or title substring (required)"),
actor: tool.schema
.string()
.describe("Who the entry is attributed to. If omitted, WORKLANE_ACTOR is used, then the git user, then \"unknown\". Set WORKLANE_ACTOR in the environment opencode is started with rather than passing this on every call.")
.optional(),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.campaign) {
return "Error assigning ticket: campaign is required";
}
if (!args.ticket) {
return "Error assigning ticket: ticket is required";
}
const cmd: string[] = ["assign", args.campaign, args.ticket];
if (args.actor) cmd.push("--actor", args.actor);
try {
return await run(cmd, context);
} catch (err: any) {
return `Error assigning ticket: ${err.message}`;
}
},
});
/**
* Three tools for tags, and none for `tags ls`: it prints exactly what the bare
* `worklane tags` listing prints, which the tags tool runs.
*
* The annotation lines go through descriptionLines, not itemLines: an empty value is
* a paragraph break in an annotation, exactly as it is in a description, because the
* value_parser on the CLI side accepts one and the vocabulary file stores prose under
* the tag heading.
*/
export const tags = tool({
description:
"List the tags the board carries: the tag, how many tickets carry it, and the opening line of its declared meaning. Read this before inventing a tag. Case sensitive, so bug and Bug list separately and land next to each other, which is where a near-duplicate is spotted.",
args: {},
async execute(_args: Record<string, any>, context: ToolContext) {
try {
return await run(["tags"], context);
} catch (err: any) {
return `Error listing tags: ${err.message}, Dir: ${resolveWorklaneDir(context)}`;
}
},
});
export const tags_add = tool({
description:
"Declare a tag and what it means: when the next ticket belongs in it. The tag is spelled exactly the way ls --tag matches it, one word with no comma in it.",
args: {
tag: tool.schema
.string()
.describe("The tag to declare (required), e.g. 'bug' or 'frontend'."),
annotation: tool.schema
.string()
.describe("What the tag means and when it is appropriate. Use newlines between paragraphs.")
.optional(),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.tag) {
return "Error declaring tag: tag is required";
}
const cmd: string[] = ["tags", "add", args.tag];
if (args.annotation) {
descriptionLines(args.annotation).forEach((line: string) =>
cmd.push("--annotation", line),
);
}
try {
return await run(cmd, context);
} catch (err: any) {
return `Error declaring tag: ${err.message}`;
}
},
});
export const tags_set = tool({
description:
"Replace what a declared tag means, keeping the tickets carrying it. There is no rename: changing the word itself means rewriting the Tags field of every ticket that carries it, which is a migration and not this call.",
args: {
tag: tool.schema
.string()
.describe("The tag to change, spelled the way it was declared (required)."),
annotation: tool.schema
.string()
.describe("What the tag means, replacing whatever it said before. Use newlines between paragraphs (required)."),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.tag) {
return "Error setting tag meaning: tag is required";
}
if (!args.annotation) {
return "Error setting tag meaning: annotation is required";
}
const cmd: string[] = ["tags", "set", args.tag];
descriptionLines(args.annotation).forEach((line: string) =>
cmd.push("--annotation", line),
);
try {
return await run(cmd, context);
} catch (err: any) {
return `Error setting tag meaning: ${err.message}`;
}
},
});
+108 -28
View File
@@ -162,22 +162,35 @@ fn tag_value(raw: &str) -> Result<String, String> {
Ok(value.to_string())
}
/// Reject an annotation line that would be read back as a tag of its own.
/// Reject an annotation the vocabulary file or the listing cannot carry.
///
/// The vocabulary is one heading per tag with its prose under it, so a line of prose
/// starting with the section marker would split the annotation and declare whatever
/// followed. Refused at parse time, where nothing has been written, rather than escaped on
/// the way in: an annotation is prose, and quietly rewriting prose is worse than asking for
/// a different line.
/// followed. A tab anywhere in the value is refused for the listing's sake rather than the
/// file's: `tags ls` prints one tag, its count and the annotation's opening line as three
/// tab-separated fields, so an annotation holding a tab reads as the start of a fourth
/// field and everything after it is silently gone.
///
/// Both are refused at parse time, where nothing has been written, rather than escaped on
/// the way in: an annotation is prose, and quietly rewriting prose is worse than asking
/// for a different line.
fn annotation_line(raw: &str) -> Result<String, String> {
match raw.lines().any(|line| line.starts_with(crate::tag::SECTION)) {
true => Err(format!(
if raw.lines().any(|line| line.starts_with(crate::tag::SECTION)) {
return Err(format!(
"an annotation line cannot start with '{}', which is how the vocabulary file \
starts a tag",
crate::tag::SECTION
)),
false => Ok(raw.to_string()),
));
}
if raw.contains('\t') {
return Err(
"an annotation cannot contain a tab, which is how `tags ls` separates its fields"
.to_string(),
);
}
Ok(raw.to_string())
}
/// What `--actor` says on every command that writes a history entry.
@@ -186,6 +199,13 @@ fn annotation_line(raw: &str) -> Result<String, String> {
/// command reads as five flags.
const ACTOR_HELP: &str = "Who the entry is attributed to, overriding WORKLANE_ACTOR and the git user. Free text, checked against nothing";
/// What `--actor-from-git` says on every command that writes a history entry.
///
/// The counterpart to [`ACTOR_HELP`]: where that one names somebody specific, this one
/// says attribute it to the human whose checkout this is, without knowing how they spell
/// themselves.
const ACTOR_FROM_GIT_HELP: &str = "Attribute the entry to the detected git user instead of WORKLANE_ACTOR, for acting on the person's behalf. Cannot be combined with --actor";
/// Arguments that carry prose, and therefore have to accept a value starting with
/// a hyphen.
///
@@ -216,26 +236,7 @@ pub enum Command {
},
/// Move a ticket to a different status
Mv {
/// Ticket UUID or title
ticket: String,
/// Target status
#[arg(short, long)]
status: Status,
/// Force move (allows backward or non-sequential moves)
#[arg(short, long)]
force: bool,
#[arg(long, help = ACTOR_HELP)]
actor: Option<String>,
/// Why the ticket moved, recorded in the history entry beside the transition
/// it explains. Prose, so it takes a leading hyphen
#[arg(long, allow_hyphen_values = PROSE)]
reason: Option<String>,
},
Mv(MvArgs),
/// Replace fields on an existing ticket
Set(SetArgs),
@@ -285,6 +286,9 @@ pub enum Command {
/// is `chown`'s. It was `--owner`, which said the wrong one of the two.
#[arg(long, help = ACTOR_HELP)]
actor: Option<String>,
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
actor_from_git: bool,
},
/// Group tickets that have to be finished together
@@ -310,6 +314,9 @@ pub enum Command {
#[arg(long, help = ACTOR_HELP)]
actor: Option<String>,
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
actor_from_git: bool,
},
/// The tag vocabulary: what the board carries, and what each tag means
@@ -687,6 +694,33 @@ pub struct AddArgs {
pub priority: Option<u8>,
}
/// `mv` grew past a handful of parameters when `--actor-from-git` arrived, so it is a
/// struct like `set` and `append` rather than an inline variant.
#[derive(clap::Args)]
pub struct MvArgs {
/// Ticket UUID or title
pub ticket: String,
/// Target status
#[arg(short, long)]
pub status: Status,
/// Force move (allows backward or non-sequential moves)
#[arg(short, long)]
pub force: bool,
#[arg(long, help = ACTOR_HELP)]
pub actor: Option<String>,
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
pub actor_from_git: bool,
/// Why the ticket moved, recorded in the history entry beside the transition
/// it explains. Prose, so it takes a leading hyphen
#[arg(long, allow_hyphen_values = PROSE)]
pub reason: Option<String>,
}
/// `set` replaces a field outright. Owner is deliberately absent: `chown` owns that
/// field, and status is `mv`'s, so no field has two writers.
///
@@ -751,6 +785,9 @@ pub struct SetArgs {
/// command's that is logged
#[arg(long, help = ACTOR_HELP)]
pub actor: Option<String>,
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
pub actor_from_git: bool,
}
impl SetArgs {
@@ -801,6 +838,9 @@ pub struct ChownArgs {
/// change. Both are on this command because it writes both.
#[arg(long, help = ACTOR_HELP)]
pub actor: Option<String>,
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
pub actor_from_git: bool,
}
impl ChownArgs {
@@ -1002,4 +1042,44 @@ mod tests {
for two minor versions."
);
}
/// `--actor` and `--actor-from-git` are one pair that has to travel together: every
/// command that takes one takes the other, documented by the same string, because
/// the second is the first's spelling for "the human whose checkout this is".
///
/// A walker rather than five named commands, so a sixth entry-writing command fails
/// this on its own `--actor` instead of being forgotten here too.
#[test]
fn every_actor_command_takes_actor_from_git() {
let cli = Cli::command();
let mut seen = 0;
for sub in cli.get_subcommands() {
if sub.get_name() == "help" {
continue;
}
if !sub.get_arguments().any(|arg| arg.get_id().as_str() == "actor") {
continue;
}
seen += 1;
let from_git = sub
.get_arguments()
.find(|arg| arg.get_id().as_str() == "actor_from_git")
.unwrap_or_else(|| {
panic!("`{}` takes --actor but not --actor-from-git", sub.get_name())
});
assert_eq!(
from_git.get_help().map(|help| help.to_string()),
Some(ACTOR_FROM_GIT_HELP.to_string()),
"`{}` documents --actor-from-git differently",
sub.get_name()
);
}
// A guard on the walker itself: if it stopped finding commands, every assertion
// above would pass by never running.
assert_eq!(seen, 5, "expected comment, mv, chown, set and assign to carry --actor");
}
}
+6 -6
View File
@@ -11,10 +11,10 @@
//! costs one `worklane ls --ids` per keypress, which measured at 2.5ms in release on a
//! board of seventy-five tickets, comfortably below anything a person notices.
//!
//! The four statuses are half clap's: `Status` is a `ValueEnum`, so it emits them for
//! `mv --status`, but the fish generator does not emit possible values for a *positional*
//! and `ls <status>` gets nothing. Same for `completions <shell>`. So the block below
//! lists those two, from the enums rather than by hand.
//! Status values are half clap's: `Status` is a `ValueEnum`, so clap emits every one
//! of them for `mv --status`, but the fish generator does not emit possible values for
//! a *positional* and `ls <status>` gets nothing. Same for `completions <shell>`. So
//! the block below lists those two, from the enums rather than by hand.
use std::io;
@@ -231,7 +231,7 @@ complete -c worklane -n '{tag_nested}' -a '(worklane tags | cut -f1,3)'
# has a `--clear` of its own that takes a field name, and clap already offers those.
complete -c worklane -n '__worklane_command_is chown' -l clear -x -a '(worklane ls --ids)'
# clap emits the four for `mv --status`, which is an option, but the fish generator
# clap emits the statuses for `mv --status`, which is an option, but the fish generator
# emits nothing for the possible values of a positional. So the one place a status is
# positional needs them listed, and the same goes for the shell below.
complete -c worklane -n '__worklane_first_arg_of ls' -a '{statuses}' -d status
@@ -616,7 +616,7 @@ mod tests {
}
}
/// The four for `mv --status` are clap's, which is half of why `Status` is a
/// The statuses for `mv --status` are clap's, which is half of why `Status` is a
/// `ValueEnum`. If clap ever stops emitting them, the fish half has to carry them
/// too, and this is what says so.
#[test]
+343 -151
View File
File diff suppressed because it is too large Load Diff
+130 -26
View File
@@ -162,7 +162,8 @@ pub fn skills_root() -> Result<PathBuf> {
/// `NO_COLOR`. Checked against opencode 1.15.10.
///
/// Singular `tool`, though 1.15.10 loads `tools` as well: each was served in turn from a
/// directory outside any project and registered all eleven worklane tools. The singular
/// directory outside any project and registered every worklane tool the file carried,
/// eleven at the time and twenty-one at the recheck. The singular
/// is the spelling opencode's own documentation puts first, the way it writes `agent(s)`
/// and `skill(s)`.
///
@@ -489,10 +490,10 @@ mod tests {
///
/// The domain examples are the first thing an edit would quietly drop, since every
/// other skill here is written around this repo, and dropping them leaves a document
/// that teaches a household board to file `cli` tickets. The two-step repair is the
/// second: it looks like a typo until you have watched `mv` refuse the one-step
/// version, which is why the ticket for this skill demanded every repair be run rather
/// than reasoned about.
/// that teaches a household board to file `cli` tickets. The one-move correction is
/// the second: it is the repair `mv` actually performs since it learned to fix a
/// Status field that lags its directory, and an edit back to the old two-step recipe
/// would be teaching a workaround for a bug that no longer exists.
#[test]
fn the_admin_skill_stays_domain_neutral_and_keeps_its_verified_repairs() {
for required in [
@@ -500,7 +501,8 @@ mod tests {
"product strategy", //
"worklane tags add", // the vocabulary is declared through the CLI
"--tags` replaces the whole field", // the destructive one, restated where it bites
"two moves, not one", // the repair `mv` cannot do in one step
"reporting the correction instead of refusing as a no-op", // the repair `mv` does in one step
"no stamp is written and no history entry", // because the work went nowhere
"do not edit a ticket file",
"File exception", // and the three places that rule does not reach
"worklane-plan", // the boundary against the sweep document
@@ -568,7 +570,7 @@ mod tests {
}
/// The file name is the tool id prefix, not decoration: opencode names each tool as
/// the file then the export, so a renamed file renames all eleven tools and every
/// the file then the export, so a renamed file renames all twenty-one tools and every
/// permission rule that mentions one.
#[test]
fn the_tool_lands_flat_in_the_root_under_the_name_that_prefixes_its_ids() {
@@ -578,31 +580,18 @@ mod tests {
assert_eq!(TOOL.relative, "worklane.ts");
}
/// Every tool the file exports names a real subcommand.
/// Every tool the file exports names a real subcommand path.
///
/// The guard the fish completion lists already have, pointed the other way: this
/// catches a tool wrapping a command that has been renamed or dropped, which would
/// fail only when an agent finally called it. It cannot catch the reverse, a
/// subcommand the wrapper never grew a tool for, and the wrapper is behind by
/// several: `relate`, `campaign`, `assign` and `tags` have no tool. That is its own
/// ticket, and asserting it here would fail on a gap nobody has decided to close.
/// fail only when an agent finally called it. The converse, a subcommand the wrapper
/// never grew a tool for, is [`every_subcommand_outside_the_exceptions_has_a_tool`].
#[test]
fn every_tool_the_wrapper_exports_is_a_real_subcommand() {
use clap::CommandFactory;
let commands: Vec<String> = subcommand_paths();
let exported = exported_tools();
let commands: Vec<String> = crate::Cli::command()
.get_subcommands()
.map(|command| command.get_name().to_string())
.collect();
let exported: Vec<&str> = TOOL
.content
.lines()
.filter_map(|line| line.strip_prefix("export const "))
.filter_map(|rest| rest.split_whitespace().next())
.collect();
assert_eq!(exported.len(), 11, "{exported:?}");
assert_eq!(exported.len(), 21, "{exported:?}");
for name in exported {
assert!(
commands.iter().any(|command| command == name),
@@ -610,4 +599,119 @@ mod tests {
);
}
}
/// The export names in the tool file: one per `export const`, which is what makes
/// them tool ids once opencode prefixes its file name.
fn exported_tools() -> Vec<&'static str> {
TOOL.content
.lines()
.filter_map(|line| line.strip_prefix("export const "))
.filter_map(|rest| rest.split_whitespace().next())
.collect()
}
/// Every subcommand as the wrapper spells it: the CLI path joined with `_`, since
/// that is how an export name has to be spelled to be an identifier. So
/// `campaign set` is `campaign_set`, and the hyphen in `install-skill` becomes one.
///
/// Walked off clap rather than written out, the way every other guard here is:
/// a hand-maintained list is the very drift this exists to catch.
fn subcommand_paths() -> Vec<String> {
use clap::CommandFactory;
fn walk(command: &clap::Command, prefix: Option<&str>, paths: &mut Vec<String>) {
for sub in command.get_subcommands() {
let name = sub.get_name();
if name == "help" {
continue;
}
let path = match prefix {
Some(prefix) => format!("{prefix}_{name}"),
None => name.to_string(),
};
let path = path.replace('-', "_");
walk(sub, Some(&path), paths);
paths.push(path);
}
}
let mut paths = Vec::new();
walk(&crate::Cli::command(), None, &mut paths);
paths
}
/// Subcommands the wrapper deliberately does not carry, each with why it is left out.
///
/// Spelled the way [`subcommand_paths`] spells a path, so a renamed command leaves a
/// stale entry behind rather than silently exempting nothing.
const NO_TOOL: [(&str, &str); 6] = [
(
"campaign",
"a bare `worklane campaign` is refused by the CLI, its subcommand is required: the five campaign_* tools are the command",
),
(
"tui",
"the board view is for a person: it takes over the terminal and returns only when quit",
),
(
"completions",
"writes a person's shell configuration, which is not an agent's call to make",
),
(
"install_skill",
"installs the skill documents themselves, so an agent running it would rewrite its own instructions mid-session",
),
(
"install_tool",
"installs this very wrapper, which opencode reads once at startup, so reinstalling from inside changes nothing until restart",
),
(
"tags_ls",
"prints exactly what the bare `worklane tags` listing prints, and the tags tool runs that",
),
];
/// The direction that went unguarded until now: every subcommand outside the
/// exception list has a tool.
///
/// This is the gap e6e3a1b taught the README about and the completion lists have
/// never had: a new subcommand reached clap, the completions and the skill, and
/// stopped there, so an agent holding the tools could not call it at all and its
/// only way to the command was to shell out, which is the thing the wrapper exists
/// to avoid. Nothing else walks the wrapper against clap, so without this test the
/// next command lands in the same silence.
#[test]
fn every_subcommand_outside_the_exceptions_has_a_tool() {
let paths = subcommand_paths();
let exported = exported_tools();
// Guard on the walker itself: if it stopped finding subcommands, both filters
// below would pass on nothing.
assert_eq!(paths.len(), 27, "{paths:?}");
assert_eq!(exported.len(), 21, "{exported:?}");
let missing: Vec<&String> = paths
.iter()
.filter(|path| !NO_TOOL.iter().any(|(name, _)| name == path))
.filter(|path| !exported.iter().any(|tool| tool == path))
.collect();
assert!(
missing.is_empty(),
"no tool for {missing:?}. A new subcommand reaches the CLI, the completions \
and the skill, and stops there: give it a tool in assets/TOOL.ts, or name \
it in NO_TOOL with why it should not have one."
);
// An exception naming a subcommand that has gone, or carrying no reason, is
// drift of exactly the kind this test is for.
for (name, reason) in NO_TOOL {
assert!(
paths.iter().any(|path| path == name),
"the exception {name:?} names no subcommand clap has"
);
assert!(!reason.trim().is_empty(), "the exception for {name} carries no reason");
}
}
}
+45 -34
View File
@@ -8,6 +8,10 @@ mod completions;
mod handlers;
mod history;
mod install;
/// Nothing in the binary splits a line yet: the prompt that will is 3686dd6, and the
/// allow goes when it lands. The tests are what drive it in the meantime.
#[cfg_attr(not(test), allow(dead_code))]
mod split;
mod tag;
mod tui;
mod util;
@@ -42,78 +46,85 @@ fn main() -> Result<()> {
let start = std::env::current_dir()?;
match cli.command {
let mut sink = Sink::std();
let result = match cli.command {
// No subcommand opens the board, the way a bare `frig` does, and with no path
// it opens the board above the working directory.
None => run_tui(&[], &start),
Some(Command::Tui { paths }) => run_tui(&paths, &start),
Some(Command::Init) => cmd_init(&start),
Some(Command::Add(args)) => cmd_add(&args, &start),
Some(Command::Init) => cmd_init(&start, &mut sink),
Some(Command::Add(args)) => cmd_add(&args, &start, &mut sink),
Some(Command::Ls(args)) => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_ls(&args, &worklane_dir)
cmd_ls(&args, &worklane_dir, &mut sink)
}
Some(Command::Show { id }) => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_show(&id, &worklane_dir)
cmd_show(&id, &worklane_dir, &mut sink)
}
Some(Command::Mv {
Some(Command::Mv(args)) => cmd_mv(&args, &start, &mut sink),
Some(Command::Set(args)) => cmd_set(&args, &start, &mut sink),
Some(Command::Append(args)) => cmd_append(&args, &start, &mut sink),
Some(Command::Relate(args)) => cmd_relate(&args, &start, &mut sink),
Some(Command::Chown(args)) => cmd_chown(&args, &start, &mut sink),
Some(Command::Check(args)) => cmd_check(&args, true, &start, &mut sink),
Some(Command::Uncheck(args)) => cmd_check(&args, false, &start, &mut sink),
Some(Command::Comment {
ticket,
status,
force,
body,
actor,
reason,
}) => cmd_mv(&ticket, status, force, &actor, &reason, &start),
Some(Command::Set(args)) => cmd_set(&args, &start),
Some(Command::Append(args)) => cmd_append(&args, &start),
Some(Command::Relate(args)) => cmd_relate(&args, &start),
Some(Command::Chown(args)) => cmd_chown(&args, &start),
Some(Command::Check(args)) => cmd_check(&args, true, &start),
Some(Command::Uncheck(args)) => cmd_check(&args, false, &start),
Some(Command::Comment { ticket, body, actor }) => {
cmd_comment(&ticket, &body, &actor, &start)
}
actor_from_git,
}) => cmd_comment(&ticket, &body, &actor, actor_from_git, &start, &mut sink),
Some(Command::Campaign { command }) => match command {
CampaignCommand::Add(args) => cmd_campaign_add(&args, &start),
CampaignCommand::Add(args) => cmd_campaign_add(&args, &start, &mut sink),
CampaignCommand::Ls { ids } => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_campaign_ls(&worklane_dir, ids)
cmd_campaign_ls(&worklane_dir, ids, &mut sink)
}
CampaignCommand::Set(args) => cmd_campaign_set(&args, &start),
CampaignCommand::Append(args) => cmd_campaign_append(&args, &start),
CampaignCommand::Set(args) => cmd_campaign_set(&args, &start, &mut sink),
CampaignCommand::Append(args) => cmd_campaign_append(&args, &start, &mut sink),
CampaignCommand::Show { campaign } => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_campaign_show(&campaign, &worklane_dir)
cmd_campaign_show(&campaign, &worklane_dir, &mut sink)
}
},
Some(Command::Assign { campaign, ticket, actor }) => {
cmd_assign(&campaign, &ticket, &actor, &start)
}
Some(Command::Assign {
campaign,
ticket,
actor,
actor_from_git,
}) => cmd_assign(&campaign, &ticket, &actor, actor_from_git, &start, &mut sink),
// The bare form and `ls` are one arm: `worklane tags` was the listing before the
// group existed and the fish completion still calls it that way, so the two
// spellings cannot be allowed to drift into two behaviours.
Some(Command::Tags { command }) => match command {
None | Some(TagCommand::Ls) => {
let worklane_dir = find_worklane_dir(&start)?;
cmd_tags(&worklane_dir)
cmd_tags(&worklane_dir, &mut sink)
}
Some(TagCommand::Add(args)) => cmd_tag_add(&args, &start),
Some(TagCommand::Set(args)) => cmd_tag_set(&args, &start),
Some(TagCommand::Add(args)) => cmd_tag_add(&args, &start, &mut sink),
Some(TagCommand::Set(args)) => cmd_tag_set(&args, &start, &mut sink),
},
// No board either, for the reason `install-skill` has none: a completion script
// is generated from the clap definition and is the same wherever it is run.
Some(Command::Completions { shell }) => {
completions::generate(shell, &mut std::io::stdout()).map_err(Into::into)
completions::generate(shell, sink.as_write()).map_err(Into::into)
}
// No board is looked for: the point of the skill is to teach an agent worklane
// before there is a `.worklane` anywhere.
Some(Command::InstallSkill { skill, force, print }) => {
cmd_install_skill(skill.as_deref(), force, print)
cmd_install_skill(skill.as_deref(), force, print, &mut sink)
}
// No board either, and one agent rather than both: opencode loads the tool file,
// Claude Code has no path for one.
Some(Command::InstallTool { force, print }) => cmd_install_tool(force, print),
}
Some(Command::InstallTool { force, print }) => cmd_install_tool(force, print, &mut sink),
};
// The board (and every handler) own their own writing, so flush what the last one
// handed the sink before returning; an error path printed nothing to flush.
sink.flush()?;
result
}
// ---------------------------------------------------------------------- tui --
+453
View File
@@ -0,0 +1,453 @@
//! Splitting a typed line into the arguments a parser wants.
//!
//! The prompt on the board takes one string and clap takes an argv, so something has to
//! turn `comment 1b78a24 the offset was never passed` into a verb, a ticket and one body
//! with spaces in it. Splitting on whitespace hands clap five arguments where `comment`
//! takes two, which is not a grammar error to report but a tokenising step nobody ran.
//!
//! The rules are the shell's, because that is what the prompt promises: a line is spelled
//! there exactly as it is spelled in the shell. Runs of whitespace separate arguments,
//! single and double quotes group one, a backslash escapes the next character except
//! inside single quotes where it is a backslash, and an explicitly empty `''` is an
//! argument that exists and is empty — which is what `--title ""` being a usage error
//! rather than a silent clear depends on. A leading hyphen is not special here: whether
//! `--foo` is a flag or the text of a criterion is clap's question, and the prose
//! arguments already accept one.
//!
//! Two things a shell's own splitter does not have to answer, and both are why this is
//! written rather than pulled in:
//!
//! - **A line being typed is half finished.** An unterminated quote is a state to report,
//! not an error to raise, because the prompt has to keep taking characters and refuse
//! only enter. See [`Unclosed`].
//! - **Completion needs to know where the cursor is.** Which argument it sits in, counting
//! from the verb, and whether nothing of that argument lies before it. Both fall out of
//! the scan for free and neither is reachable afterwards from the arguments alone.
//!
//! One pure function over the line and the cursor, and nothing here knows about `Board`.
/// What a line is still inside when it ends.
///
/// A half-typed line is not a line that failed: `comment 1b78a24 "the offset` is a
/// sentence somebody is in the middle of, and the arguments before the quote are already
/// right. So this is a state the caller reports, and the reason enter is refused while it
/// is anything but [`Unclosed::Closed`] — the arguments up to that point are still handed
/// back, because that is what a completion or a hint has to work from.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Unclosed {
/// Nothing. The arguments are whole and the line can go to a parser.
Closed,
/// A `'` with no `'` after it.
Single,
/// A `"` with no `"` after it.
Double,
/// A trailing `\`, which has nothing yet to escape.
///
/// Not a quote, and reported the same way for the same reason: the character it will
/// escape is the next one typed. It wins over an open quote, being the inner of the
/// two, and either answer refuses the line.
Escape,
}
/// Which quote the scan is inside.
///
/// Private, because what a caller needs is [`Unclosed`], which also carries the state no
/// quote can. Two public spellings of one fact is how they come to disagree.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Quote {
Single,
Double,
}
/// One scan of a line: its arguments, where the cursor sits among them, and what the line
/// is still inside.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Split {
/// The arguments, in order, with the quotes and escapes taken off. The binary's own
/// name is not among them: prepending it is the caller's, since only the caller knows
/// what it is calling.
pub args: Vec<String>,
/// Which argument the cursor is in, counting from the verb at 0. Equal to
/// `args.len()` when the cursor is past the last one, which is the index an argument
/// typed next would take.
pub cursor_arg: usize,
/// Whether nothing of `cursor_arg` lies before the cursor, because the line up to it
/// ends in a separator or has nothing in it at all. That is the difference between
/// completing an argument and starting one.
pub at_new_arg: bool,
/// What the line is still inside, and therefore whether it can be run at all.
pub unclosed: Unclosed,
}
/// Split `line` into arguments, reading the cursor at `cursor` as a byte offset into it.
///
/// Bytes because that is what the prompt's own cursor is: a `String` inserts and removes
/// at byte indices. A cursor past the end of the line reads as the end, and one inside a
/// multi-byte character reads as being after that character, so neither can panic and
/// neither needs the caller to have clamped it first.
pub fn split_line(line: &str, cursor: usize) -> Split {
let mut args: Vec<String> = Vec::new();
// `Some("")` is an argument that has been opened and is still empty, which is what
// tells `''` from nothing at all: a bare `take()` cannot make that distinction.
let mut arg: Option<String> = None;
let mut quote: Option<Quote> = None;
let mut escape = false;
// The cursor's answer, taken at the character it falls on and never revised.
let mut at: Option<(usize, bool)> = None;
for (offset, c) in line.char_indices() {
if at.is_none() && offset >= cursor {
at = Some((args.len(), arg.is_none()));
}
if escape {
arg.get_or_insert_default().push(c);
escape = false;
continue;
}
match (quote, c) {
// The shell's exception, and the reason a criterion reading `a\b` survives
// being typed as `'a\b'`: single quotes are literal, backslash included.
(Some(Quote::Single), '\\') => arg.get_or_insert_default().push(c),
(_, '\\') => escape = true,
(None, '\'') => {
quote = Some(Quote::Single);
arg.get_or_insert_default();
}
(None, '"') => {
quote = Some(Quote::Double);
arg.get_or_insert_default();
}
(Some(Quote::Single), '\'') | (Some(Quote::Double), '"') => quote = None,
// A run of separators closes the open argument once and then finds none.
(None, ws) if ws.is_whitespace() => {
if let Some(done) = arg.take() {
args.push(done);
}
}
_ => arg.get_or_insert_default().push(c),
}
}
// Before the last argument is pushed, so a cursor at the end of the line is still in
// the argument it is typing rather than one past it.
let (cursor_arg, at_new_arg) = at.unwrap_or((args.len(), arg.is_none()));
if let Some(last) = arg {
args.push(last);
}
Split {
args,
cursor_arg,
at_new_arg,
unclosed: match (escape, quote) {
(true, _) => Unclosed::Escape,
(false, Some(Quote::Single)) => Unclosed::Single,
(false, Some(Quote::Double)) => Unclosed::Double,
(false, None) => Unclosed::Closed,
},
}
}
#[cfg(test)]
mod tests {
use super::*;
/// One line and everything the scan is supposed to say about it.
///
/// The defaults are the empty line's own answers, so a row states the rule it is about
/// and stays quiet about the rest.
struct Case {
line: &'static str,
/// Where the cursor is, or the end of the line, which is where it sits while a
/// line is being typed. Only the cursor rows move it.
cursor: Option<usize>,
args: &'static [&'static str],
cursor_arg: usize,
at_new_arg: bool,
unclosed: Unclosed,
}
impl Default for Case {
fn default() -> Self {
Case {
line: "",
cursor: None,
args: &[],
cursor_arg: 0,
at_new_arg: true,
unclosed: Unclosed::Closed,
}
}
}
/// Every field of every row, each named in its own failure: a table that reports only
/// the first mismatch makes the next run tell a different story than this one.
fn check(cases: &[Case]) {
for case in cases {
let cursor = case.cursor.unwrap_or(case.line.len());
let split = split_line(case.line, cursor);
let args: Vec<&str> = split.args.iter().map(String::as_str).collect();
let at = format!("{:?} with the cursor at {cursor}", case.line);
assert_eq!(args, case.args, "arguments of {at}");
assert_eq!(split.cursor_arg, case.cursor_arg, "cursor argument of {at}");
assert_eq!(split.at_new_arg, case.at_new_arg, "new argument of {at}");
assert_eq!(split.unclosed, case.unclosed, "unclosed state of {at}");
}
}
#[test]
fn a_line_splits_into_arguments_the_way_a_shell_splits_one() {
check(&[
// Nothing typed yet, which is the state the prompt opens in.
Case::default(),
Case {
line: "tags",
args: &["tags"],
at_new_arg: false,
..Case::default()
},
Case {
line: "mv 1b78a24 --status committed",
args: &["mv", "1b78a24", "--status", "committed"],
cursor_arg: 3,
at_new_arg: false,
..Case::default()
},
// Runs of separators collapse, at either end and in the middle, and a tab is
// one of them.
Case {
line: " mv 1b78a24 ",
args: &["mv", "1b78a24"],
cursor_arg: 2,
..Case::default()
},
Case {
line: "mv\t1b78a24",
args: &["mv", "1b78a24"],
cursor_arg: 1,
at_new_arg: false,
..Case::default()
},
// What the ticket for this was written about: one body, spaces and all.
Case {
line: "comment 1b78a24 \"the offset was never passed\"",
args: &["comment", "1b78a24", "the offset was never passed"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// Single quotes group the same, and a run of spaces inside one is not a
// separator to collapse.
Case {
line: "comment 1b78a24 'two spaces'",
args: &["comment", "1b78a24", "two spaces"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// A quote in the middle of an argument groups part of it, which is how a
// `--flag=value` carrying a space is typed.
Case {
line: "set 1b78a24 --title=\"a b\"",
args: &["set", "1b78a24", "--title=a b"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// A backslash escapes the next character: a separator, a quote, itself.
Case {
line: "comment 1b78a24 a\\ b",
args: &["comment", "1b78a24", "a b"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
Case {
line: "comment 1b78a24 \"she said \\\"no\\\"\"",
args: &["comment", "1b78a24", "she said \"no\""],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
Case {
line: "comment 1b78a24 a\\\\b",
args: &["comment", "1b78a24", "a\\b"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// Except inside single quotes, where it is a character like any other.
Case {
line: "comment 1b78a24 'a\\b'",
args: &["comment", "1b78a24", "a\\b"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// A leading hyphen is clap's business, not the splitter's.
Case {
line: "add --title --print is supported",
args: &["add", "--title", "--print", "is", "supported"],
cursor_arg: 4,
at_new_arg: false,
..Case::default()
},
// An empty quoted value is an argument that exists and is empty. Losing it
// here would turn a usage error into a silent clear.
Case {
line: "set 1b78a24 --title \"\"",
args: &["set", "1b78a24", "--title", ""],
cursor_arg: 3,
at_new_arg: false,
..Case::default()
},
Case {
line: "''",
args: &[""],
at_new_arg: false,
..Case::default()
},
]);
}
#[test]
fn a_half_typed_line_says_what_it_is_still_inside_and_hands_back_the_rest() {
check(&[
// The arguments before the open quote are already right, and the open one is
// as far as it has been typed.
Case {
line: "comment 1b78a24 \"the offset",
args: &["comment", "1b78a24", "the offset"],
cursor_arg: 2,
at_new_arg: false,
unclosed: Unclosed::Double,
..Case::default()
},
Case {
line: "comment 1b78a24 'the offset",
args: &["comment", "1b78a24", "the offset"],
cursor_arg: 2,
at_new_arg: false,
unclosed: Unclosed::Single,
..Case::default()
},
// A quote just opened is an argument that exists and is empty, the same shape
// a closed `''` leaves.
Case {
line: "comment 1b78a24 \"",
args: &["comment", "1b78a24", ""],
cursor_arg: 2,
at_new_arg: false,
unclosed: Unclosed::Double,
..Case::default()
},
// A trailing backslash has nothing yet to escape. It opened no argument, so
// the cursor is starting one.
Case {
line: "mv 1b78a24 \\",
args: &["mv", "1b78a24"],
cursor_arg: 2,
unclosed: Unclosed::Escape,
..Case::default()
},
// Inside a quote the escape is the inner of the two, and it is what the line
// is waiting on.
Case {
line: "comment 1b78a24 \"a\\",
args: &["comment", "1b78a24", "a"],
cursor_arg: 2,
at_new_arg: false,
unclosed: Unclosed::Escape,
..Case::default()
},
// A closed quote reopened is open again: the state is where the scan ended,
// not how many quotes were typed.
Case {
line: "comment 1b78a24 'a' 'b",
args: &["comment", "1b78a24", "a", "b"],
cursor_arg: 3,
at_new_arg: false,
unclosed: Unclosed::Single,
..Case::default()
},
]);
}
#[test]
fn the_split_says_which_argument_the_cursor_is_in_and_whether_it_begins_one() {
check(&[
// The line is split whole whatever the cursor is doing: only the two cursor
// answers move.
Case {
line: "mv 1b78a24",
cursor: Some(0),
args: &["mv", "1b78a24"],
..Case::default()
},
Case {
line: "mv 1b78a24",
cursor: Some(1),
args: &["mv", "1b78a24"],
at_new_arg: false,
..Case::default()
},
// At the end of the verb, still in the verb: the cursor is completing it.
Case {
line: "mv 1b78a24",
cursor: Some(2),
args: &["mv", "1b78a24"],
at_new_arg: false,
..Case::default()
},
// Past the separator, so the argument at 1 has nothing before the cursor even
// though the line goes on to hold one.
Case {
line: "mv 1b78a24",
cursor: Some(3),
args: &["mv", "1b78a24"],
cursor_arg: 1,
..Case::default()
},
// A cursor past the end of the line reads as the end of it.
Case {
line: "mv",
cursor: Some(99),
args: &["mv"],
at_new_arg: false,
..Case::default()
},
// Inside a quoted argument the cursor is in that argument, not in a fourth
// one the quotes might look like they opened.
Case {
line: "comment 1b78a24 \"the offset\"",
cursor: Some(20),
args: &["comment", "1b78a24", "the offset"],
cursor_arg: 2,
at_new_arg: false,
..Case::default()
},
// Byte offsets, so a multi-byte character before the cursor counts for its
// width and not for one: 8 is where `é` starts and 9 is inside it.
Case {
line: "comment é",
cursor: Some(8),
args: &["comment", "é"],
cursor_arg: 1,
..Case::default()
},
// A cursor inside a character reads as being after it, which is the answer
// that cannot claim an argument has not started when it has.
Case {
line: "comment é",
cursor: Some(9),
args: &["comment", "é"],
cursor_arg: 1,
at_new_arg: false,
..Case::default()
},
]);
}
}
+675 -87
View File
File diff suppressed because it is too large Load Diff
+251 -72
View File
@@ -1,7 +1,7 @@
use anyhow::{Result, anyhow};
use chrono::NaiveDateTime;
use std::fs;
use std::io::IsTerminal;
use std::io::{IsTerminal, Write};
use std::path::Path;
use std::sync::OnceLock;
@@ -303,6 +303,80 @@ pub fn color_text(text: &str, color: Color) -> String {
paint(text, color, should_use_colors())
}
/// A destination for a command's output, chosen by the caller.
///
/// `main` hands a handler its own stdout and nothing about the CLI changes; the
/// board (or a test) hands it an in-memory buffer and reads back what the command
/// said. Threading the writer and the colour decision together means every print
/// site reaches both, and a handler never asks the process about its own stdout.
///
/// `use_color` is the sink's answer, not a read of [`should_use_colors`]: a process
/// whose stdout is a pipe still wants colour when the sink is a buffer a renderer
/// will colour itself, and the board wants plain text however the terminal answers.
pub struct Sink<'a> {
writer: Box<dyn Write + 'a>,
/// Whether the bytes this sink writes carry colour escapes.
pub use_color: bool,
}
impl<'a> Sink<'a> {
/// The process's stdout, coloured by what the terminal wants.
///
/// What `main` passes, so the CLI's output is byte identical to before: every
/// command wrote to stdout through `println!`, and this sink writes to the same
/// stdout through the same [`paint`].
pub fn std() -> Sink<'static> {
// Through `new` so the process's stdout is just another writer the sink wraps.
Sink::new(Box::new(std::io::stdout()), should_use_colors())
}
/// An in-memory buffer, plain, for a test or a caller that colours the text
/// itself.
#[allow(dead_code)]
pub fn buffer(target: &'a mut Vec<u8>) -> Sink<'a> {
Sink {
writer: Box::new(target),
use_color: false,
}
}
/// Any writer, with the colour decision given.
pub fn new(writer: Box<dyn Write + 'a>, use_color: bool) -> Sink<'a> {
Sink { writer, use_color }
}
/// The writer, for a caller that already knows how to fill it (the completions
/// generator).
pub fn as_write(&mut self) -> &mut dyn Write {
&mut *self.writer
}
/// Write `text` followed by a newline, the way `println!` did.
pub fn writeln(&mut self, text: &str) -> Result<()> {
self.writer.write_all(text.as_bytes())?;
self.writer.write_all(b"\n")?;
Ok(())
}
/// Write `text` with no terminator, the way `print!` did. The caller flushes
/// when it then waits on input.
pub fn write(&mut self, text: &str) -> Result<()> {
self.writer.write_all(text.as_bytes())?;
Ok(())
}
/// Flush the writer, so a prompt reaches the terminal before a read.
pub fn flush(&mut self) -> Result<()> {
self.writer.flush()?;
Ok(())
}
/// `text` wrapped in `color`'s escape when this sink is coloured.
pub fn color(&self, text: &str, color: Color) -> String {
paint(text, color, self.use_color)
}
}
/// What sits at a candidate `.worklane` path.
///
/// The distinction the walk turns on is between nothing there and something
@@ -449,52 +523,78 @@ pub const ACTOR_ENV: &str = "WORKLANE_ACTOR";
/// The author written when nothing names one.
pub const UNKNOWN_ACTOR: &str = "unknown";
/// The actor for the whole run: the variable, then the git user.
/// The actor for the whole run, from the variable alone.
///
/// Split out from the caching wrapper for the reason `colors_wanted` is: a threaded test
/// binary cannot mutate the process environment to reach one branch at a time.
///
/// An empty `WORKLANE_ACTOR` counts as unset, the convention `colors_wanted` follows for
/// `NO_COLOR`, so a wrapper script can clear an inherited one. `git_user` is a closure
/// rather than a value because the fallback costs a subprocess and the variable usually
/// answers first.
fn session_actor(env: Option<&str>, git_user: impl FnOnce() -> Option<String>) -> Option<String> {
match env.map(str::trim).filter(|value| !value.is_empty()) {
Some(value) => Some(value.to_string()),
None => git_user(),
}
/// `NO_COLOR`, so a wrapper script can clear an inherited one. This is the half the
/// [`resolve_actor`] cache holds; the git user lives in a cache of its own, because with
/// `--actor-from-git` it has to be fetched even though the variable answered.
fn session_actor(env: Option<&str>) -> Option<String> {
env.map(str::trim)
.filter(|value| !value.is_empty())
.map(str::to_string)
}
/// The actor for one entry: the flag wins, otherwise the session's, otherwise unknown.
/// The actor for one entry, from what named one.
///
/// Free text, validated against nothing, the way the `chown` user is: there is no
/// registry of actors to check a name against.
fn entry_actor(flag: Option<&str>, session: Option<&str>) -> String {
[flag, session]
.into_iter()
.flatten()
.map(str::trim)
.find(|value| !value.is_empty())
.unwrap_or(UNKNOWN_ACTOR)
.to_string()
///
/// The chain depends on the flag. An explicit `--actor` wins outright either way. With
/// `from_git`, the git user is lifted above the session rather than added beneath it:
/// the flag says attribute this to the human, and a machine with no git user configured
/// has nobody to name, which reads [`UNKNOWN_ACTOR`] rather than quietly attributing
/// back to the agent. Without it, today's chain: the variable, then the git user.
///
/// `git_user` is a closure in both branches so the subprocess it costs is not run when
/// something ahead of it already answered.
fn entry_actor(
flag: Option<&str>,
from_git: bool,
session: Option<&str>,
git_user: impl FnOnce() -> Option<String>,
) -> String {
if let Some(name) = flag.map(str::trim).filter(|value| !value.is_empty()) {
return name.to_string();
}
if from_git {
return git_user().unwrap_or_else(|| UNKNOWN_ACTOR.to_string());
}
if let Some(name) = session.map(str::trim).filter(|value| !value.is_empty()) {
return name.to_string();
}
git_user().unwrap_or_else(|| UNKNOWN_ACTOR.to_string())
}
/// Who to attribute an entry to, from the flag the call carried.
/// Who to attribute an entry to, from the flags the call carried.
///
/// Precedence: flag, then `WORKLANE_ACTOR`, then the git user, then `unknown`. Every
/// entry the CLI writes goes through here, so a board several agents write to says which
/// of them wrote what instead of attributing all of it to one human.
pub fn resolve_actor(flag: Option<&str>) -> String {
// The session half is decided once, the way should_use_colors is: neither input can
// change mid-run, and the git user costs a subprocess.
static SESSION: OnceLock<Option<String>> = OnceLock::new();
/// Precedence: flag, then — unless `from_git` lifted it — `WORKLANE_ACTOR`, then the git
/// user, then `unknown`. Every entry the CLI writes goes through here, so a board
/// several agents write to says which of them wrote what instead of attributing all of
/// it to one human.
pub fn resolve_actor(flag: Option<&str>, from_git: bool) -> String {
// Each half is decided once, the way should_use_colors is: neither input can change
// mid-run, and the git user costs a subprocess. They are two caches rather than one,
// because baking the git user into the session's answer would leave `--actor-from-git`
// reading whatever the run's *first* call produced — with the variable set, that call
// never fetched git at all.
static VARIABLE: OnceLock<Option<String>> = OnceLock::new();
static GIT_USER: OnceLock<Option<String>> = OnceLock::new();
let session = SESSION.get_or_init(|| {
let session = VARIABLE.get_or_init(|| {
let env = std::env::var(ACTOR_ENV).ok();
session_actor(env.as_deref(), get_git_user)
session_actor(env.as_deref())
});
entry_actor(flag, session.as_deref())
entry_actor(flag, from_git, session.as_deref(), || {
GIT_USER.get_or_init(get_git_user).clone()
})
}
/// One file a search matched, and where it was found.
pub struct Found {
@@ -712,10 +812,6 @@ pub struct Resolved {
pub campaign: Vec<Cell>,
}
pub fn content_trim_colored(content: &str, resolved: &Resolved) -> String {
content_trim(content, should_use_colors(), resolved)
}
/// A section heading, its rule, and the blank line the body opens under.
///
/// The rule is measured on the name as displayed, in characters. It used to span the
@@ -1514,6 +1610,17 @@ const METADATA_ORDER: [&str; 13] = [
"Status",
];
/// What is being written, for the messages a failure carries.
///
/// A `&str` naming the thing rather than two copies of every message that names its
/// object: a campaign file is a ticket file in every way that matters here,
/// `<uuid>_<slug>.md` in a directory, and the only difference is the word a failure has
/// to use. Every message below puts it mid-sentence so there is no capital to case.
/// Lived in the handlers until the writers here started carrying the noun too; both
/// sides read these through one definition so the words cannot drift apart.
pub const TICKET: &str = "ticket";
pub const CAMPAIGN: &str = "campaign";
/// Rewrite a metadata field, adding the line when the file has no such field yet.
///
/// [`set_metadata_field`] refuses a field that is not already there, which is right for
@@ -1526,6 +1633,7 @@ pub fn set_or_insert_metadata_field(
content: &str,
field: &str,
value: &str,
noun: &str,
title: &str,
) -> Result<String> {
let prefix = format!("**{}**:", field);
@@ -1534,7 +1642,7 @@ pub fn set_or_insert_metadata_field(
metadata_field_body(line).starts_with(&prefix)
}) {
Some(updated) => Ok(updated),
None => insert_metadata_field(content, field, value, title),
None => insert_metadata_field(content, field, value, noun, title),
}
}
@@ -1543,14 +1651,26 @@ pub fn set_or_insert_metadata_field(
/// A file with no Metadata section is an error rather than an insertion. There is no
/// format to guess at there, and per 641e3d5 such a file has no fields at all, so
/// writing one above the prose would be inventing a shape nothing else reads.
fn insert_metadata_field(content: &str, field: &str, value: &str, title: &str) -> Result<String> {
///
/// The noun travels with the call rather than being spelled here, because both a ticket
/// and a campaign reach this: `campaign set --codename` inserts into a campaign, and
/// "Ticket 'v1 release' has no Metadata section" would be wrong about the one file it
/// names.
fn insert_metadata_field(
content: &str,
field: &str,
value: &str,
noun: &str,
title: &str,
) -> Result<String> {
let lines: Vec<&str> = content.lines().collect();
let heading = lines
.iter()
.position(|line| is_metadata_heading(line))
.ok_or_else(|| {
anyhow!(
"Ticket '{}' has no Metadata section, so its {} field cannot be written",
"There is no Metadata section on {} '{}', so its {} field cannot be written",
noun,
title,
field
)
@@ -1640,7 +1760,7 @@ pub fn set_status_stamp(content: &str, target: Status, now: &str, title: &str) -
match target.stamp_field() {
// Inserted on demand, the way Campaign is: every ticket written before these
// fields existed carries none of them.
Some(field) => set_or_insert_metadata_field(&content, field, now, title),
Some(field) => set_or_insert_metadata_field(&content, field, now, TICKET, title),
None => Ok(content),
}
}
@@ -1648,7 +1768,10 @@ pub fn set_status_stamp(content: &str, target: Status, now: &str, title: &str) -
/// Rewrite the title heading, the first `# ` line in the file.
///
/// `## ` headings do not match: the second character has to be a space.
pub fn set_title(content: &str, title: &str) -> Result<String> {
///
/// The noun travels with the call for the same reason [`insert_metadata_field`] carries
/// one: `campaign set --title` rewrites a campaign's heading too.
pub fn set_title(content: &str, title: &str, noun: &str) -> Result<String> {
let mut updated = String::with_capacity(content.len());
let mut found = false;
@@ -1664,7 +1787,7 @@ pub fn set_title(content: &str, title: &str) -> Result<String> {
}
if !found {
return Err(anyhow!("Ticket '{}' has no title heading", title));
return Err(anyhow!("There is no title heading on {} '{}'", noun, title));
}
Ok(updated)
@@ -3261,8 +3384,8 @@ fn show_priority(priority: Priority, colored: bool) -> String {
paint(glyph, colour, colored)
}
pub fn display_ticket_items(items: &[TicketItem]) {
let colored = should_use_colors();
pub fn display_ticket_items(sink: &mut Sink, items: &[TicketItem]) -> Result<()> {
let colored = sink.use_color;
for item in items {
let id = paint(&item.id, Color::Red, colored);
@@ -3271,15 +3394,19 @@ pub fn display_ticket_items(items: &[TicketItem]) {
let priority = show_priority(item.priority, colored);
if item.created.is_empty() {
println!(" {} ({}) {} | Owner: {} | Due: {}", priority, id, item.title, owner, due);
sink.writeln(&format!(
" {} ({}) {} | Owner: {} | Due: {}",
priority, id, item.title, owner, due
))?;
} else {
let created = paint(&item.created, Color::Cyan, colored);
println!(
sink.writeln(&format!(
" {} {} ({}) {} | Owner: {} | Due: {}",
priority, created, id, item.title, owner, due
);
))?;
}
}
Ok(())
}
pub fn collect_ticket_items(status_path: impl AsRef<Path>) -> Result<Vec<TicketItem>> {
@@ -3651,48 +3778,99 @@ mod tests {
/// closure returns a name that must not appear.
#[test]
fn the_variable_names_the_actor() {
let session = session_actor(Some("claude"), || Some("Ansho Rei".to_string()));
assert_eq!(entry_actor(None, session.as_deref()), "claude");
let session = session_actor(Some("claude"));
let git_user = || Some("Ansho Rei".to_string());
assert_eq!(entry_actor(None, false, session.as_deref(), git_user), "claude");
}
#[test]
fn the_flag_overrides_the_variable() {
let session = session_actor(Some("claude"), || None);
assert_eq!(entry_actor(Some("opencode"), session.as_deref()), "opencode");
let session = session_actor(Some("claude"));
assert_eq!(
entry_actor(Some("opencode"), false, session.as_deref(), || None),
"opencode"
);
}
/// With neither supplied the author is still the git user.
#[test]
fn the_git_user_is_the_fallback() {
let session = session_actor(None, || Some("Ansho Rei".to_string()));
assert_eq!(entry_actor(None, session.as_deref()), "Ansho Rei");
let git_user = || Some("Ansho Rei".to_string());
assert_eq!(
entry_actor(None, false, session_actor(None).as_deref(), git_user),
"Ansho Rei"
);
}
/// An empty variable counts as unset, the way `NO_COLOR` does, so a wrapper script
/// can clear an inherited one and get the git user back.
/// can clear an inherited one and get the git user back. Whitespace is the same
/// case: a shell that quotes a missing value writes one.
#[test]
fn an_empty_variable_reads_as_unset() {
let session = session_actor(Some(""), || Some("Ansho Rei".to_string()));
assert_eq!(entry_actor(None, session.as_deref()), "Ansho Rei");
// Whitespace is the same case: a shell that quotes a missing value writes one
let session = session_actor(Some(" "), || Some("Ansho Rei".to_string()));
assert_eq!(entry_actor(None, session.as_deref()), "Ansho Rei");
let git_user = || Some("Ansho Rei".to_string());
for raw in ["", " "] {
let session = session_actor(Some(raw));
assert_eq!(entry_actor(None, false, session.as_deref(), git_user), "Ansho Rei");
}
}
/// And with nothing at all, including a git that has no user configured.
#[test]
fn nothing_at_all_is_unknown() {
let session = session_actor(None, || None);
assert_eq!(entry_actor(None, session.as_deref()), UNKNOWN_ACTOR);
let session = session_actor(None);
assert_eq!(entry_actor(None, false, session.as_deref(), || None), UNKNOWN_ACTOR);
// An empty flag falls through rather than writing a blank author
assert_eq!(entry_actor(Some(""), None), UNKNOWN_ACTOR);
assert_eq!(entry_actor(Some(""), false, None, || None), UNKNOWN_ACTOR);
}
/// Free text, validated against nothing, the way the `chown` user is.
#[test]
fn an_actor_is_free_text() {
let session = session_actor(Some("claude-code, session 3 (opus)"), || None);
assert_eq!(entry_actor(None, session.as_deref()), "claude-code, session 3 (opus)");
let session = session_actor(Some("claude-code, session 3 (opus)"));
assert_eq!(
entry_actor(None, false, session.as_deref(), || None),
"claude-code, session 3 (opus)"
);
}
/// The flag is the caller acting for the person whose checkout this is: the git user
/// is lifted above the variable rather than added beneath it.
#[test]
fn from_git_lifts_the_git_user_over_the_variable() {
let session = session_actor(Some("claude"));
let git_user = || Some("Ansho Rei".to_string());
assert_eq!(entry_actor(None, true, session.as_deref(), git_user), "Ansho Rei");
}
/// An explicit `--actor` still wins outright beside the lift: it names somebody
/// specific, which is the stronger statement of the two.
#[test]
fn the_flag_wins_over_from_git_too() {
let session = session_actor(Some("claude"));
let git_user = || Some("Ansho Rei".to_string());
assert_eq!(
entry_actor(Some("opencode"), true, session.as_deref(), git_user),
"opencode"
);
}
/// The lift is not a fallback: asked to name the human and finding none configured,
/// the entry reads unknown instead of quietly attributing back to the agent.
#[test]
fn from_git_with_no_git_user_is_unknown_not_the_variable() {
let session = session_actor(Some("claude"));
assert_eq!(entry_actor(None, true, session.as_deref(), || None), UNKNOWN_ACTOR);
}
/// An empty variable still counts as unset with the lift on, which here means the
/// git user answers as usual.
#[test]
fn from_git_leaves_the_empty_variable_unset() {
let git_user = || Some("Ansho Rei".to_string());
assert_eq!(
entry_actor(None, true, session_actor(Some("")).as_deref(), git_user),
"Ansho Rei"
);
}
#[test]
@@ -4207,7 +4385,7 @@ mod tests {
let content = with_metadata("- **ID**: abc\n- **Owner**: alice\n- **Status**: backlog\n");
let updated =
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "c-uuid", "T").unwrap();
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "c-uuid", TICKET, "T").unwrap();
// Against METADATA_ORDER, so Status stays last where every file keeps it.
assert!(
@@ -4224,7 +4402,7 @@ mod tests {
let content = with_metadata("- **ID**: abc\n- **Owner**: alice\n\n## Notes\nAfter.\n");
let updated =
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "c-uuid", "T").unwrap();
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "c-uuid", TICKET, "T").unwrap();
assert!(
updated.contains("- **Owner**: alice\n- **Campaign**: c-uuid\n\n## Notes\nAfter.\n"),
@@ -4240,7 +4418,7 @@ mod tests {
with_metadata("- **ID**: abc\n- **Campaign**: first\n- **Status**: backlog\n");
let updated =
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "second", "T").unwrap();
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "second", TICKET, "T").unwrap();
assert_eq!(updated.matches("**Campaign**:").count(), 1, "{updated}");
assert!(updated.contains("- **Campaign**: second"), "{updated}");
@@ -4253,7 +4431,8 @@ mod tests {
let content = "# T\n\n## Description\n- **Campaign**: not a field\n\n\
## Metadata\n\n- **ID**: abc\n- **Status**: backlog\n";
let updated = set_or_insert_metadata_field(content, CAMPAIGN_FIELD, "c-uuid", "T").unwrap();
let updated =
set_or_insert_metadata_field(content, CAMPAIGN_FIELD, "c-uuid", TICKET, "T").unwrap();
assert!(updated.contains("- **Campaign**: not a field"), "{updated}");
assert!(
@@ -4268,7 +4447,7 @@ mod tests {
fn a_file_with_no_metadata_section_is_an_error_rather_than_an_insertion() {
let content = "# T\n\n## Description\nBody.\n";
let error = set_or_insert_metadata_field(content, CAMPAIGN_FIELD, "c-uuid", "T")
let error = set_or_insert_metadata_field(content, CAMPAIGN_FIELD, "c-uuid", TICKET, "T")
.expect_err("a file with no Metadata section gained a field");
assert!(error.to_string().contains("no Metadata section"), "{error}");
@@ -4609,7 +4788,7 @@ mod tests {
#[test]
fn a_section_rule_matches_the_width_of_its_name() {
let rendered = content_trim_colored("# T\n\n## Description\nbody\n", &Resolved::default());
let rendered = content_trim("# T\n\n## Description\nbody\n", false, &Resolved::default());
// Eleven characters, not fourteen: the rule used to span "## Description"
assert!(rendered.starts_with("Description\n───────────\n"), "{rendered:?}");
@@ -4617,7 +4796,7 @@ mod tests {
#[test]
fn a_non_ascii_section_name_is_not_over_drawn() {
let rendered = content_trim_colored("# T\n\n## Résumé\nbody\n", &Resolved::default());
let rendered = content_trim("# T\n\n## Résumé\nbody\n", false, &Resolved::default());
assert!(rendered.starts_with("Résumé\n──────\n"), "{rendered:?}");
}
@@ -4625,7 +4804,7 @@ mod tests {
#[test]
fn the_body_leaves_the_title_to_cmd_show() {
let rendered =
content_trim_colored("# Only Once\n\n## Description\nbody\n", &Resolved::default());
content_trim("# Only Once\n\n## Description\nbody\n", false, &Resolved::default());
assert!(!rendered.contains("Only Once"), "{rendered:?}");
// And no gap where it was
@@ -4635,7 +4814,7 @@ mod tests {
#[test]
fn the_metadata_section_renders_as_a_table_inside_the_body() {
let content = "# T\n\n## Metadata\n\n- **ID**: abc\n- **Owner**: alice\n";
let rendered = content_trim_colored(content, &Resolved::default());
let rendered = content_trim(content, false, &Resolved::default());
assert_eq!(rendered, "Metadata\n────────\n\nID abc\nOwner alice\n");
}
@@ -4748,7 +4927,7 @@ Plain line with **bold** and a [link](http://x.test/a).
#[test]
fn a_section_after_metadata_still_renders() {
let content = "# T\n\n## Metadata\n\n- **ID**: abc\n\n## Notes\n\nafter\n";
let rendered = content_trim_colored(content, &Resolved::default());
let rendered = content_trim(content, false, &Resolved::default());
assert!(rendered.contains("ID abc"), "{rendered:?}");
assert!(rendered.contains("Notes\n─────\n"), "{rendered:?}");
+14
View File
@@ -574,6 +574,12 @@ fn chmod(path: &Path, mode: u32) {
/// itself, and it is named with the ticket and the path rather than raised as a bare io
/// error. The branch this replaces could not fire at all: the filename carries a fresh
/// uuid, and its message claimed the title was taken.
///
/// The add stages through `write_then_replace` like every other write, so the temp
/// lives under `.worklane/`, outside the directory the chmod keeps closed, and the
/// rename is the step that fails here. Both halves have to be gone afterwards: no half
/// ticket in backlog, and no `.wl-*.tmp` beside it, which is what `stray_files` checks
/// for a move.
#[test]
fn add_names_the_ticket_and_the_path_when_the_write_fails() {
let temp = TempDir::new().unwrap();
@@ -596,6 +602,14 @@ fn add_names_the_ticket_and_the_path_when_the_write_fails() {
chmod(&backlog, 0o755);
assert_eq!(fs::read_dir(&backlog).unwrap().count(), 0);
let strays: Vec<String> = fs::read_dir(&worklane)
.unwrap()
.filter_map(|e| e.ok())
.map(|e| e.file_name().into_string().unwrap())
.filter(|name| name.starts_with(".wl-"))
.collect();
assert_eq!(strays, Vec::<String>::new(), "the staging file was left behind");
}
/// The board above the project is real and empty, and stays empty: a dangling
+46
View File
@@ -262,6 +262,52 @@ fn the_actor_flag_overrides_the_variable() {
assert!(only_comment(&worklane, &uuid).contains("**Author**: opencode"));
}
/// The flag for acting on the person's behalf: their name is what the machine already
/// knows, so the entry does not have to wait for the agent to know it too.
#[test]
fn the_actor_from_git_flag_names_the_git_user_over_the_variable() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
let uuid = create_ticket(&worklane, "backlog", "From Git Test");
Command::cargo_bin(BIN_NAME)
.unwrap()
.current_dir(temp.path())
.env("WORKLANE_ACTOR", "claude")
.env("GIT_CONFIG_GLOBAL", git_config_naming(&temp, "Configured User"))
.env("GIT_CONFIG_NOSYSTEM", "1")
.arg("comment")
.args([&uuid, "Written for the person"])
.arg("--actor-from-git")
.assert()
.success();
assert!(only_comment(&worklane, &uuid).contains("**Author**: Configured User"));
}
/// The lift is not a fallback: with no git user configured there is nobody to name, and
/// the entry reads unknown rather than quietly attributing back to the agent.
#[test]
fn from_git_with_no_git_user_is_unknown_even_with_the_variable() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
let uuid = create_ticket(&worklane, "backlog", "No Git User Test");
Command::cargo_bin(BIN_NAME)
.unwrap()
.current_dir(temp.path())
.env("WORKLANE_ACTOR", "claude")
.env("GIT_CONFIG_GLOBAL", temp.path().join("no-such-gitconfig"))
.env("GIT_CONFIG_NOSYSTEM", "1")
.arg("comment")
.args([&uuid, "Written with nobody to name"])
.arg("--actor-from-git")
.assert()
.success();
assert!(only_comment(&worklane, &uuid).contains("**Author**: unknown"));
}
/// An empty variable counts as unset, the convention `NO_COLOR` follows, so a wrapper
/// script can clear an inherited one and get the git user back.
#[test]
+88
View File
@@ -1145,6 +1145,94 @@ fn mv_does_not_restamp_a_no_op_move() {
assert_eq!(ticket_at(&worklane, "committed", &filename), before);
}
/// A ticket whose file sits in one status directory while its Status field says another
/// is a hand-moved file or a partial restore. Moving it to the status it already sits in
/// is the repair: the field is rewritten to agree with the directory and reported as a
/// correction rather than refused as a no-op.
#[test]
fn mv_repairs_a_lagging_status_field_instead_of_refusing() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
let filename = stamped_ticket(&worklane, "done");
let drifted = ticket_at(&worklane, "done", &filename)
.replace("- **Status**: done", "- **Status**: backlog");
fs::write(worklane.join("done").join(&filename), &drifted).unwrap();
let out = move_ticket(&temp, "cccc3333", "done", false);
let stderr = String::from_utf8_lossy(&out.stderr);
assert!(out.status.success(), "{stderr}");
let stdout = String::from_utf8_lossy(&out.stdout);
assert!(stdout.contains("Corrected Status field"), "{stdout}");
assert!(stdout.contains("backlog"), "{stdout}");
// Not a move: nothing was relocated and only the field changed, byte for byte.
assert!(worklane.join("done").join(&filename).exists());
assert_eq!(md_files(&worklane.join("backlog")), Vec::<String>::new());
assert_eq!(
ticket_at(&worklane, "done", &filename),
drifted.replace("- **Status**: backlog", "- **Status**: done")
);
}
/// The repair corrects bookkeeping rather than moving work, so it stamps nothing and
/// logs nothing: an entry shaped like a transition would record a journey the ticket
/// never took.
#[test]
fn a_repair_writes_no_stamp_and_no_history_entry() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
let filename = stamped_ticket(&worklane, "backlog");
// A real move first, so the ticket carries the stamp and the log entry that a
// repair has to leave alone.
let out = move_ticket(&temp, "cccc3333", "committed", false);
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
let history = worklane
.join("history")
.join("cccc3333cccc3333cccc3333cccc3333cccc");
assert_eq!(md_files(&history).len(), 1);
let content = ticket_at(&worklane, "committed", &filename);
assert!(content.contains("Committed On"), "{content}");
let drifted = content.replace("- **Status**: committed", "- **Status**: done");
fs::write(worklane.join("committed").join(&filename), &drifted).unwrap();
let out = move_ticket(&temp, "cccc3333", "committed", false);
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
let repaired = ticket_at(&worklane, "committed", &filename);
assert!(repaired.contains("Committed On"), "{repaired}");
assert!(!repaired.contains("Submitted On"), "{repaired}");
assert_eq!(md_files(&history).len(), 1, "the repair logged an entry");
}
/// The mirror drift, a field ahead of its directory from a crash mid-move, repairs the
/// same way when the caller keeps the ticket where it sits rather than moving it on to
/// where the field claims.
#[test]
fn mv_repairs_a_field_ahead_of_its_directory_too() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
let filename = stamped_ticket(&worklane, "backlog");
let drifted = ticket_at(&worklane, "backlog", &filename)
.replace("- **Status**: backlog", "- **Status**: done");
fs::write(worklane.join("backlog").join(&filename), &drifted).unwrap();
let out = move_ticket(&temp, "cccc3333", "backlog", false);
let stderr = String::from_utf8_lossy(&out.stderr);
assert!(out.status.success(), "{stderr}");
let stdout = String::from_utf8_lossy(&out.stdout);
assert!(stdout.contains("Corrected Status field"), "{stdout}");
assert!(worklane.join("backlog").join(&filename).exists());
assert!(
ticket_at(&worklane, "backlog", &filename).contains("- **Status**: backlog"),
"{}",
ticket_at(&worklane, "backlog", &filename)
);
}
// ---------------------------------------------------------------- discarded --
/// Discarding is not a stage of work, so it is reachable from wherever the ticket
+65
View File
@@ -316,6 +316,71 @@ fn an_annotation_that_would_read_as_a_heading_is_refused() {
assert!(!temp.path().join(".worklane").join("tags.md").exists());
}
/// A tab anywhere in an annotation is refused by `tags add`, because the listing's fields
/// are tab separated: past the first tab everything after it reads as a fourth field. The
/// refusal says why, and nothing is written — the value parser refuses before the handler
/// runs, so not even a placeholder file is left behind.
#[test]
fn an_annotation_carrying_a_tab_is_refused_by_tags_add() {
let temp = TempDir::new().unwrap();
setup_worklane(&temp);
let out = run(&temp, &["tags", "add", "bug", "-a", "Something\twrong."]);
let stderr = String::from_utf8_lossy(&out.stderr);
assert!(!out.status.success(), "{stderr}");
assert!(
stderr.contains("tab") && stderr.contains("separates its fields"),
"{stderr}"
);
assert!(!temp.path().join(".worklane").join("tags.md").exists());
// No staged write survived either, so the directory holds only the status folders.
let left: Vec<_> = fs::read_dir(temp.path().join(".worklane"))
.unwrap()
.map(|e| e.unwrap().file_name())
.collect();
assert_eq!(left.len(), 4, "{left:?}");
}
/// The same value is refused by `tags set`, and the declaration that is already there is
/// untouched.
#[test]
fn an_annotation_carrying_a_tab_is_refused_by_tags_set() {
let temp = TempDir::new().unwrap();
setup_worklane(&temp);
run(&temp, &["tags", "add", "bug", "-a", "Something wrong."]);
let before = vocabulary(&temp);
let out = run(&temp, &["tags", "set", "bug", "-a", "Now\twith a tab."]);
assert!(!out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
assert_eq!(vocabulary(&temp), before);
}
/// Ordinary prose is unaffected, paragraphs included: the refusal is for the tab alone,
/// which is what keeps it from standing in front of the command's whole purpose.
#[test]
fn an_annotation_without_a_tab_is_taken_whatever_its_shape() {
let temp = TempDir::new().unwrap();
setup_worklane(&temp);
run(
&temp,
&[
"tags",
"add",
"bug",
"-a",
"A defect.",
"-a",
"",
"-a",
"--plan is prose",
],
);
assert_eq!(declared(&temp, "bug").as_deref(), Some("A defect.\n\n--plan is prose"));
}
/// The file is made on demand, the way `campaign add` makes the campaigns directory: a board
/// that predates the vocabulary must not need `worklane init` run over it.
#[test]
+120
View File
@@ -72,6 +72,29 @@ fn run(temp: &TempDir, args: &[&str]) -> Output {
.clone()
}
/// Run as an agent acting for the person: the variable still names the agent, the git
/// config names the human, and the flag is what tells the two apart.
fn run_for_the_human(temp: &TempDir, args: &[&str]) -> Output {
Command::cargo_bin(BIN_NAME)
.unwrap()
.current_dir(temp.path())
.env("WORKLANE_ACTOR", "claude")
.env("GIT_CONFIG_GLOBAL", git_config_naming(temp, "Ansho Rei"))
.env("GIT_CONFIG_NOSYSTEM", "1")
.args(args)
.assert()
.get_output()
.clone()
}
/// A git config file holding nothing but a `user.name`, for the tests that need the
/// fallback to answer something known instead of whatever the machine is configured with.
fn git_config_naming(temp: &TempDir, name: &str) -> PathBuf {
let path = temp.path().join("gitconfig");
fs::write(&path, format!("[user]\n\tname = {}\n", name)).unwrap();
path
}
/// Every entry on the ticket, name and content, in the order the log sorts them.
fn entries(worklane: &Path) -> Vec<(String, String)> {
let dir = worklane.join("history").join(UUID);
@@ -562,3 +585,100 @@ fn the_actor_flag_names_the_writer_on_every_command_that_writes_one() {
assert!(content.contains("**Author**: opencode"), "{name}: {content:?}");
}
}
/// The lift is spelled the same on every command that writes an entry, and it raises
/// the git user over the variable on each of them.
#[test]
fn actor_from_git_names_the_git_user_on_every_command_that_writes_one() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
create_ticket(&worklane, "backlog");
run(
&temp,
&[
"campaign",
"add",
"--title",
"First release",
"--codename",
"v1",
],
);
run_for_the_human(&temp, &["comment", UUID, "By hand.", "--actor-from-git"]);
run_for_the_human(&temp, &["mv", UUID, "--status", "committed", "--actor-from-git"]);
run_for_the_human(&temp, &["chown", "bob", UUID, "--actor-from-git"]);
run_for_the_human(&temp, &["set", UUID, "--tags", "beta", "--actor-from-git"]);
run_for_the_human(&temp, &["assign", "v1", UUID, "--actor-from-git"]);
let found = entries(&worklane);
assert_eq!(found.len(), 5, "{found:?}");
for (name, content) in found {
assert!(content.contains("**Author**: Ansho Rei"), "{name}: {content:?}");
}
}
/// Both flags answer the same question — who is the entry attributed to — so a call
/// carrying both is a usage error at parse time rather than a last-wins answer. Refused
/// before any ticket is resolved, so nothing reaches the log.
#[test]
fn actor_and_actor_from_git_are_refused_together() {
let temp = TempDir::new().unwrap();
let worklane = setup_worklane(&temp);
create_ticket(&worklane, "backlog");
let calls: [&[&str]; 5] = [
&[
"comment",
UUID,
"Body.",
"--actor",
"opencode",
"--actor-from-git",
],
&[
"mv",
UUID,
"--status",
"committed",
"--actor",
"opencode",
"--actor-from-git",
],
&[
"chown",
"bob",
UUID,
"--actor",
"opencode",
"--actor-from-git",
],
&[
"set",
UUID,
"--tags",
"beta",
"--actor",
"opencode",
"--actor-from-git",
],
&[
"assign",
"v1",
UUID,
"--actor",
"opencode",
"--actor-from-git",
],
];
for call in calls {
let output = run(&temp, call);
assert_eq!(output.status.code(), Some(2), "{call:?} was not a usage error");
}
assert!(
!worklane.join("history").join(UUID).exists(),
"an entry was written despite the usage error"
);
}