Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f16e2aba0c | ||
|
|
bf7d8e05d8 | ||
|
|
30a2b3429e | ||
|
|
69bc2feef5 | ||
|
|
8675f22209 | ||
|
|
f183d4635a | ||
|
|
668263605c | ||
|
|
d0a8f9a284 | ||
|
|
c3efebe9b3 | ||
|
|
e26e5893f7 | ||
|
|
bfce4cf2f4 | ||
|
|
b439ad9c41 | ||
|
|
455f04d136 | ||
|
|
cac21a94f5 | ||
|
|
8c599440e5 | ||
|
|
a92dbf552f | ||
|
|
b93b8e1b81 | ||
|
|
f0f88025f3 | ||
|
|
00a64adca8 | ||
|
|
0f0767ac00 | ||
|
|
7994d98913 |
@@ -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
|
||||
@@ -171,9 +172,21 @@ and this file is for what someone changing worklane's own code needs.
|
||||
### Relating Tickets
|
||||
|
||||
- **The Relations section is `relate`'s alone.** `RELATIONS` is in the section table but deliberately out of `section_args`, so `set` and `append` cannot reach it: a relation names a target that has to be resolved to a uuid first, and a prose flag would let an unresolvable line into the one section that is read back by machine. Same rule as Owner and Status, one field one writer
|
||||
- **`relate --clear <kind> <target>` is the removal, and it is on `relate` rather than on `set`** for the same reason the section is absent from `section_args`: one writer owns both directions, the way `chown` owns setting an owner and clearing one. It names the target and not just the kind, because a ticket can hold several relations of one kind and emptying all of them is not what anybody is asking for. That is also why it is not spelled like `set --clear`, which names a field and empties the whole of it
|
||||
- **The two values are one flag, so clap cannot type them apart.** `num_args = 2` is per occurrence, which is what makes an odd number a usage error and every chunk a full pair; `RelateArgs::cleared` splits the pairs and parses the kind, so a bad kind is refused before the ticket is resolved. It exits 1 rather than clap's 2, which is the price of a two-value flag and the reason `RelationKind::parse_value` names the three in its message
|
||||
- **Both spellings of the kind are accepted**, `blocked-by` from the flag and `blocked by` from the label. Both are in front of the reader: the flag is what recorded the relation and the label is what `show` prints and what the file stores, so refusing the printed form would be a trap for anyone clearing a row they just read. `RelationKind::flag` is a match rather than `label().replace(' ', "-")`, so the flag, the `--clear` value and the completion list cannot drift apart
|
||||
- **`find_relation` searches the ticket's own edges before the board, and that order is the feature.** A dangling edge is the case most likely to need clearing, and no search of the board can reach a target whose ticket is gone, so the id-prefix tier over the stored targets is the only one that finds it. `MIN_ID_SEARCH` is the floor `resolve_in` puts under its own id tier and the comparison is case insensitive for the same reason. Two stored targets under one prefix name the candidates rather than guessing, which is what an ambiguous ticket search already does
|
||||
- **An edge the ticket does not hold reports no change; a target naming nothing at all is an error.** The two are different facts: the first is the state the caller asked for, and the second is a typo that reporting no change would swallow. The resolver's own reason is carried through, so an ambiguous search says so instead of being reported as nothing found
|
||||
- **Recording and clearing the same relation in one call is refused, and the check runs on what was *asked* for.** `items` drops the additions already in the file, so comparing against that would let `--blocked-by X --clear blocked-by X` quietly remove an existing X. `requested` is the full list for exactly that reason. The refusal is `set --clear`'s: nothing is written rather than one direction silently winning
|
||||
- **Removals rewrite the section and additions are appended to the result, in that order.** Two passes rather than one rebuild, so a call with no `--clear` takes exactly the path it always took and `append_section_body` goes on deciding where a new line lands. Rewriting from the parsed relations is lossless because a line that is not a relation is already an error. The last edge leaves `clear_section_body`'s placeholder, which is the line `append` treats as no content, so the next `relate` replaces it instead of writing under it
|
||||
- **A relation is not logged, either direction.** `relate` writes no history entry and neither does `--clear`, which keeps the two consistent; per the history rule, an edge that matters enough to explain gets a comment. Do not add an entry for the removal alone: a log that recorded only the destructive half would read as though the additions had never happened
|
||||
- **`add` does not write the section.** The plan on 4179958 asked for it in the ticket writer; it is out on purpose. A `_No relations._` block in every new ticket is noise in every `show`, and the insertion path has to exist regardless for every ticket written before the section did, so leaving it out means one path that is always exercised rather than two
|
||||
- **The full uuid is stored, not the seven characters `ls` prints.** It resolves without a scan and cannot turn ambiguous as the board grows. `show` renders the short id and the target's title instead: the file is the machine's copy, the output is the reader's
|
||||
- **One direction is stored and the inverse is derived.** `blocked by` goes on the gated ticket rather than `blocks` on the blocker, because the gated ticket is the one whose move is refused and whose author knows about the dependency. `relates to` is symmetric and is written once, on whichever end the caller ran it from. `RelationIndex::inbound` finds the far end by scanning, which is what keeps `relate` a single-file write
|
||||
- **A derived row that reads exactly like a stored one is dropped, and the stored one is kept.** Both ends of a symmetric relation could hold a line, since nothing stopped it until 03bdc76, and the block then drew the same neighbour twice under the same label. The stored row survives because it is the line `relate --clear` can address; the derived one is on a file this ticket does not own
|
||||
- **The dedupe keys on the label and the target, not the kind and the target.** Two tickets each blocking the other is two facts and the block says both, `blocked by` from this end and `blocks` from the other; keying on the kind would fold them into one row and lose half of what the ticket says. Only a symmetric kind can collide with its own stored line, and `RelationKind::is_symmetric` derives that from `label() == inverse_label()` rather than naming `RelatesTo`, so a kind added later answers by construction
|
||||
- **`relate` also refuses to store the mirror, which is the other half of the same fix.** The dedupe repairs a board that already holds both directions; the refusal stops it recurring. `mirrored` in `cmd_relate` reads the target's own relations and reports no change, gated on `is_symmetric` because a target holding `blocked by <this>` is a cycle rather than a duplicate. 4179958 decided `relates to` is written once and not onto both files; for six months nothing enforced it
|
||||
- **A symmetric edge is cleared from the end that stores it.** With both ends holding a line, `--clear` on one leaves the other's, which then draws as the derived row: correct, since the far end still asserts the relation, and the reason the dedupe keeps the stored row rather than the derived one
|
||||
- **A line in the section that is not a relation is an error naming the ticket**, not a line quietly dropped. Nothing but `relate` writes there, so a bad line means a hand-edited file. The TUI is the deliberate exception: `detail_of` falls back to no block, since one corrupt ticket must not take the whole board down
|
||||
- **The block is built outside `content_trim` and passed in.** Half of it comes from other tickets and `content_trim` has only the body. It is spliced over the stored lines where the file has the section, and injected ahead of the metadata where it does not, because a ticket that is only pointed at has no section of its own and still has relations to show
|
||||
- `ensure_section` inserts against `SECTION_ORDER`, before the first following section that is actually in the file, and adds no blank line that was not already there. A handwritten `## Notes` between the plan and the metadata therefore keeps its place, and Metadata is in that list as an anchor rather than as something anything appends to
|
||||
@@ -235,9 +248,12 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- The draw aligns the focused column again on its own geometry, so a resize between keypress and frame cannot hide the selection, and caps every column against blank space past its last card. The stored value may go stale after a tick shrinks the column; that is fine, because what is drawn is corrected immediately and the next navigation writes the correction back
|
||||
- Entering another column follows the selection rather than resetting to its top. The card index carries across columns, so a reset would open the column with the highlight below the fold whenever it was — the opposite of the detail view's reset-on-selection-move, where each ticket genuinely starts at its own top. The index is shared and clamps permanently when a shorter column pulls it down, so a column you return to follows the selection to where it now sits rather than holding your old place
|
||||
- **The footer names only keys that work.** It read `↑↓ scroll` when nothing scrolled at all, which sends the reader looking for their own mistake. A UI that misdescribes itself is worse than one that is merely incomplete
|
||||
- **A hint is a key and what pressing it does, and `key_hint` is the only thing that draws one.** The key is cyan and bold, the description takes the terminal's default foreground, and the row keeps its three-space gaps. Everything that names a key goes through it: the three footer states, the prompt's two keys, the picker's row and the `q board` on the frame's border, so a reader learns the shape once. Same division in frig and pantop, each in its own accent colour, cyan here and magenta there — the three tools are read side by side and used to look like three programs
|
||||
- **A key that is its description's first letter is merged into it**, so the board draws `quit`, `campaign` and `tag` with the letter coloured and no letter in front, while `y copy id`, `ctrl-c quit`, `d show done (2)` and every arrow row stay split. Two cells back on a row already at its width naming eight keys, and the coloured letter *is* the key either way. The prefix test in `key_hint` is case sensitive for exactly that reason: a row naming both `r` and `R` would otherwise draw one word for the two of them, and the merged form can only say which key it is while the letter on screen is that key. It also means the row carries both forms at once, which is the cost of the two cells
|
||||
- **What the row is cannot be read off its text any more, so the tests read its cells.** `footer_cells`, `footer_at`, `keys_on` and `footer_style` in the test module: `keys_on(.., "quit")` is `Some(1)` where `q` quits and `Some(0)` on a row whose only `quit` is the tail of `ctrl-c quit`. A `contains("q quit")` cannot tell those apart, and three of the guards that keep 1b78a24 out were written that way
|
||||
- **`q` and `esc` are one key: close what is open, quit when there is nothing left to close.** `q` used to set `should_quit` outright, so a reader who pressed it to put a ticket away lost the board instead, which is not what `q` does anywhere else that lays a document over a list. One match arm in `main.rs`, not two: two arms carrying one rule is how a later edit changes it for one key and not the other
|
||||
- **The rule is `Board::dismiss`, not the match arm.** The dispatch in `main.rs` is not reachable from a test, so anything decided there is undecidable by the suite. The arm is the line that names the keys and nothing else. `the_dispatch_gives_q_and_esc_one_arm_and_leaves_ctrl_c_quitting` scans `main.rs` for what the arm cannot say for itself, over whitespace-collapsed source so rustfmt cannot fail it
|
||||
- **The footer's last slot always answers how to get out**, and with a ticket open the honest answer is `ctrl-c`, the only key left that quits in one press. Going on saying `q quit` there would be 1b78a24 in the other direction: a footer describing a key by what it used to do
|
||||
- **The footer's last slot always answers how to get out**, and with a ticket open the honest answer is `ctrl-c`, the only key left that quits in one press. Going on drawing the merged `quit` there would be 1b78a24 in the other direction: a footer describing a key by what it used to do. `ctrl-c quit` is split by the same rule that merges the other, being no word's first letter
|
||||
- **The overlay names its ticket on the border, not at the head of the paragraph.** `Board::detail` is a `Detail` carrying the title, the id and the text, because the name has to travel beside the body rather than inside it: `content_trim` drops the `# ` heading on purpose, since `cmd_show` prints it, and anything in the paragraph scrolls away
|
||||
- `detail_title` cuts the string itself instead of leaving it to ratatui, which truncates an overlong block title at whatever cell it reaches and would take the id with it. Cut against the inner width, so the id survives whole and the name ends in an ellipsis. The id goes first because that is how every other view addresses a ticket
|
||||
- The detail view renders from cells, never from painted strings: ratatui draws styled spans, so an escape sequence in a paragraph would be printed as literal bytes. `content_trim` and `format_history_with` take the colour decision for the CLI's side of the same layouts
|
||||
@@ -255,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
|
||||
@@ -274,21 +290,30 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- **The toggle re-clamps the frame offset, through `scroll_frame(0, screen)`.** A taller viewport has a smaller last offset than a shorter one, so where the reader was can end up past the end of the frame they just asked for. The draw clamps on its own geometry either way, but the stored value has to be clamped too or the next `pgup` counts down from a number the frame never showed. A scroll of no pages is that clamp and nothing else, which keeps it in the one place it lives
|
||||
- **The frame is out of reach from under an open ticket.** With the overlay open, up and down step through the tickets and it follows, so a selection that reached the frame would have to either close it on an arrow key or leave it showing a ticket nothing is selecting. `an_open_ticket_keeps_the_scroll_keys_from_the_frame` builds that state by hand for exactly this reason: the precedence has to hold whether or not a keypress can reach it
|
||||
- **The standing comes from the columns, not from a walk of the tree.** While a campaign is selected the columns *are* its members, done included, so `Tab::standing` counts what is already in hand rather than paying what `campaign ls` pays per campaign. Counted over every column, drawn or not: hiding done is a change to what is drawn and never to what is counted
|
||||
- **The way out is on the frame's own border, not in the footer.** `q board` sits on the thing it takes away, and the footer row was already at its width naming eight keys. Dropped whole when it and the standing would meet, the rule the page indicator follows
|
||||
- **The way out is on the frame's own border, not in the footer.** `q board` sits on the thing it takes away, and the footer row was already at its width naming eight keys. Dropped whole when it and the standing would meet, the rule the page indicator follows, and measured over its spans rather than one string since it is a key hint like any other. Drawn through `key_hint` and not as grey chrome: it is the one key on the board named anywhere but the footer, and a reader who has learnt to look for the cyan letter should not need a second convention to find it. The indicator beside it stays grey, having no key in it
|
||||
- **`c` and `t` are named in the footer only on a closed board with nothing filtered**, which is where a reader has to find them. Over an open ticket and on a filtered board they are left out: the frame's border then says how to put the filter away, and the row has no cells to spare. The tag used to be drawn on that row in its own colour, for want of a frame to draw it in, and 2a83bd4 took that away rather than saying it twice. Incomplete rather than wrong, which is the trade this row is allowed to make — what it must never do is name a key by what it used to do
|
||||
- **The footer has three states, because the selection has three places to be.** An open ticket, the frame, and the cards. On the frame it names `↓ board`, `enter expand` or `enter collapse`, the two scroll keys and `y copy id` — `y copy tag` on a tag frame — and leaves out `←→` because they do nothing there. It has to say which way `enter` goes, since the key is a toggle and the frame is always at one of its two heights. `↑ frame` is not named on the board, on the same trade `c` is dropped on: the frame is drawn directly above the columns and up is the key that reaches it. Nor is the way to collapse an expanded frame named from the cards, which is the same trade again — the frame is right there and `↑` reaches it
|
||||
- **The footer has three states, because the selection has three places to be.** An open ticket, the frame, and the cards. On the frame it names `↓ board`, `↵ expand` or `↵ collapse`, the two scroll keys and `y copy id` — `y copy tag` on a tag frame — and leaves out `←→` because they do nothing there. It has to say which way `↵` goes, since the key is a toggle and the frame is always at one of its two heights. `↑ frame` is not named on the board, on the same trade `c` is dropped on: the frame is drawn directly above the columns and up is the key that reaches it. Nor is the way to collapse an expanded frame named from the cards, which is the same trade again — the frame is right there and `↑` reaches it
|
||||
- **`picker: Option<Picker>` is the whole mode**, the shape `search` and `detail` use, and `Board::picker_key` runs beside `search_key` ahead of the action arms for the same reason: an open list owns the keyboard, so `d` must not toggle done and `q` must not quit while a campaign is being chosen. `ctrl-c` is the one key it declines and every other control combination is swallowed, or `ctrl-d` would reach the arm bound to `d`
|
||||
- **The picker's rows are `Tab::campaigns`, not a copy taken when it opened**, so a campaign filed elsewhere appears in an open picker on the next tick. It opens on the campaign already selected, so `c` on a filtered board says where you are as well as offering somewhere to go, and a board with no campaigns gets a `Notice` rather than an empty box that has to be dismissed to learn it was empty
|
||||
- **`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
|
||||
@@ -321,11 +346,32 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- Id and title only, per 3b16540, both lowercased. The title has to be case insensitive to be worth typing, and giving the id the same treatment lets a pasted id match whatever case it was copied in. An empty or all-space query matches **nothing** rather than everything
|
||||
- **The jump goes through `select_at`, the tail `select_card` already used.** `follow_selection` scrolls the column the card is in, and the offsets are per column and on the `Tab`, so a jump across columns moves the right one; `refresh_detail` keeps an open overlay on the ticket the selection names. A second version of either is how a jump comes to scroll differently from the arrow keys
|
||||
- **A hit closes the prompt and a miss keeps it open**, marked, with the selection untouched. The query can then be corrected in place instead of retyped from `/`. Doing nothing visible is what makes a reader retype a query that was already right
|
||||
- **The prompt takes the whole footer row**, because the key list it replaces describes nothing that currently works while every key is going into the buffer. The typed query is drawn in the default foreground and the keys in grey: one is content, the other is chrome. `no match` is brightred beside the query it is about, since grey chrome is what a reader skips
|
||||
- **The prompt takes the whole footer row**, because the key list it replaces describes nothing that currently works while every key is going into the buffer. Its two keys are drawn as every other key is, cyan on the key and the default foreground on the word. That the query then sits in the same foreground as the descriptions is what the house style costs on this row, and the cursor is what says which half is an input — which it does in a terminal with no colour at all. `no match` stays brightred beside the query it is about, being the one thing on the row that is neither a key nor what was typed
|
||||
- **The real terminal cursor goes after the query**, not a glyph standing in for one. ratatui shows the cursor only for a frame that asked for it, so `set_cursor_position` is also what says "you are typing" while the query is still empty. Clamped to the row, so a query longer than the terminal leaves it on the last cell
|
||||
- Both closed footers name `/`, since the jump works with a ticket open as well: it moves the selection and the overlay follows
|
||||
- Out of scope on purpose, each its own ticket once the input mode exists: `n` and `N` for the next and previous match, searching the description, tags or owner, regex, and filtering the board down to matches rather than selecting one
|
||||
|
||||
### The Command Prompt
|
||||
- **`prompt: Option<Prompt>` is the whole mode**, the shape `search` and `detail` use: open and content cannot disagree, and closing it leaves nothing to reset. `Prompt` carries the line, the cursor as a byte offset into it, and `refused`, which is `Search::missed` with something to say
|
||||
- **`Board::prompt_key` is third in the pre-dispatch**, beside `search_key` and `picker_key` and on the same contract: while a command is being typed `q` is a letter, `d` leaves the columns alone and `tab` stays out of the project tabs, and `ctrl-c` is the one key declined. It takes no `Size`, because nothing it does measures the board — the keypress that will is 53ffb94, which redraws on what the command wrote. Only one of the two prompts can be open at once: `:` is reachable from the action arms alone, and while either has the keyboard the other's key is a character in a line
|
||||
- **`esc` and `enter` are the mode's own keys and are answered in `prompt_key`; everything else belongs to the line and goes to `Prompt::key`.** That is also what keeps the borrow straight, since closing the prompt takes the whole board and editing takes only the prompt. Left, right, home, end, backspace and `ctrl-w` behave as they do in a shell, and `ctrl-w` eats the separators behind the cursor before the word behind those, so one press at the end of `mv 1b78a24 ` takes the id. There is deliberately no `tab`: suggesting the selected ticket is 00a14e7, and until then it is a key that must not reach the tabs
|
||||
- **The grammar is clap's, with nothing restated.** The line is tokenised by `split_line`, the binary's own name goes in front, and the arguments go to the same `Cli` definition the shell reaches, so a flag added to a command is typeable here the day it is added. Through `Cli::command().try_get_matches_from_mut` rather than `try_parse_from`, for what the matches give back: `command_name` walks the subcommands to name what resolved (`campaign show`, not `campaign`) instead of a `match` over every variant, which would be a second list of every verb the CLI has and one that goes stale silently
|
||||
- **`refused` is cleared by an edit and not by a movement.** The message is about the line, and moving the cursor does not change the line. `Prompt::key` clears it in the three arms that write to the line
|
||||
- **A line that ends inside a quote never reaches clap.** That is what `Unclosed` is for: a grammar complaint about a sentence nobody finished describes the wrong thing. Enter on an empty line, or one of nothing but separators, closes the prompt with nothing said, the way `esc` does — the bare form of the CLI opens a board and there is one on the screen
|
||||
- **Enter resolves the line and does not run it**, so the notice says `parsed, not run yet` rather than reading like a move that happened, and the prompt's own key is drawn as `↵ check`. Both are replaced by 53ffb94, which is the ticket that runs it; naming the key `run` here would be the fault 1b78a24 was, in the other direction
|
||||
- **What a refused line shows is clap's own message with the usage block cut off**, which is also what drops the `--help` line after it. `--help` is the exception: it parses as an error of the kind that means *print this* and what it would print is a page, so it is caught and answered in a row's worth of words, or clap's help lands on the alternate screen the way an unsunk `println!` would. `--version` goes through the ordinary path, because what it prints is one line by construction. `ColorChoice::Never` on the command, so nothing that reaches the row carries an escape
|
||||
- **The keys' width comes off the row before the line is windowed**, so a long command does not push them off the end; a message takes the row from the keys instead, since the reader has just been told something and `esc` and `enter` still do what they did. `prompt_window` anchors the window on the cursor's right edge, which costs the text *after* the cursor on a long line: keeping both ends needs a scroll offset in state, and the draw is where the width is known and the state is not writable
|
||||
- `: command` is named in every footer state, because the key works in every one of them
|
||||
|
||||
### Splitting a Typed Line
|
||||
- **`split_line` is the whole module, and it knows nothing about `Board`.** The command prompt reads one string and clap reads an argv, so `comment 1b78a24 the offset was never passed` has to be tokenised before anything can parse it: split on whitespace it is five arguments and `comment` takes two. A pure function over the line and the cursor is what makes every rule reachable from a unit test, and it is in a file of its own rather than in `tui.rs`, which is eleven thousand lines already
|
||||
- **The rules are the shell's, because that is what the prompt promises**: the line is spelled there exactly as it is spelled in the shell. Runs of whitespace separate arguments, single and double quotes group one, a backslash escapes the next character *except* inside single quotes where it is a backslash, and an explicitly empty `''` is an argument that exists and is empty — which is what `--title ""` being a usage error rather than a silent clear depends on. A leading hyphen is not special here: whether `--foo` is a flag or the text of a criterion is clap's question, and `PROSE` already answers it
|
||||
- **Written rather than pulled in, for the two answers a shell's own splitter does not owe anybody.** A line being typed is half finished, so an unterminated quote is a state to report and not an error to raise: `Unclosed` says which quote is open, or that the line ends on a backslash with nothing yet to escape, and the arguments up to that point are handed back anyway, because that is what a hint or a completion has to work from. And completion needs the cursor: which argument it is in counting from the verb, and whether nothing of that argument lies before it, which is the difference between completing an argument and starting one. Both fall out of the one scan and neither is reachable afterwards from the arguments alone
|
||||
- **`Some("")` is an argument that has been opened and is still empty**, which is the only thing that tells `''` from nothing typed at all. The cursor's answer is taken *before* the last argument is pushed, so a cursor at the end of the line is in the argument being typed rather than one past it
|
||||
- The cursor is a byte offset, because that is what the prompt's own cursor is: a `String` inserts and removes at byte indices. Past the end reads as the end and inside a multi-byte character reads as after it, so nothing panics and no caller has to clamp first
|
||||
- `Unclosed::Escape` wins over an open quote, being the inner of the two, and either answer refuses the line
|
||||
- The binary's own name is not among the arguments: prepending it before `Cli::try_parse_from` is the caller's, since only the caller knows what it is calling
|
||||
|
||||
### The Copy Key
|
||||
- **`y` copies the selected card's short id, over OSC 52 written by hand.** The board is where a ticket is found and the CLI is where it is acted on, and the only thing joining them was seven characters retyped off the screen. `y` reads as yank to the readers a keyboard board is for, and was the letter left: `q`, `esc`, `enter`, `space`, `hjkl`, the arrows, `pgup`, `pgdn`, `tab`, `backtab`, `d` and `/` were taken
|
||||
- **The mechanism was chosen against ssh**, which is where a board is often read. An escape sequence is the only one of the three ways that crosses the connection, since it is the terminal at the reader's end that owns the clipboard. A crate (`arboard` and its kind) wants X11 and Wayland libraries at build time, and on X11 the selection belongs to the process that set it: copy an id, quit, and the paste buffer is empty, which is precisely this flow. Shelling out to `wl-copy`, `xclip` or `pbcopy` is platform sniffing plus a process spawn, and does nothing on a machine where none of them is installed or on the far end of a connection. crossterm 0.28 is what ratatui 0.29 pins and it ships no clipboard command, and the backend types have to match whatever ratatui pins, so a newer crossterm cannot be picked up on its own
|
||||
@@ -342,7 +388,11 @@ and this file is for what someone changing worklane's own code needs.
|
||||
|
||||
### The Relations Block
|
||||
- **One builder, two painters.** `relation_rows` decides which edges there are, what they are called and which direction comes first; `relation_cells` decides the layout, the mark and the colours; `paint_cells` turns cells into escapes for the CLI and `span_of` turns the same cells into ratatui spans for the board. Two builders producing one block in two shapes is a pair free to disagree about ordering or padding, which is what this shape exists to prevent
|
||||
- **`Cell` is the unit both renderers take**: a run of text and the colour it is drawn in, `None` for the default foreground. The same trick as the palette itself, where `Color::ansi()` and `From<Color> for ratatui::style::Color` keep one colour from existing for one renderer and not the other
|
||||
- **`Cell` is the unit both renderers take**: a run of text, the colour it is drawn in and the modifier it carries, `None` for the default foreground and for text drawn as it stands. The same trick as the palette itself, where `Color::ansi()` and `From<Color> for ratatui::style::Color` keep one colour from existing for one renderer and not the other, and `Modifier` is that trick a second time for the styles that are not colours
|
||||
- **`Modifier` is the first style on a cell that is not a colour**, and it is an enum with one variant for the reason the palette is one: `Modifier::ansi()` is SGR 9 and `From<Modifier> for ratatui::style::Modifier` is `CROSSED_OUT`, so a style that exists for one renderer and not the other is a compile error. Bold is not in it, because bold rides inside `Color::Magenta.ansi()` and `span_from` adds it back from the colour alone; a second modifier goes here beside the strike. It is independent of the colour, so a struck run keeps whatever colour its column already gave it
|
||||
- **`Cell::struck` is a builder, not a third constructor.** The strike is decided a whole row at a time and the cells of that row are built by the layout that already chose their colours, so `relation_cells` maps it over the row it has just finished rather than threading the decision through every cell it makes
|
||||
- **`RESET` is a constant both writers share.** `paint` opens a colour and `paint_cell` may open a modifier ahead of one, and a reset that only knew about the colour would leave the strike running to the end of the line
|
||||
- **`Body::push_cell` merges on the whole style, not the colour alone.** Nothing outside the relations block carries a modifier today, and a merge keyed on the colour would silently strike a plain run through the moment one did
|
||||
- **`reference_cells` is the one spelling of a cross reference.** The relations block and the Campaign field both go through it, so a dangling reference reads the same way wherever it is shown. There was a `reference_cell` beside it that painted the cells for the CLI; once the whole body became cells the Campaign field stopped needing a string and it was the last caller, so it is gone
|
||||
- **A row carries two marks, kind then status**: what sort of edge this is, then how far the ticket at the other end has got. `blocked by × ◐ (6ce2c47) Title`. Two questions are asked of this block and one glyph could not answer both: which rows hold this ticket up, and whether the ones that do are finished
|
||||
- The status went through one bad shape first. It was a rising bar, `▁▄▆█`, as the only mark, which read as an undifferentiated column of blocks and left the kind to five long words that blur when a ticket carries several. Then the kind took the column alone and the status was lost. Both, in that order, is the answer
|
||||
@@ -363,7 +413,7 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- **`colored` still reaches `content_parts`, and it no longer means paint.** It says whether *this* renderer can carry a colour at all, and one thing turns on it: `**bold**` gives its markers up to the colour that replaces them, so a renderer with none has to keep them or the emphasis is lost rather than moved. The board passes `true`, `content_trim` passes the CLI's decision, and a piped `show` still reads its markers. Nothing else in the body consults it
|
||||
- **Magenta means bold, and `span_from` is where the board learns that.** `Color::Magenta.ansi()` is `\x1b[1;35m`, so the CLI draws every bold run bold as well as magenta, and `From<Color>` can carry only the colour. Without the modifier added on the board's side the same cell would be painted two ways, which is the one thing the shared layout exists to prevent
|
||||
- **The conversion is pinned from both ends.** `show_prints_the_same_body_it_printed_before_the_cells_conversion` holds a body with one of every painted run and asserts the CLI's output byte for byte, written from what it printed before the change, so the risk in sharing a layout, the CLI's output drifting to suit the board, fails the suite. `the_whole_body_is_styled_in_the_overlay_and_no_escape_reached_it` is the other end and is paired the way the guideline demands: a renderer that dropped every colour passes the absence, and one that went back to painting strings passes the presence
|
||||
- **The history block arrives as cells too, so nothing in the overlay is flat.** `history_cells` lays the block out once; `format_history` is those cells through `paint_cells` and the board pushes the same ones as a `Cells` part after the body, since the log lives outside the ticket file and `content_parts` never sees it. Pinned from both ends the way the body is: `show_prints_the_same_history_it_printed_before_the_cells_conversion` holds the CLI's output byte for byte, and `the_history_block_is_styled_in_the_overlay_and_no_escape_reached_it` pairs the presence with the absence (f3e099e, closing the gap e4d0bb7 left)
|
||||
- **The history block arrives as segments too, so nothing in the overlay is flat.** `history_parts` splits the entries into flow runs and quoted runs in one walk; `history_cells` is their flatten, which is what makes the CLI's bytes a property of the segmentation rather than a second walker free to drift from it, and the board reads the same parts and lays each out itself. Pinned from both ends the way the body is: the pins over `format_history` hold the flatten byte for byte, and `the_block_splits_into_flow_and_quoted_parts` pins which runs are whose
|
||||
|
||||
### Finding the Board
|
||||
- **`find_worklane_dir` classifies the entry before it follows it.** `exists()` follows a link, so a `.worklane` that was a dangling symlink answered the same as no `.worklane` at all: the walk carried on up the tree and the first board above the project became the one every write landed in, silently. `classify` reads `symlink_metadata` first and answers one of four, `Absent`, `Board`, `Dangling` or `NotADirectory`, and **`Absent` is the only one the walk carries on from**. A `.worklane` that is there but unusable is this project's board and is reported, not handed upward
|
||||
@@ -388,8 +438,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
|
||||
@@ -409,7 +460,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
|
||||
@@ -432,11 +483,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
|
||||
@@ -461,8 +512,11 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- Priority ramp → brightred (1), red (2), orange (3), cyan (4), grey (5). Green is deliberately absent: it means title
|
||||
- Relation kind mark → brightred `×` blocked by and blocks, cyan `→` relates to, orange `←` regression of and regressed by. A small ramp inside one column, the way the priority meter is: the mark says which kind of edge the row is, so none of these three is a colour standing in for the uuid or the title beside it. Brightred on the cross rather than red, because the id one cell to its right is red and the two would blend. It is the colour and the glyph a held-up card already carries, which is the point: one vocabulary for blocking
|
||||
- Relation status mark → grey `○` backlog, orange `◐` committed, cyan `◐` reviewing, green `●` done, grey `●` discarded, grey `?` for a target the board does not hold. Discarded takes the full circle of done in the grey of the untouched pile: nothing is left to do, and it is not an achievement. The *pair* is what has to be unique, which is the same bargain the two half circles already take, and `every_status_has_a_mark` pins it against `status_dirs`. The second ramp in that column: the shape says how far the target has got and the colour tells the two middle stages apart, since both are half circles. **Green is here and deliberately absent from the priority ramp**, where it would sit on a whole line and read as a title; on a one-cell mark with no title behind it, it is the obvious colour for finished and nothing else wants it. Orange keeps the meaning it already has, Status, and grey keeps unset for the one row with no status to show
|
||||
- **Relation row to a discarded target → struck through, the whole row.** The one thing in the palette that is not a colour, and it is here because the status mark cannot carry it: that mark is one cell in a column of five states, so a row pointing at abandoned work reads as a live dependency, which is exactly what it is not. The strike says the relation no longer stands for anything while the row stays on the ticket, for completeness and for the case the target is moved back out of discarded. Only discarded: a done target still stands for the fact that it was a blocker, and a `_missing_` one says something different again, that the row cannot be resolved at all. Gutter and padding included, so the line runs unbroken from the label to the end of the title, and every cell opens its own SGR 9 since each is closed by its own `RESET`
|
||||
- **The strike is under the colour flag, like every other escape.** A piped `show` carries none of it, the same bargain committed and reviewing already take for being told apart by colour alone, and the board draws it as a style instead. Do not answer the pipe by changing the glyph in the mark column: the pair there has to stay unique, and `every_status_has_a_mark` is what says so
|
||||
- Markdown link → cyan, markers and url kept. Not a new meaning for the colour: the plan numbers, the criterion numbers and the `relates to` mark are already cyan inside a rendered body, and a link is the same kind of thing, a pointer the reader may follow rather than a value. The url is not hidden behind the text the way a renderer would hide it, because `show` prints to a terminal worklane cannot assume will make it clickable, and a link whose target cannot be read is worse than a long line
|
||||
- Chrome → grey. The footer's key names, a rendered `[ ]`, and the overlay's page indicator. Not a new slot: grey already means "what a reader skips", which is the other half of the unset-value meaning, and none of these is a value. The indicator in orange would read as the title it faces across the overlay, in cyan as a timestamp, and in the priority ramp's colours as a level
|
||||
- Chrome → grey. A rendered `[ ]`, the overlay's page indicator and the frame's. Not a new slot: grey already means "what a reader skips", which is the other half of the unset-value meaning, and none of these is a value. The indicator in orange would read as the title it faces across the overlay, in cyan as a timestamp, and in the priority ramp's colours as a level
|
||||
- **A key name → cyan, and bold; what pressing it does → the default foreground.** The one place the palette spends a colour on something that is not a value: a key is what a reader is hunting for on a row they otherwise skip, and with the key merged into its description the colour is the only thing saying which letter to press. Not a second meaning for the timestamp's cyan in any place the two could be confused — nothing on the footer, the prompt or a border hint holds a value at all — and it is the accent frig draws the same row in, which is the point. Grey stays on the chrome around it: the page indicator, and the row's gaps
|
||||
- Chrome → grey, in the history block too: the kind label at the head of a mechanical row, and the `From` on a comment's author line. Both name their row rather than holding a value, which is what grey already says. The label was orange, which means Status everywhere else, so an `owner` or `tags` label claimed a meaning belonging to the value beside it
|
||||
- **A value in the history block takes the colour it has in the metadata table three lines above.** A status is orange, a tags entry goes through the same `tag_cells` the Tags field does, a campaign codename takes `tag_color` bare the way `Codename` does, and `_Not set_`, `_None_` and `_missing_` are grey. An owner stays plain: a person's name is the one value the palette has no meaning for, and spending a colour on the field that needs it least is how a colour stops meaning anything. The block's job is to be scanned, and it is not worth scanning if it has a palette of its own to learn first
|
||||
- History actor → its name through `tag_color`, the way a campaign codename is. Not a new meaning for a reserved colour but the existing use of the tag slots, a name that groups rows: one writer is one colour in every entry it wrote, so a reader sees who has been working a ticket without reading the same name four times. `claude`, `opencode` and a person each get their own
|
||||
@@ -478,7 +532,8 @@ and this file is for what someone changing worklane's own code needs.
|
||||
|
||||
### Code Organization
|
||||
- **`change` and `split_change` are a pair, and they live beside each other in `history.rs`.** The mechanical body is stored as one string, `before → after`, so painting the halves means splitting it, and the separator is a constant the writer and the reader share. A renderer with its own copy of the spacing would go on splitting on a separator the writer no longer emits, and would say so by drawing a whole body as one half. The split is `split_once`, so a value carrying the arrow itself keeps it
|
||||
- **The history block indents by who is talking.** A comment's body sits at four spaces and the reason under a mechanical row at two; the author line stays at column 0 and is told from a mechanical row by its `From` and its colour instead. The rule a reader learns is that an indented line is somebody's own words and a line of values at column 0 is the tool reporting itself
|
||||
- **The history block quotes who is talking.** Every line of a comment's body draws behind a grey bar spanning the whole run, paragraph breaks included, the way quoted text is drawn — d447e04, taking the review of 2733b10's answer over that ticket's uniform prefix and b304b17's per-line indent, both of which left the continuation at column 0. The reason under a mechanical row draws the same bar. The author line stays at column 0 and is told from a mechanical row by its `From` and its colour instead; the rule a reader learns is that a barred line is somebody's own words and a line of values at column 0 is the tool reporting itself. With colour off the glyph goes but the width it occupied stays, as spaces derived from the drawn form in `quoted_cells`, so a pipe keeps the column without an escape byte
|
||||
- **A quote is one segmentation, two shapes, and the shapes split on wrapping.** The CLI prefixes each stored line — `quoted_cells`, which is why a terminal soft-wrapping a wide line draws continuations bare: a pipe has no width to honour, and `show` does not wrap by hand. The board quotes as geometry instead (8020e48): a `HistoryPart::Quoted` run becomes an overlay section laid out as two columns, a two-cell gutter holding the grey bar top to bottom and the body beside it, so a row the prose wraps onto inherits the mark from the gutter rather than from its own first characters. `Detail` holds sections for this reason — flow stretches full width, quotes beside their gutters — and the clamp sums the sections' wrapped heights, so scroll and draw measure one total. The newline history writes after every quote is consumed by the section builder rather than drawn: it used to close the quote's last line and the section boundary does that now, so drawing it would bank a blank row no entry ever had. `QUOTE_BAR` lives in `util.rs` because both renderers draw it, not because they draw it the same way
|
||||
- **`history.rs` owns the log end to end**: the path, the kinds, the parse, the write, the count and the render. It came out of `util.rs` and `handlers.rs`, where the reader, the writer, the counter and the renderer sat in three files and one of them was 5,500 lines. The test for the reason is the module doc: a reader asking what an entry is has one file to open, the way `campaign.rs` and `tag.rs` answer their own questions
|
||||
- The body's painters return cells, not strings: `ordered_cells`, `inline_cells`, `metadata_cells`, `metadata_value_cells`, `tag_cells` and `push_heading`. `content_trim_colored` is the CLI entry point and `paint_cells` is the only thing that writes an escape. `colorize_line` is gone: it was a `pub` alias for the bold pass with one caller, and the only thing it added was asking the terminal
|
||||
- **`inline_cells` walks the line once for both inline markers**, `**bold**` and `[text](url)`, rather than running one pass over the output of the other. A second pass would be scanning text that already holds escape sequences, and `\x1b[36m` carries an opening bracket, so the link scan would take the escape for markup. The source is the only string in which either marker means what it says. It was `colorize_bold` while links lived in a branch of their own in `content_parts`; that branch is gone, which is also what gives the criteria text and the metadata `Other` rows their links, since those already went through this function
|
||||
@@ -488,6 +543,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
@@ -1503,7 +1503,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "worklane"
|
||||
version = "0.31.4"
|
||||
version = "0.32.15"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"assert_cmd",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "worklane"
|
||||
version = "0.31.4"
|
||||
version = "0.32.15"
|
||||
edition = "2024"
|
||||
|
||||
[dependencies]
|
||||
|
||||
@@ -13,11 +13,11 @@ Worklane is a local Kanban flow for agentic software development.
|
||||
| `worklane mv <id> --status <target> [-f]` | Moves ticket between statuses. Default: forward only, one stage at a time. `-f` bypasses both restrictions. `--status discarded` is exempt and reachable from anywhere, for a ticket that will not be done; leaving `discarded` is a backward move and needs `-f`. Discarding is refused while open tickets are blocked by the ticket, `-f` overrides. Records a `status` entry in the ticket's history, after the move: a refused or no-op move records nothing. `--actor` names the writer of that entry |
|
||||
| `worklane set <ticket>` | Replaces fields with `--title`, `--description`, `--acceptance`, `--plan`, `--tags`, `--due`, `--priority`. At least one required. Changing the title renames the file, keeping the UUID. `--clear <field>` returns a field to unset instead, repeatable, taking `due`, `tags`, `priority`, `description`, `acceptance` or `plan`, and writing back exactly what `add` writes for a field it was never given. No `title`, which addresses the ticket, and no `owner`, which is `chown`'s. Replacing and clearing the same field in one call is refused. `--tags` records a `tags` entry in the ticket's history, with the tags before and after, and it is the only field of this command's that is logged; `--actor` names the writer of that entry |
|
||||
| `worklane append <ticket>` | Adds to a section with `--description`, `--acceptance`, `--plan`. At least one required. The description gains a paragraph; list items go on the end, steps numbered on from the last |
|
||||
| `worklane relate <ticket>` | Records an edge to another ticket with `--blocked-by`, `--regression-of` or `--relates-to`, each repeatable. At least one required. Only the ticket named is written; `show` derives the other end by scanning. `mv` refuses to move a ticket blocked by one that is not done, unless `-f` |
|
||||
| `worklane relate <ticket>` | Records an edge to another ticket with `--blocked-by`, `--regression-of` or `--relates-to`, each repeatable. At least one required. Only the ticket named is written; `show` derives the other end by scanning, and a derived row that reads exactly like a stored one is drawn once. `relates to` on a ticket whose target already stores it reports no change, since it is the same edge; `blocked by` and `regression of` read differently from the far end, so a mutual pair is two rows. `mv` refuses to move a ticket blocked by one that is not done, unless `-f`. `--clear <kind> <target>` takes an edge off instead, repeatable, the kind spelled either way, `blocked-by` or `blocked by`. The target resolves against the edges the ticket holds first, by id prefix, which is the only way to reach one whose ticket has been deleted, then as an ordinary ticket search. An edge the ticket does not hold reports no change; a target naming nothing at all is an error. Recording and clearing the same edge in one call is refused |
|
||||
| `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 |
|
||||
|
||||
@@ -55,6 +55,7 @@ worklane mv <TAB> the same, then --status <TAB> for the five
|
||||
worklane chown alice <TAB> the ticket, which is the second argument here
|
||||
worklane chown --clear <TAB> the ticket, which the flag carries here
|
||||
worklane relate x --blocked-by <TAB>
|
||||
worklane relate x --clear <TAB> the three kinds, not a ticket: the kind comes first
|
||||
worklane campaign show <TAB> the campaigns, from `campaign ls --ids`
|
||||
worklane assign <TAB> the same, since a campaign comes first here
|
||||
worklane ls --campaign <TAB> and again
|
||||
|
||||
+14
-6
@@ -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
|
||||
|
||||
|
||||
+63
-21
@@ -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`
|
||||
@@ -201,13 +203,38 @@ directory beside them, for a repo that has no board yet.
|
||||
worklane relate 1b78a24 --blocked-by 4179958 # this one waits on that one
|
||||
worklane relate 1b78a24 --regression-of 6d327df # this one broke that one's fix
|
||||
worklane relate 1b78a24 --relates-to 7bfb9fc # neighbours, no dependency
|
||||
worklane relate 1b78a24 --clear blocked-by 4179958 # take that edge off again
|
||||
```
|
||||
|
||||
One flag per kind, and each repeats. The ticket comes first and the flag says what it is
|
||||
to the target, so read the call as a sentence: `relate A --blocked-by B` means A waits
|
||||
on B. **Only one side is stored**, on the ticket you name, and `show` derives the other
|
||||
on B.
|
||||
|
||||
**`--clear` is how an edge comes off, and it names the kind and the target**, because a
|
||||
ticket can hold several relations of one kind and emptying all of them is rarely what is
|
||||
wanted. Repeat the flag for more. The kind is spelled either way, `blocked-by` as the flag
|
||||
records it or `blocked by` as `show` prints it. `set --clear` does not reach relations:
|
||||
`relate` is the only writer of the section, so it owns both directions.
|
||||
|
||||
The target is resolved against the edges the ticket already holds first, by id prefix,
|
||||
and only then as an ordinary ticket search. That order is what lets you clear an edge
|
||||
whose target has been **deleted**, which is the case most likely to need it: `show` draws
|
||||
it as `_missing_` with a `?` mark and `mv` warns about it on every move, and no search of
|
||||
the board can reach a ticket that is gone.
|
||||
|
||||
An edge the ticket does not hold reports no change. A target that names nothing at all is
|
||||
an error rather than a no-op, so a mistyped id does not read as success. Recording and
|
||||
clearing the same edge in one call is refused outright, the way `set` refuses a field it
|
||||
is also replacing, and nothing is written. **Only one side is stored**, on the ticket you name, and `show` derives the other
|
||||
end for the ticket at the far side, so never record both directions.
|
||||
|
||||
`relates to` reads the same from both ends, so recording it on the second ticket is
|
||||
refused as no change: the edge is already there, from the far side. `blocked by` and
|
||||
`regression of` are different: the far end reads as `blocks` and `regressed by`, so two
|
||||
tickets each blocking the other is two facts and the block shows both. A symmetric edge
|
||||
comes off with `--clear` at the end that stores it, since that is the only end holding a
|
||||
line to remove.
|
||||
|
||||
`--blocked-by` is enforced: `mv` refuses to move a ticket while a ticket it is blocked by
|
||||
is not in `done` or `discarded`, whichever move it is, and names every open blocker. `-f`
|
||||
moves it anyway, beside the backward and skipping moves it already allows. It is enforced
|
||||
@@ -231,6 +258,10 @@ pair shares a glyph, and **your output is a pipe, so you do not get the colour**
|
||||
`◐` as under way and `●` as nothing left to do, and if it matters which of the two,
|
||||
`worklane show` on that target says so in its Status field. `○` is unambiguous without it.
|
||||
|
||||
A row pointing at a **discarded** target is struck through on a terminal, since a
|
||||
relation to abandoned work otherwise reads as a live dependency. That is a style rather
|
||||
than a character, so a pipe does not get it either: ask the target's Status field.
|
||||
|
||||
## Campaigns
|
||||
|
||||
A campaign groups the tickets that have to be finished together: a release, a migration,
|
||||
@@ -336,30 +367,41 @@ Read the block before picking a ticket up: it says whether somebody has already
|
||||
|
||||
## Who your entries are attributed to
|
||||
|
||||
Every comment carries an author, and by default that is the git user of the machine you
|
||||
are running on, which is the human whose checkout it is and not you. Set
|
||||
`WORKLANE_ACTOR` in your own environment and it becomes the author of every entry you
|
||||
write, so a board several agents write to says which of them said what:
|
||||
Every entry carries an author, and yours comes from `WORKLANE_ACTOR`, which your harness
|
||||
sets before you run anything. **Assume it is set for you, and never spell yourself out on
|
||||
a call** — a plain `worklane comment` is already attributed to you, which is what keeps a
|
||||
board several agents write to saying which of them said what. It is configured once,
|
||||
where your session's environment lives: `env` in `~/.claude/settings.json` for Claude
|
||||
Code, and the environment opencode is started with for opencode, since it passes its own
|
||||
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
|
||||
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_ACTOR=claude worklane comment 1b78a24 "The offset was never passed to the widget."
|
||||
worklane mv 1b78a24 --status done --actor "Ansho Rei"
|
||||
```
|
||||
worklane mv 1b78a24 --status done --actor "Ansho Rei"
|
||||
```
|
||||
|
||||
Set it once where your session's environment is configured, not on each call: `env` in
|
||||
`~/.claude/settings.json` for Claude Code, and the environment opencode is started with
|
||||
for opencode, since it passes its own environment to the tools it runs. `--actor`
|
||||
overrides it for one call and is spelled the same on every command that writes an entry,
|
||||
`comment`, `mv`, `chown`, `set` and `assign`. An empty value counts as unset and falls
|
||||
back to the
|
||||
git user, and with nothing at all the author is `unknown`. It is free text, checked
|
||||
against nothing: name yourself something a person reading the board will recognise.
|
||||
Under a missing or empty variable the author falls back to the git user of the machine —
|
||||
the human whose checkout it is — and with neither, `unknown`. It is free text, checked
|
||||
against nothing: whatever name you pass, make it one a person reading the board will
|
||||
recognise.
|
||||
|
||||
On `chown`, `--actor` is not the user argument: `worklane chown alice 1b78a24` makes alice
|
||||
the ticket's owner, and `--actor` says who made that change.
|
||||
|
||||
If the variable is not set and you cannot set it, pass `--actor` rather than letting the
|
||||
comment claim to be the user's.
|
||||
|
||||
## Shell completions
|
||||
|
||||
```
|
||||
|
||||
+373
@@ -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}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
+138
-29
@@ -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 {
|
||||
@@ -852,12 +892,17 @@ pub struct AppendArgs {
|
||||
/// Each flag repeats, so several relations of one kind land in a single call. The
|
||||
/// targets are ticket searches, resolved by the same three tiers every other ticket
|
||||
/// argument is, and stored as the target's uuid.
|
||||
///
|
||||
/// `--clear` is the other direction, and it is here rather than on `set` for the reason
|
||||
/// Relations is absent from `section_args`: a relation names a target that has to be
|
||||
/// resolved first, so its one writer owns both adding and removing, the way `chown` owns
|
||||
/// both setting an owner and clearing one.
|
||||
#[derive(clap::Args)]
|
||||
#[command(group(
|
||||
clap::ArgGroup::new("relation_kinds")
|
||||
.required(true)
|
||||
.multiple(true)
|
||||
.args(["blocked_by", "regression_of", "relates_to"])
|
||||
.args(["blocked_by", "regression_of", "relates_to", "clear"])
|
||||
))]
|
||||
pub struct RelateArgs {
|
||||
/// Ticket UUID or title
|
||||
@@ -874,6 +919,18 @@ pub struct RelateArgs {
|
||||
/// Ticket this one is merely related to. Symmetric, so it is recorded once
|
||||
#[arg(long, value_parser = non_empty)]
|
||||
pub relates_to: Vec<String>,
|
||||
|
||||
/// Take a relation off: the kind, then the ticket it points at. Repeat the flag
|
||||
///
|
||||
/// Two values rather than one, because a ticket can hold several relations of one
|
||||
/// kind and emptying every `blocked by` on it is not usually what is wanted. That is
|
||||
/// also why this is not `set --clear`, which names a field and empties the whole of
|
||||
/// it: the "value" here is one edge among several, so the target has to be named too.
|
||||
///
|
||||
/// A `Vec<String>` because clap cannot type the two values of one flag apart.
|
||||
/// [`RelateArgs::cleared`] is where the pairs are split and the kind is parsed.
|
||||
#[arg(long, num_args = 2, value_names = ["KIND", "TARGET"], value_parser = non_empty)]
|
||||
pub clear: Vec<String>,
|
||||
}
|
||||
|
||||
impl RelateArgs {
|
||||
@@ -886,6 +943,18 @@ impl RelateArgs {
|
||||
(RelationKind::RelatesTo, &self.relates_to),
|
||||
]
|
||||
}
|
||||
|
||||
/// The relations asked to be taken off, as a kind and the search naming the target.
|
||||
///
|
||||
/// `num_args = 2` is per occurrence, so clap has already refused an odd number of
|
||||
/// values and every chunk is a full pair. A kind that is not one of the three is
|
||||
/// refused here, before the ticket is resolved and long before anything is written.
|
||||
pub fn cleared(&self) -> anyhow::Result<Vec<(RelationKind, &str)>> {
|
||||
self.clear
|
||||
.chunks(2)
|
||||
.map(|pair| Ok((RelationKind::parse_value(&pair[0])?, pair[1].as_str())))
|
||||
.collect()
|
||||
}
|
||||
}
|
||||
|
||||
/// `check` and `uncheck` are separate commands rather than one verb with a flag,
|
||||
@@ -973,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");
|
||||
}
|
||||
}
|
||||
|
||||
+61
-19
@@ -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;
|
||||
|
||||
@@ -22,7 +22,7 @@ use clap::{CommandFactory, ValueEnum};
|
||||
use clap_complete::Shell;
|
||||
|
||||
use crate::install::SKILLS;
|
||||
use crate::util::Status;
|
||||
use crate::util::{RelationKind, Status};
|
||||
|
||||
/// Subcommands whose first positional is a ticket.
|
||||
///
|
||||
@@ -98,6 +98,11 @@ fn fish_dynamic() -> String {
|
||||
let ticket_commands = TICKET_COMMANDS.join(" ");
|
||||
let ticket_second_commands = TICKET_SECOND_COMMANDS.join(" ");
|
||||
let ticket_flags = flag_list(&TICKET_FLAGS);
|
||||
let relation_kinds = RelationKind::ALL
|
||||
.iter()
|
||||
.map(|kind| kind.flag())
|
||||
.collect::<Vec<_>>()
|
||||
.join(" ");
|
||||
let campaign_commands = CAMPAIGN_COMMANDS.join(" ");
|
||||
let campaign_nested = CAMPAIGN_NESTED_COMMANDS
|
||||
.iter()
|
||||
@@ -188,6 +193,14 @@ complete -c worklane \
|
||||
complete -c worklane -n '__worklane_command_is relate' {ticket_flags} \
|
||||
-x -a '(worklane ls --ids)'
|
||||
|
||||
# `--clear` is the one flag here whose first value is not a ticket, so it is not in
|
||||
# `TICKET_FLAGS`: it takes the kind and then the target, and offering a board listing where
|
||||
# the kind goes would be offering values it refuses. The kinds come from `RelationKind`
|
||||
# rather than being spelled again. The target gets no rule at all, deliberately: fish
|
||||
# completes the value after the flag, and the case this flag exists for is a target whose
|
||||
# ticket is gone, which no listing of the board can offer.
|
||||
complete -c worklane -n '__worklane_command_is relate' -l clear -x -a '{relation_kinds}'
|
||||
|
||||
# Campaigns, from `campaign ls --ids`, in the three places one is named: `assign`'s first
|
||||
# argument, `campaign show`'s only one, and `ls --campaign`.
|
||||
complete -c worklane \
|
||||
@@ -218,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
|
||||
@@ -464,22 +477,51 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
/// `chown --clear` takes a ticket, so it is completed like one, and only under
|
||||
/// `chown`: `set --clear` is the same flag name carrying a field.
|
||||
/// Three commands carry a `--clear` and each one takes something different: `chown`
|
||||
/// takes the ticket, `relate` takes the kind and then the target, and `set` takes a
|
||||
/// field name clap already offers. So each rule is scoped to its own command, and a
|
||||
/// bare search for `-l clear` cannot tell them apart, which is what this used to do.
|
||||
#[test]
|
||||
fn chowns_clear_is_completed_with_tickets_and_sets_is_not() {
|
||||
fn each_clear_flag_is_completed_for_its_own_command() {
|
||||
let script = fish_dynamic();
|
||||
let rule = script
|
||||
.lines()
|
||||
.find(|line| line.starts_with("complete") && line.contains("-l clear"))
|
||||
.expect("chown --clear has a rule of its own");
|
||||
assert!(rule.contains("__worklane_command_is chown"), "{rule}");
|
||||
assert!(rule.contains("worklane ls --ids"), "{rule}");
|
||||
let chown = command().find_subcommand("chown").expect("chown exists").clone();
|
||||
let cli = command();
|
||||
|
||||
let rule_for = |name: &str| {
|
||||
let scope = format!("__worklane_command_is {name}");
|
||||
script
|
||||
.lines()
|
||||
.find(|line| {
|
||||
line.starts_with("complete")
|
||||
&& line.contains("-l clear")
|
||||
&& line.contains(&scope)
|
||||
})
|
||||
.unwrap_or_else(|| panic!("no --clear rule for {name}:\n{script}"))
|
||||
};
|
||||
|
||||
let has_clear = |name: &str| {
|
||||
cli.find_subcommand(name)
|
||||
.unwrap_or_else(|| panic!("no such subcommand: {name}"))
|
||||
.get_arguments()
|
||||
.any(|arg| arg.get_long() == Some("clear"))
|
||||
};
|
||||
|
||||
// `chown --clear` names the ticket in the flag, so the flag completes tickets.
|
||||
assert!(has_clear("chown"), "`chown` has no --clear for the rule to complete");
|
||||
assert!(rule_for("chown").contains("worklane ls --ids"), "{}", rule_for("chown"));
|
||||
|
||||
// `relate --clear` takes the kind first, so it offers the kinds and not a board
|
||||
// listing: tickets there would be candidates the flag refuses. The target, the
|
||||
// second value, is deliberately left uncompleted.
|
||||
assert!(has_clear("relate"), "`relate` has no --clear for the rule to complete");
|
||||
let relate = rule_for("relate");
|
||||
for kind in RelationKind::ALL {
|
||||
assert!(relate.contains(kind.flag()), "{kind:?} is not offered: {relate}");
|
||||
}
|
||||
assert!(
|
||||
chown.get_arguments().any(|arg| arg.get_long() == Some("clear")),
|
||||
"`chown` has no --clear for the rule to complete"
|
||||
!relate.contains("worklane ls --ids"),
|
||||
"tickets offered where the kind goes: {relate}"
|
||||
);
|
||||
|
||||
assert!(
|
||||
!TICKET_FLAGS.contains(&"clear"),
|
||||
"--clear in TICKET_FLAGS would offer tickets to `set --clear`, which takes a field"
|
||||
@@ -574,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]
|
||||
|
||||
+500
-157
File diff suppressed because it is too large
Load Diff
+238
-66
@@ -24,8 +24,8 @@ use anyhow::{Result, anyhow};
|
||||
use chrono::Local;
|
||||
|
||||
use crate::util::{
|
||||
Cell, Color, MISSING, TIMESTAMP_FORMAT, is_unknown_value, paint_cells, should_use_colors,
|
||||
tag_cells, tag_color,
|
||||
Cell, Color, MISSING, TIMESTAMP_FORMAT, is_unknown_value, paint_cells, quoted_cells,
|
||||
should_use_colors, tag_cells, tag_color,
|
||||
};
|
||||
|
||||
/// Where a ticket's history lives, under the board.
|
||||
@@ -402,24 +402,9 @@ pub fn format_history(entries: &[Entry]) -> String {
|
||||
|
||||
/// As above, with the colour decision passed in.
|
||||
pub fn format_history_with(entries: &[Entry], colored: bool) -> String {
|
||||
paint_cells(&history_cells(entries), colored)
|
||||
paint_cells(&history_cells(entries, colored), colored)
|
||||
}
|
||||
|
||||
/// How far the reason under a mechanical row sits from the margin.
|
||||
///
|
||||
/// One step, which is where a comment's body used to sit too. It stays here because the
|
||||
/// reason belongs to the row above it: it is read as part of that transition, not as an
|
||||
/// entry of its own.
|
||||
const REASON_INDENT: &str = " ";
|
||||
|
||||
/// How far a comment's body sits from the margin.
|
||||
///
|
||||
/// One step deeper than a reason, so the column says who is talking: a line indented this
|
||||
/// far is somebody's own words and a line of values at column 0 is the tool reporting
|
||||
/// itself. The author line stays at column 0 and is told from a mechanical row by its
|
||||
/// `From` and its colour instead, which is the trade this shape accepts.
|
||||
const COMMENT_INDENT: &str = " ";
|
||||
|
||||
/// The cells one value in a mechanical body is drawn as, per the Color Guideline.
|
||||
///
|
||||
/// Keyed on the kind, because the kind is what says which field the value came from: the
|
||||
@@ -466,79 +451,135 @@ fn stamp_cells(entry: &Entry) -> Vec<Cell> {
|
||||
]
|
||||
}
|
||||
|
||||
/// The block laid out once, as [`Cell`]s: the CLI paints them and the board turns the
|
||||
/// same ones into styled spans, so the two views cannot draw two different blocks.
|
||||
pub fn history_cells(entries: &[Entry]) -> Vec<Cell> {
|
||||
/// One segment of the history block: what it is, and how a renderer lays it out.
|
||||
///
|
||||
/// [`history_cells`] flattens these into the cells the CLI paints, and the board turns
|
||||
/// each segment into its own stretch of the overlay instead: the flow runs full width
|
||||
/// while a quoted run becomes a gutter column with the bar in it and the body beside it,
|
||||
/// so a row the body wraps keeps the mark. One segmentation, two shapes — neither
|
||||
/// renderer re-decides which runs are somebody's words.
|
||||
#[derive(Debug)]
|
||||
pub enum HistoryPart {
|
||||
/// Headers, mechanical rows and the blank lines between entries, as they stand.
|
||||
Flow(Vec<Cell>),
|
||||
/// A comment's body or a move's reason: plain text, every line of it quoted, in
|
||||
/// whatever shape the renderer quotes with.
|
||||
Quoted(String),
|
||||
}
|
||||
|
||||
/// The block as segments, one walk over the entries.
|
||||
///
|
||||
/// The order is the entries' own, oldest first, and a quoted run always sits between two
|
||||
/// flow runs — the header or mechanical row before it and the blank line after it — so a
|
||||
/// renderer can treat each segment as one unbroken stretch of rows.
|
||||
pub fn history_parts(entries: &[Entry]) -> Vec<HistoryPart> {
|
||||
let mut parts = Vec::new();
|
||||
// The flow accumulating until the next quote closes it, which is why the trailing
|
||||
// newline of every entry lands in the segment *after* a quote rather than being
|
||||
// dropped: flattened, the parts are byte for byte the block [`history_cells`] has
|
||||
// always built, which is what the CLI's pins hold it to.
|
||||
let mut flow: Vec<Cell> = Vec::new();
|
||||
|
||||
if entries.is_empty() {
|
||||
return vec![Cell::colored("No history yet.", Color::Grey)];
|
||||
flow.push(Cell::colored("No history yet.", Color::Grey));
|
||||
parts.push(HistoryPart::Flow(flow));
|
||||
return parts;
|
||||
}
|
||||
|
||||
let mut cells = Vec::new();
|
||||
cells.push(Cell::plain("\n"));
|
||||
cells.push(Cell::colored("HISTORY", Color::Orange));
|
||||
cells.push(Cell::plain(format!("\n{}\n", "─".repeat(20))));
|
||||
flow.push(Cell::plain("\n"));
|
||||
flow.push(Cell::colored("HISTORY", Color::Orange));
|
||||
flow.push(Cell::plain(format!("\n{}\n", "─".repeat(20))));
|
||||
|
||||
for entry in entries {
|
||||
cells.push(Cell::plain("\n"));
|
||||
flow.push(Cell::plain("\n"));
|
||||
|
||||
match entry.kind {
|
||||
// As it has always read: a header naming who said it, then the text.
|
||||
Kind::Comment => {
|
||||
// Grey on the word, for the reason the kind label is grey: `From` names
|
||||
// the line, it is not a value in it.
|
||||
cells.push(Cell::colored("From", Color::Grey));
|
||||
cells.push(Cell::plain(" "));
|
||||
cells.extend(stamp_cells(entry));
|
||||
cells.push(Cell::plain("\n"));
|
||||
flow.push(Cell::colored("From", Color::Grey));
|
||||
flow.push(Cell::plain(" "));
|
||||
flow.extend(stamp_cells(entry));
|
||||
flow.push(Cell::plain("\n"));
|
||||
if !entry.body.is_empty() {
|
||||
cells.push(Cell::plain(format!("{}{}", COMMENT_INDENT, entry.body)));
|
||||
parts.push(HistoryPart::Flow(std::mem::take(&mut flow)));
|
||||
parts.push(HistoryPart::Quoted(entry.body.clone()));
|
||||
}
|
||||
cells.push(Cell::plain("\n"));
|
||||
flow.push(Cell::plain("\n"));
|
||||
}
|
||||
// One line: a field change is one fact and a paragraph for it would bury the
|
||||
// comments it sits between. A reason grows an indented line under the row,
|
||||
// the way a comment's text sits under its From header, so it reads as
|
||||
// attached to the transition it explains rather than as the next entry.
|
||||
// comments it sits between. A reason draws behind the same bar the comments
|
||||
// draw, since it shares their shape and their gap, so it reads as attached
|
||||
// to the transition it explains rather than as the next entry.
|
||||
_ => {
|
||||
let padding = Kind::LABEL_WIDTH.saturating_sub(entry.kind.slug().chars().count());
|
||||
// Grey, as chrome. It was orange, which means Status everywhere else, so
|
||||
// an `owner` or `tags` label claimed a meaning belonging to the value
|
||||
// beside it. The label is not a value at all: it names the row, which is
|
||||
// what grey already says.
|
||||
cells.push(Cell::colored(entry.kind.slug(), Color::Grey));
|
||||
flow.push(Cell::colored(entry.kind.slug(), Color::Grey));
|
||||
// Measured on the unpainted label and carried in a cell of its own, the
|
||||
// rule the metadata table follows: measuring a painted string counts its
|
||||
// escapes towards its width, which tilts the column when colour is on and
|
||||
// not when it is off.
|
||||
cells.push(Cell::plain(format!("{} ", " ".repeat(padding))));
|
||||
flow.push(Cell::plain(format!("{} ", " ".repeat(padding))));
|
||||
|
||||
match split_change(&entry.body) {
|
||||
Some((before, after)) => {
|
||||
cells.extend(value_cells(entry.kind, before));
|
||||
cells.push(Cell::plain(CHANGE_SEPARATOR));
|
||||
cells.extend(value_cells(entry.kind, after));
|
||||
flow.extend(value_cells(entry.kind, before));
|
||||
flow.push(Cell::plain(CHANGE_SEPARATOR));
|
||||
flow.extend(value_cells(entry.kind, after));
|
||||
}
|
||||
None => cells.extend(value_cells(entry.kind, &entry.body)),
|
||||
None => flow.extend(value_cells(entry.kind, &entry.body)),
|
||||
}
|
||||
|
||||
cells.push(Cell::plain(" "));
|
||||
cells.extend(stamp_cells(entry));
|
||||
cells.push(Cell::plain("\n"));
|
||||
flow.push(Cell::plain(" "));
|
||||
flow.extend(stamp_cells(entry));
|
||||
flow.push(Cell::plain("\n"));
|
||||
// The newline is the quote's terminator, so it exists only when there is
|
||||
// one: a reasoned row draws the reason under itself and this closes it.
|
||||
if !entry.reason.is_empty() {
|
||||
cells.push(Cell::plain(format!("{}{}", REASON_INDENT, entry.reason)));
|
||||
cells.push(Cell::plain("\n"));
|
||||
parts.push(HistoryPart::Flow(std::mem::take(&mut flow)));
|
||||
parts.push(HistoryPart::Quoted(entry.reason.clone()));
|
||||
flow.push(Cell::plain("\n"));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if !flow.is_empty() {
|
||||
parts.push(HistoryPart::Flow(flow));
|
||||
}
|
||||
|
||||
parts
|
||||
}
|
||||
|
||||
/// The block laid out once, as [`Cell`]s: the CLI paints them and the board turns the
|
||||
/// same ones into styled spans, so the two views cannot draw two different blocks.
|
||||
///
|
||||
/// The flatten of [`history_parts`], which is what makes the CLI's bytes a property of
|
||||
/// the segmentation rather than a second walk that can drift from it: the pins over this
|
||||
/// function's output are pins over the parts too. The colour decision rides in because
|
||||
/// the quote bar is a coloured decoration; with it off the cells carry the indent the
|
||||
/// bar would have provided. The board does not come through here — it lays each part in
|
||||
/// the shape the section builder gives it — but it reads the same parts.
|
||||
pub fn history_cells(entries: &[Entry], colored: bool) -> Vec<Cell> {
|
||||
let mut cells = Vec::new();
|
||||
for part in history_parts(entries) {
|
||||
match part {
|
||||
HistoryPart::Flow(run) => cells.extend(run),
|
||||
HistoryPart::Quoted(body) => cells.extend(quoted_cells(&body, colored)),
|
||||
}
|
||||
}
|
||||
cells
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::util::{Fixture, NOT_SET, paint};
|
||||
use crate::util::{
|
||||
BLOCKED_MARK, Fixture, NOT_SET, PRIORITY_RANGE, Priority, QUOTE_BAR, REGRESSION_MARK,
|
||||
RELATES_MARK, paint, priority_mark, status_dirs, status_mark,
|
||||
};
|
||||
|
||||
/// One entry, spelled the way a file on the board holds it.
|
||||
fn entry(kind: &str, body: &str, author: &str, time: &str) -> Entry {
|
||||
@@ -775,12 +816,14 @@ mod tests {
|
||||
] {
|
||||
assert!(rendered.contains(row), "missing {row:?} in {rendered}");
|
||||
}
|
||||
// The body sits a step deeper than a reason does, and the author line did not move
|
||||
// The body keeps the width the bar occupied, and the author line did not move
|
||||
assert!(
|
||||
rendered
|
||||
.contains("From Ansho Rei (2026-08-24 12:00:04)\n The offset was never passed"),
|
||||
.contains("From Ansho Rei (2026-08-24 12:00:04)\n The offset was never passed"),
|
||||
"{rendered}"
|
||||
);
|
||||
// A single line draws no glyph in a pipe, and it is not spared the indent
|
||||
assert!(!rendered.contains(QUOTE_BAR), "{rendered:?}");
|
||||
assert!(!rendered.contains('\x1b'), "colour off still painted: {rendered:?}");
|
||||
}
|
||||
|
||||
@@ -788,10 +831,12 @@ mod tests {
|
||||
/// way `show_prints_the_same_body_it_printed_before_the_cells_conversion` pins the
|
||||
/// body.
|
||||
///
|
||||
/// Rewritten twice, deliberately. `campaign` widened the label column from 6 to 8 and
|
||||
/// put its own row in the pin (f774a33). Then 2733b10 painted the values: the label
|
||||
/// went grey as chrome, each value took the meaning it carries in the metadata table,
|
||||
/// and the actor and the timestamp came apart into two spans.
|
||||
/// Rewritten three times, deliberately. `campaign` widened the label column from 6
|
||||
/// to 8 and put its own row in the pin (f774a33). Then 2733b10 painted the values:
|
||||
/// the label went grey as chrome, each value took the meaning it carries in the
|
||||
/// metadata table, and the actor and the timestamp came apart into two spans. Then
|
||||
/// d447e04 put the single-line body behind the grey quote bar, which is what the
|
||||
/// `{bar}` in the middle of the expected string is.
|
||||
///
|
||||
/// Every kind is here rather than a representative one, since what each row proves is
|
||||
/// different: status is the orange it is three lines above, tags go through the same
|
||||
@@ -820,8 +865,9 @@ mod tests {
|
||||
paint(time, Color::Cyan, true)
|
||||
)
|
||||
};
|
||||
let bar = paint(&format!("{QUOTE_BAR} "), Color::Grey, true);
|
||||
let expected = format!(
|
||||
"\n{}\n{}\n\n{} {} → {} {}\n\n{} {}\n The offset was never passed\n\n{} {} → {} {}\n\n{} {} → alice {}\n\n{} {} → {}, {} {}\n",
|
||||
"\n{}\n{}\n\n{} {} → {} {}\n\n{} {}\n{}The offset was never passed\n\n{} {} → {} {}\n\n{} {} → alice {}\n\n{} {} → {}, {} {}\n",
|
||||
paint("HISTORY", Color::Orange, true),
|
||||
"─".repeat(20),
|
||||
paint("status", Color::Grey, true),
|
||||
@@ -830,6 +876,7 @@ mod tests {
|
||||
stamp("claude", "2026-08-24 12:00:00"),
|
||||
paint("From", Color::Grey, true),
|
||||
stamp("Ansho Rei", "2026-08-24 12:00:01"),
|
||||
bar,
|
||||
paint("campaign", Color::Grey, true),
|
||||
paint(NOT_SET, Color::Grey, true),
|
||||
paint("v1", tag_color("v1"), true),
|
||||
@@ -878,10 +925,10 @@ mod tests {
|
||||
assert!(!rendered.contains(&paint("claude (", Color::Cyan, true)), "still one span");
|
||||
}
|
||||
|
||||
/// The reason is the row's, so it renders indented under the row it explains and
|
||||
/// before whatever entry follows, in both renderers — this is the one layout they
|
||||
/// share. Paired with the pin above: an entry without a reason renders exactly as
|
||||
/// it always did.
|
||||
/// The reason is the row's, so it renders behind the same bar the comments draw,
|
||||
/// under the row it explains and before whatever entry follows, in both renderers —
|
||||
/// this is the one layout they share. Paired with the pin above: an entry without a
|
||||
/// reason renders exactly as it always did.
|
||||
#[test]
|
||||
fn a_reason_renders_indented_under_its_row() {
|
||||
let entries = vec![
|
||||
@@ -893,8 +940,9 @@ mod tests {
|
||||
entry("comment", "And why.", "Ansho Rei", "2026-08-24 12:00:01"),
|
||||
];
|
||||
|
||||
let bar = paint(&format!("{QUOTE_BAR} "), Color::Grey, true);
|
||||
let expected = format!(
|
||||
"\n{}\n{}\n\n{} {} → {} {} ({})\n sent back, the first plan was wrong\n\n{} {} ({})\n And why.\n",
|
||||
"\n{}\n{}\n\n{} {} → {} {} ({})\n{}sent back, the first plan was wrong\n\n{} {} ({})\n{}And why.\n",
|
||||
paint("HISTORY", Color::Orange, true),
|
||||
"─".repeat(20),
|
||||
paint("status", Color::Grey, true),
|
||||
@@ -902,18 +950,100 @@ mod tests {
|
||||
paint("backlog", Color::Orange, true),
|
||||
paint("claude", tag_color("claude"), true),
|
||||
paint("2026-08-24 12:00:00", Color::Cyan, true),
|
||||
bar,
|
||||
paint("From", Color::Grey, true),
|
||||
paint("Ansho Rei", tag_color("Ansho Rei"), true),
|
||||
paint("2026-08-24 12:00:01", Color::Cyan, true),
|
||||
bar,
|
||||
);
|
||||
|
||||
assert_eq!(format_history_with(&entries, true), expected);
|
||||
// Colour off keeps the reason exactly where a pipe has always read it, at the
|
||||
// width the bar occupied, and carries no glyph doing it.
|
||||
let plain = format_history_with(&entries, false);
|
||||
assert!(
|
||||
format_history_with(&entries, false)
|
||||
.contains("claude (2026-08-24 12:00:00)\n sent back, the first plan was wrong"),
|
||||
"colour off lost the reason: {}",
|
||||
format_history_with(&entries, false)
|
||||
plain.contains("claude (2026-08-24 12:00:00)\n sent back, the first plan was wrong"),
|
||||
"colour off lost the reason: {plain}"
|
||||
);
|
||||
assert!(!plain.contains(QUOTE_BAR) && !plain.contains('\x1b'), "{plain:?}");
|
||||
}
|
||||
|
||||
/// The reported shape: every line of a run sits behind the bar, so a two-paragraph
|
||||
/// comment reads as one voice start to finish. This is what a single prefix got
|
||||
/// wrong — b304b17's symptom — with every line after the first back at column 0,
|
||||
/// which 2733b10 had just given a meaning to.
|
||||
#[test]
|
||||
fn a_multi_line_comment_draws_every_line_behind_the_bar() {
|
||||
let entries = vec![entry(
|
||||
"comment",
|
||||
"First paragraph.\n\nSecond one, still theirs.",
|
||||
"Ansho Rei",
|
||||
"2026-08-24 12:00:00",
|
||||
)];
|
||||
|
||||
let bar = paint(&format!("{QUOTE_BAR} "), Color::Grey, true);
|
||||
let bare = paint(QUOTE_BAR, Color::Grey, true);
|
||||
let rendered = format_history_with(&entries, true);
|
||||
|
||||
// Both content lines prefixed, and the break between them inside the run as the
|
||||
// bare glyph rather than a gap running nowhere.
|
||||
let expected = format!(
|
||||
"\n{}\n{}\n\n{} {} ({})\n{}First paragraph.\n{}\n{}Second one, still theirs.\n",
|
||||
paint("HISTORY", Color::Orange, true),
|
||||
"─".repeat(20),
|
||||
paint("From", Color::Grey, true),
|
||||
paint("Ansho Rei", tag_color("Ansho Rei"), true),
|
||||
paint("2026-08-24 12:00:00", Color::Cyan, true),
|
||||
bar,
|
||||
bare,
|
||||
bar,
|
||||
);
|
||||
assert_eq!(rendered, expected);
|
||||
}
|
||||
|
||||
/// Paired with the one above, the way the guideline demands: colour off drops the
|
||||
/// glyph but keeps the width it occupied, derived from the drawn form, so every
|
||||
/// content line still starts at the same column and no escape byte reaches a pipe.
|
||||
/// The flag is the only thing that decides the bar.
|
||||
#[test]
|
||||
fn colour_off_keeps_the_indent_and_drops_the_glyph() {
|
||||
let entries = vec![entry(
|
||||
"comment",
|
||||
"First paragraph.\n\nSecond one, still theirs.",
|
||||
"Ansho Rei",
|
||||
"2026-08-24 12:00:00",
|
||||
)];
|
||||
|
||||
let rendered = format_history_with(&entries, false);
|
||||
let expected = format!(
|
||||
"\nHISTORY\n{}\n\nFrom Ansho Rei (2026-08-24 12:00:00)\n First paragraph.\n\n Second one, still theirs.\n",
|
||||
"─".repeat(20),
|
||||
);
|
||||
assert_eq!(rendered, expected);
|
||||
}
|
||||
|
||||
/// The bar is chrome like the kind label, so it takes grey; it is one cell wide; and
|
||||
/// it claims nothing another column already means: the circles and the dot belong to
|
||||
/// the priority meter, the cross and arrows to the relation rows, and the status
|
||||
/// marks reuse both sets. Pinned against the marks actually defined rather than a
|
||||
/// list written out here, so a mark added later fails this instead of sharing.
|
||||
#[test]
|
||||
fn the_quote_bar_claims_no_glyph_another_column_means() {
|
||||
assert_eq!(QUOTE_BAR.chars().count(), 1);
|
||||
|
||||
let mut taken = String::new();
|
||||
for level in PRIORITY_RANGE {
|
||||
taken.push_str(priority_mark(Priority::Level(level)).0);
|
||||
}
|
||||
taken.push_str(priority_mark(Priority::Unset).0);
|
||||
taken.push_str(BLOCKED_MARK);
|
||||
taken.push_str(RELATES_MARK);
|
||||
taken.push_str(REGRESSION_MARK);
|
||||
for status in status_dirs() {
|
||||
taken.push_str(status_mark(Some(status)).0);
|
||||
}
|
||||
|
||||
assert!(!taken.contains(QUOTE_BAR), "{taken:?} already means something");
|
||||
}
|
||||
|
||||
/// Padded to the longest of the four, so every body starts in the same column
|
||||
@@ -961,4 +1091,46 @@ mod tests {
|
||||
fn nothing_recorded_says_so() {
|
||||
assert_eq!(format_history_with(&[], false), "No history yet.");
|
||||
}
|
||||
|
||||
/// The block as segments: the rows drawn as they stand are flow, a comment's body
|
||||
/// and a move's reason are quoted, and each quote sits between two flow runs — the
|
||||
/// row or header before it and the blank after it. This is the one segmentation both
|
||||
/// renderers read, so it is pinned here rather than left to be discovered on the
|
||||
/// board; the CLI's byte pins above hold its flatten to what it has always printed.
|
||||
#[test]
|
||||
fn the_block_splits_into_flow_and_quoted_parts() {
|
||||
let entries = vec![
|
||||
entry("status", "committed → reviewing", "claude", "2026-08-24 12:00:00"),
|
||||
entry("comment", "First line.\n\nSecond.", "Ansho Rei", "2026-08-24 12:00:01"),
|
||||
entry("status", "reviewing → backlog", "claude", "2026-08-24 12:00:02"),
|
||||
]
|
||||
.into_iter()
|
||||
.enumerate()
|
||||
.map(|(at, mut entry)| {
|
||||
if at == 2 {
|
||||
entry.reason = "sent back".to_string();
|
||||
}
|
||||
entry
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
let parts = history_parts(&entries);
|
||||
let shapes: Vec<&str> = parts
|
||||
.iter()
|
||||
.map(|part| match part {
|
||||
HistoryPart::Flow(_) => "flow",
|
||||
HistoryPart::Quoted(_) => "quote",
|
||||
})
|
||||
.collect();
|
||||
assert_eq!(shapes, ["flow", "quote", "flow", "quote", "flow"], "{parts:?}");
|
||||
|
||||
// The quotes carry the bare words, newlines included; laying them out is the
|
||||
// renderer's decision.
|
||||
for part in &parts {
|
||||
if let HistoryPart::Quoted(body) = part {
|
||||
assert!(!body.contains(QUOTE_BAR), "{body:?}");
|
||||
}
|
||||
}
|
||||
assert_eq!(parts.len(), 5);
|
||||
}
|
||||
}
|
||||
|
||||
+130
-26
@@ -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");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+60
-34
@@ -8,6 +8,11 @@ mod completions;
|
||||
mod handlers;
|
||||
mod history;
|
||||
mod install;
|
||||
/// The command prompt reads `split_line` and `unclosed`; `cursor_arg` and `at_new_arg` are
|
||||
/// what completing an argument needs and nothing reads them yet, so the allow stays until
|
||||
/// 00a14e7 and 952a9f8 land. The tests are what drive them in the meantime.
|
||||
#[cfg_attr(not(test), allow(dead_code))]
|
||||
mod split;
|
||||
mod tag;
|
||||
mod tui;
|
||||
mod util;
|
||||
@@ -42,78 +47,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 --
|
||||
@@ -208,6 +220,14 @@ fn run_tui(paths: &[std::path::PathBuf], start: &std::path::Path) -> Result<()>
|
||||
continue;
|
||||
}
|
||||
|
||||
// And the command prompt, third, on the same contract: while a command is being
|
||||
// typed `q` is a letter, `d` leaves the columns alone and `tab` stays out of the
|
||||
// project tabs. No screen, because nothing it does measures the board yet. The
|
||||
// rule is `Board::prompt_key`, where a test can reach it.
|
||||
if board.prompt_key(key) {
|
||||
continue;
|
||||
}
|
||||
|
||||
match key.code {
|
||||
// One arm, because the two keys mean one thing: close what is open, and
|
||||
// quit when there is nothing left to close. Two arms carrying one rule
|
||||
@@ -251,6 +271,12 @@ fn run_tui(paths: &[std::path::PathBuf], start: &std::path::Path) -> Result<()>
|
||||
// at an open picker is taken by `picker_key` to open the picker's own
|
||||
// query, so this arm is only ever the way in to the board's prompt.
|
||||
KeyCode::Char('/') => board.open_search(),
|
||||
// The way in to the command prompt, and the same single-shot arm `/` is:
|
||||
// from the next keypress on, `prompt_key` above has the keyboard. A `:`
|
||||
// typed into either open prompt is a character there and one pressed at an
|
||||
// open picker is swallowed by it, so this arm is only ever the way in from
|
||||
// the board itself. Free of every existing binding.
|
||||
KeyCode::Char(':') => board.open_prompt(),
|
||||
// `y` as in yank, for the readers this board is for, and the only letter
|
||||
// left that a vim hand would reach for. The clipboard is handed in rather
|
||||
// than reached for inside `Board`, so the suite can drive both answers.
|
||||
|
||||
+453
@@ -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()
|
||||
},
|
||||
]);
|
||||
}
|
||||
}
|
||||
+2292
-238
File diff suppressed because it is too large
Load Diff
+750
-86
File diff suppressed because it is too large
Load Diff
@@ -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
|
||||
|
||||
@@ -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]
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -388,3 +388,415 @@ fn a_line_that_is_not_a_relation_is_an_error() {
|
||||
assert!(stderr.contains("is not a relation"), "{stderr}");
|
||||
assert!(stderr.contains("The gated one"), "{stderr}");
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------- clearing --
|
||||
|
||||
/// Two blockers, one taken off by name. The other survives, which is the whole reason
|
||||
/// `--clear` names the target and not just the kind: a ticket can hold several of one
|
||||
/// kind, and emptying all of them is not usually what is wanted.
|
||||
#[test]
|
||||
fn a_relation_is_taken_off_by_its_kind_and_its_target() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
|
||||
run(
|
||||
&temp,
|
||||
&[
|
||||
"relate",
|
||||
GATED,
|
||||
"--blocked-by",
|
||||
BLOCKER,
|
||||
"--blocked-by",
|
||||
FIXED,
|
||||
],
|
||||
);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by", BLOCKER]);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(stdout(&out).contains("Cleared blocked by"), "{}", stdout(&out));
|
||||
|
||||
let content = ticket(&worklane, GATED);
|
||||
assert!(
|
||||
!content.contains(BLOCKER),
|
||||
"the cleared relation is still there: {content}"
|
||||
);
|
||||
assert!(
|
||||
content.contains(&format!("- blocked by {}", FIXED)),
|
||||
"the other one went too: {content}"
|
||||
);
|
||||
}
|
||||
|
||||
/// Both spellings of the kind, because both are in front of the reader: `blocked-by` is
|
||||
/// the flag that recorded it and `blocked by` is what `show` prints and what the file
|
||||
/// stores. Refusing the form the tool itself prints would be a trap.
|
||||
#[test]
|
||||
fn the_kind_takes_the_flag_spelling_and_the_label_spelling() {
|
||||
for kind in ["blocked-by", "blocked by", "Blocked-By"] {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", kind, BLOCKER]);
|
||||
assert!(out.status.success(), "{kind}: {}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(!ticket(&worklane, GATED).contains(BLOCKER), "{kind} did not clear it");
|
||||
}
|
||||
}
|
||||
|
||||
/// The target is a ticket argument like any other, so it resolves by title too.
|
||||
#[test]
|
||||
fn a_cleared_target_resolves_by_title() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by", "blocker"]);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(!ticket(&worklane, GATED).contains(BLOCKER));
|
||||
}
|
||||
|
||||
/// A relation the ticket does not hold is the state the caller asked for, so it reports
|
||||
/// no change rather than failing. The target resolves; the edge is simply not there.
|
||||
#[test]
|
||||
fn clearing_a_relation_the_ticket_does_not_hold_reports_no_change() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
// A kind it does not hold at all, and a target it holds under another kind.
|
||||
for args in [["relates-to", BLOCKER], ["blocked-by", FIXED]] {
|
||||
let out = run(&temp, &["relate", GATED, "--clear", args[0], args[1]]);
|
||||
assert!(out.status.success(), "{args:?}: {}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(stdout(&out).contains("No changes"), "{args:?}: {}", stdout(&out));
|
||||
assert_eq!(ticket(&worklane, GATED), before, "{args:?} wrote something");
|
||||
}
|
||||
}
|
||||
|
||||
/// A search naming nothing at all is a typo, not a state to report. Reporting no change
|
||||
/// for it would swallow it, which is the one thing the no-change rule must not do.
|
||||
#[test]
|
||||
fn clearing_a_target_that_names_nothing_is_an_error() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by", "9999zzzz"]);
|
||||
assert!(!out.status.success(), "{}", stdout(&out));
|
||||
assert_eq!(ticket(&worklane, GATED), before);
|
||||
}
|
||||
|
||||
/// The inverse is derived by a scan rather than stored, so taking the stored line off is
|
||||
/// what takes it off both ends. The other ticket's own file was never touched either way.
|
||||
#[test]
|
||||
fn the_derived_inverse_goes_with_the_stored_line() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
let untouched = ticket(&worklane, BLOCKER);
|
||||
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let shown = stdout(&run(&temp, &["show", BLOCKER]));
|
||||
assert!(shown.contains("blocks"), "the inverse was never derived: {shown}");
|
||||
|
||||
run(&temp, &["relate", GATED, "--clear", "blocked-by", BLOCKER]);
|
||||
let after = stdout(&run(&temp, &["show", BLOCKER]));
|
||||
assert!(!after.contains("blocks"), "the inverse outlived the stored line: {after}");
|
||||
assert_eq!(ticket(&worklane, BLOCKER), untouched, "the other ticket was written to");
|
||||
}
|
||||
|
||||
/// The case most likely to need clearing, and the only one no search of the board can
|
||||
/// reach: the target's ticket is gone, so the prefix tier over the stored targets is what
|
||||
/// finds it. `show` renders it as `_missing_` until it is cleared, and `mv` warns about it
|
||||
/// on every move.
|
||||
#[test]
|
||||
fn a_dangling_relation_can_be_cleared() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
|
||||
fs::remove_file(find(&worklane, BLOCKER)).unwrap();
|
||||
assert!(
|
||||
stdout(&run(&temp, &["show", GATED])).contains("_missing_"),
|
||||
"the fixture is not dangling"
|
||||
);
|
||||
|
||||
// By the short id, which is all a reader has once the title is gone.
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by", &BLOCKER[..7]]);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(!ticket(&worklane, GATED).contains(BLOCKER), "{}", ticket(&worklane, GATED));
|
||||
assert!(!stdout(&run(&temp, &["show", GATED])).contains("_missing_"));
|
||||
}
|
||||
|
||||
/// A prefix short enough to reach two stored targets names the candidates rather than
|
||||
/// guessing, the way an ambiguous ticket search does, and writes nothing.
|
||||
#[test]
|
||||
fn an_ambiguous_prefix_over_the_stored_targets_names_the_candidates() {
|
||||
const ONE: &str = "aaaa1111-0000-4000-8000-000000000000";
|
||||
const TWO: &str = "aaaa2222-0000-4000-8000-000000000000";
|
||||
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
create_ticket(&worklane, "backlog", "Twin one", ONE);
|
||||
create_ticket(&worklane, "backlog", "Twin two", TWO);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", ONE, "--blocked-by", TWO]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by", "aaaa"]);
|
||||
assert!(!out.status.success(), "{}", stdout(&out));
|
||||
|
||||
// The stored-target tier and not the board search, which would find the same two
|
||||
// tickets by their own uuid prefix and report them the same way. The wording is what
|
||||
// tells the two apart, so it is what this asserts.
|
||||
let reason = String::from_utf8_lossy(&out.stderr);
|
||||
assert!(
|
||||
reason.contains("'blocked by' relations on"),
|
||||
"the board answered instead: {reason}"
|
||||
);
|
||||
assert!(reason.contains(&ONE[..7]) && reason.contains(&TWO[..7]), "{reason}");
|
||||
assert_eq!(ticket(&worklane, GATED), before);
|
||||
}
|
||||
|
||||
/// The last edge leaves the placeholder `add` writes, not an empty body, so the section
|
||||
/// can be written to again without the placeholder ending up above what follows it.
|
||||
#[test]
|
||||
fn clearing_the_last_relation_leaves_the_placeholder() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
run(&temp, &["relate", GATED, "--clear", "blocked-by", BLOCKER]);
|
||||
|
||||
let content = ticket(&worklane, GATED);
|
||||
assert!(
|
||||
content.contains(
|
||||
"## Relations
|
||||
_No relations._
|
||||
"
|
||||
),
|
||||
"{content}"
|
||||
);
|
||||
|
||||
// And it is written to again without the placeholder being left behind.
|
||||
run(&temp, &["relate", GATED, "--relates-to", FIXED]);
|
||||
let again = ticket(&worklane, GATED);
|
||||
assert!(again.contains(&format!("- relates to {}", FIXED)), "{again}");
|
||||
assert!(
|
||||
!again.contains("_No relations._"),
|
||||
"the placeholder outlived the edge: {again}"
|
||||
);
|
||||
}
|
||||
|
||||
/// The same file surgery `relate` already does, so the tick, the handwritten section and
|
||||
/// the prose survive a clear the way they survive a record.
|
||||
#[test]
|
||||
fn clearing_leaves_everything_it_was_not_asked_about_alone() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(
|
||||
&temp,
|
||||
&[
|
||||
"relate",
|
||||
GATED,
|
||||
"--blocked-by",
|
||||
BLOCKER,
|
||||
"--relates-to",
|
||||
FIXED,
|
||||
],
|
||||
);
|
||||
run(&temp, &["relate", GATED, "--clear", "blocked-by", BLOCKER]);
|
||||
|
||||
let content = ticket(&worklane, GATED);
|
||||
assert!(content.contains("- [x] Crit one"), "the tick was lost: {content}");
|
||||
assert!(
|
||||
content.contains("## Notes\nA handwritten note the tool knows nothing about.\n"),
|
||||
"the unknown section was lost: {content}"
|
||||
);
|
||||
assert!(content.contains("1. Step one"), "{content}");
|
||||
assert!(content.contains("- **Owner**: alice"), "{content}");
|
||||
assert!(content.contains("- **Status**: backlog"), "{content}");
|
||||
}
|
||||
|
||||
/// One call does both, and each half reports itself in its own words.
|
||||
#[test]
|
||||
fn one_call_records_and_clears_different_relations() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
|
||||
let out = run(
|
||||
&temp,
|
||||
&[
|
||||
"relate",
|
||||
GATED,
|
||||
"--clear",
|
||||
"blocked-by",
|
||||
BLOCKER,
|
||||
"--relates-to",
|
||||
FIXED,
|
||||
],
|
||||
);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
|
||||
let reported = stdout(&out);
|
||||
assert!(reported.contains("Recorded relates to"), "{reported}");
|
||||
assert!(reported.contains("Cleared blocked by"), "{reported}");
|
||||
|
||||
let content = ticket(&worklane, GATED);
|
||||
assert!(!content.contains(BLOCKER), "{content}");
|
||||
assert!(content.contains(&format!("- relates to {}", FIXED)), "{content}");
|
||||
}
|
||||
|
||||
/// Recording and clearing the same relation in one call is refused outright, the way
|
||||
/// `set` refuses a field it is also replacing: nothing is written rather than one of the
|
||||
/// two silently winning.
|
||||
///
|
||||
/// It has to be caught on what the call *asked* for and not on what it would write. A
|
||||
/// relation already in the file is not among the additions, so comparing against those
|
||||
/// would let this call quietly remove one.
|
||||
#[test]
|
||||
fn recording_and_clearing_the_same_relation_is_refused() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(
|
||||
&temp,
|
||||
&[
|
||||
"relate",
|
||||
GATED,
|
||||
"--blocked-by",
|
||||
BLOCKER,
|
||||
"--clear",
|
||||
"blocked-by",
|
||||
BLOCKER,
|
||||
],
|
||||
);
|
||||
assert!(!out.status.success(), "{}", stdout(&out));
|
||||
assert!(
|
||||
String::from_utf8_lossy(&out.stderr).contains("nothing was written"),
|
||||
"{}",
|
||||
String::from_utf8_lossy(&out.stderr)
|
||||
);
|
||||
assert_eq!(ticket(&worklane, GATED), before, "the relation was removed anyway");
|
||||
}
|
||||
|
||||
/// A kind that is not one of the three is refused before the ticket is resolved, so
|
||||
/// nothing is written. Exit 1 rather than clap's 2: the value is one of a pair clap
|
||||
/// cannot type apart, so the kind is parsed by `RelateArgs::cleared`.
|
||||
#[test]
|
||||
fn an_unknown_kind_in_a_clear_is_refused() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "depends-on", BLOCKER]);
|
||||
assert!(!out.status.success(), "{}", stdout(&out));
|
||||
|
||||
let reason = String::from_utf8_lossy(&out.stderr);
|
||||
assert!(reason.contains("not a relation kind"), "{reason}");
|
||||
// The message names the three, in the spelling the flags and the completions use.
|
||||
for kind in ["blocked-by", "regression-of", "relates-to"] {
|
||||
assert!(reason.contains(kind), "{reason}");
|
||||
}
|
||||
assert_eq!(ticket(&worklane, GATED), before);
|
||||
}
|
||||
|
||||
/// `--clear` takes exactly two values per occurrence, so clap refuses an odd number with
|
||||
/// a usage error and nothing reaches the handler.
|
||||
#[test]
|
||||
fn a_clear_with_one_value_is_a_usage_error() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--clear", "blocked-by"]);
|
||||
assert_eq!(out.status.code(), Some(2), "{}", stdout(&out));
|
||||
assert_eq!(ticket(&worklane, GATED), before);
|
||||
}
|
||||
|
||||
/// The far end already stores it, so the edge is already recorded: `show` derives it onto
|
||||
/// this ticket by scanning. A line here would be the same edge on two files, which
|
||||
/// 4179958 decided against and nothing enforced until 03bdc76.
|
||||
#[test]
|
||||
fn a_relates_to_the_target_already_stores_is_not_stored_again() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
|
||||
run(&temp, &["relate", BLOCKER, "--relates-to", GATED]);
|
||||
let before = ticket(&worklane, GATED);
|
||||
|
||||
let out = run(&temp, &["relate", GATED, "--relates-to", BLOCKER]);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(stdout(&out).contains("No changes"), "{}", stdout(&out));
|
||||
assert_eq!(ticket(&worklane, GATED), before, "the mirror was stored anyway");
|
||||
|
||||
// Still shown, since it was recorded at the other end.
|
||||
let shown = stdout(&run(&temp, &["show", GATED]));
|
||||
assert_eq!(shown.matches("relates to").count(), 1, "{shown}");
|
||||
}
|
||||
|
||||
/// A board that already holds both directions draws the edge once. The refusal above
|
||||
/// stops it recurring; this is what repairs a ticket that already has it, without an edit.
|
||||
#[test]
|
||||
fn a_relates_to_stored_at_both_ends_is_drawn_once() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = board(&temp);
|
||||
|
||||
// Both lines written directly, which is the state a board recorded before the refusal
|
||||
// is in. The CLI will not produce it any more, so nothing else can set this up.
|
||||
for (holder, target) in [(GATED, BLOCKER), (BLOCKER, GATED)] {
|
||||
let path = find(&worklane, holder);
|
||||
let content = fs::read_to_string(&path).unwrap().replace(
|
||||
"## Metadata",
|
||||
&format!("## Relations\n- relates to {target}\n\n## Metadata"),
|
||||
);
|
||||
fs::write(&path, content).unwrap();
|
||||
}
|
||||
|
||||
let shown = stdout(&run(&temp, &["show", GATED]));
|
||||
assert_eq!(shown.matches("relates to").count(), 1, "the edge is drawn twice:\n{shown}");
|
||||
assert_eq!(shown.matches(&BLOCKER[..7]).count(), 1, "{shown}");
|
||||
|
||||
// And from the other end, which stores its own line and derives this one.
|
||||
let far = stdout(&run(&temp, &["show", BLOCKER]));
|
||||
assert_eq!(far.matches("relates to").count(), 1, "{far}");
|
||||
}
|
||||
|
||||
/// Only where the row reads the same. Two tickets each blocking the other is two facts,
|
||||
/// and the block says both: `blocked by` from this end, `blocks` from the other.
|
||||
#[test]
|
||||
fn a_mutual_block_is_still_drawn_from_both_ends() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
board(&temp);
|
||||
|
||||
run(&temp, &["relate", GATED, "--blocked-by", BLOCKER]);
|
||||
let out = run(&temp, &["relate", BLOCKER, "--blocked-by", GATED]);
|
||||
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
|
||||
assert!(
|
||||
!stdout(&out).contains("No changes"),
|
||||
"the second was refused: {}",
|
||||
stdout(&out)
|
||||
);
|
||||
|
||||
let shown = stdout(&run(&temp, &["show", GATED]));
|
||||
assert!(shown.contains("blocked by"), "{shown}");
|
||||
assert!(shown.contains("blocks"), "the derived direction was dropped:\n{shown}");
|
||||
}
|
||||
|
||||
/// The same for the other asymmetric kind, whose inverse label also differs from its own.
|
||||
#[test]
|
||||
fn a_mutual_regression_is_still_drawn_from_both_ends() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
board(&temp);
|
||||
|
||||
run(&temp, &["relate", GATED, "--regression-of", BLOCKER]);
|
||||
run(&temp, &["relate", BLOCKER, "--regression-of", GATED]);
|
||||
|
||||
let shown = stdout(&run(&temp, &["show", GATED]));
|
||||
assert!(shown.contains("regression of"), "{shown}");
|
||||
assert!(
|
||||
shown.contains("regressed by"),
|
||||
"the derived direction was dropped:\n{shown}"
|
||||
);
|
||||
}
|
||||
|
||||
@@ -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]
|
||||
|
||||
@@ -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"
|
||||
);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user