Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e26e5893f7 | ||
|
|
bfce4cf2f4 | ||
|
|
b439ad9c41 | ||
|
|
455f04d136 | ||
|
|
cac21a94f5 |
@@ -85,7 +85,7 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- Prefer explicit `match` over `unwrap_or_default()` for clarity
|
||||
- Use `unwrap_or_else(|| expr)` for lazy defaults, `unwrap_or(val)` for eager defaults
|
||||
- Use `anyhow!()` with context strings that include identifying info (e.g. UUID, title) not bare values
|
||||
- A command whose arguments run past a handful takes a clap `Args` struct, not an inline variant with a matching parameter list: `AddArgs`, `SetArgs`, `AppendArgs`, `CheckArgs`. `add` was nine positional parameters threaded from `main` before it became `AddArgs`, and the handler destructures the struct so the body reads the same as before
|
||||
- A command whose arguments run past a handful takes a clap `Args` struct, not an inline variant with a matching parameter list: `AddArgs`, `SetArgs`, `AppendArgs`, `CheckArgs`, `MvArgs`. `add` was nine positional parameters threaded from `main` before it became `AddArgs`, and the handler destructures the struct so the body reads the same as before. `mv` was the last inline variant to carry an `--actor`, and `--actor-from-git` pushed its list past the line
|
||||
|
||||
### CLI Arguments
|
||||
- The prose arguments carry `allow_hyphen_values`, via the `PROSE` constant in `command.rs`: `add --title`, `--description`, `--acceptance`, `--plan`, and the `comment` body. Ticket text quotes flag names constantly, and without it a criterion reading `--print is supported` is parsed as a flag and the whole ticket is refused with nothing written
|
||||
@@ -270,7 +270,7 @@ 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
|
||||
@@ -294,16 +294,19 @@ and this file is for what someone changing worklane's own code needs.
|
||||
- **The footer has three states, because the selection has three places to be.** An open ticket, the frame, and the cards. On the frame it names `↓ board`, `↵ expand` or `↵ collapse`, the two scroll keys and `y copy id` — `y copy tag` on a tag frame — and leaves out `←→` because they do nothing there. It has to say which way `↵` goes, since the key is a toggle and the frame is always at one of its two heights. `↑ frame` is not named on the board, on the same trade `c` is dropped on: the frame is drawn directly above the columns and up is the key that reaches it. Nor is the way to collapse an expanded frame named from the cards, which is the same trade again — the frame is right there and `↑` reaches it
|
||||
- **`picker: Option<Picker>` is the whole mode**, the shape `search` and `detail` use, and `Board::picker_key` runs beside `search_key` ahead of the action arms for the same reason: an open list owns the keyboard, so `d` must not toggle done and `q` must not quit while a campaign is being chosen. `ctrl-c` is the one key it declines and every other control combination is swallowed, or `ctrl-d` would reach the arm bound to `d`
|
||||
- **The picker's rows are `Tab::campaigns`, not a copy taken when it opened**, so a campaign filed elsewhere appears in an open picker on the next tick. It opens on the campaign already selected, so `c` on a filtered board says where you are as well as offering somewhere to go, and a board with no campaigns gets a `Notice` rather than an empty box that has to be dismissed to learn it was empty
|
||||
- **`t` opens the same picker over the tags instead, and taking a tag filters every column to the cards carrying it.** Every tag the board declares or carries, matched whole and case sensitively the way `ls --tag` matches — the box completes the filter, so offering what the filter would refuse is the one bug it must not have. It opens on the tag already applied, the courtesy `c` pays a campaign-filtered board, and a board carrying no tag gets the same `Notice` a board with no campaigns gets
|
||||
- **A picker row draws a real codename only.** The row opens with the short id, so the card's `~<id>` fallback would print it twice and say nothing the second time
|
||||
- **One picker serves both lists, and `PickerRow::key` is what keeps it one.** A second picker would have been a second keyboard, query and highlight to keep in step with the first; instead `PickerKind` decides only which list is built and what the answer filters, and everything between the keypress and the filter runs once against the key — a campaign is keyed by its uuid and a tag by itself, both strings the tab can be filtered by. Picking either clears the other without either setter remembering to, because `select_filter` replaces one `Filter`: one field, which is the same reason the frame slot is shared
|
||||
- **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 — a uuid or a tag, whichever list is open — the same string `Tab::filter` holds for either 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 key before the lists are rebuilt and puts it back after
|
||||
- **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
|
||||
@@ -407,8 +410,9 @@ and this file is for what someone changing worklane's own code needs.
|
||||
|
||||
### Who Wrote an Entry
|
||||
- **Identity is supplied, not detected.** Every option that needs no cooperation fails: a harness variable such as `CLAUDECODE` names the tool rather than the instance and breaks across versions, walking the parent process is platform specific and also only names the harness, and a terminal check separates interactive from not, which a human piping output is too. So the actor is `WORKLANE_ACTOR`, set once per session, with `--actor` as the per-call override
|
||||
- **Precedence: flag, then `WORKLANE_ACTOR`, then `get_git_user()`, then `unknown`.** `resolve_actor` is the only caller of `get_git_user` for an entry's author, and every entry the CLI writes goes through it. The two halves are separate pure functions, `session_actor` and `entry_actor`, tested without touching the process environment for the reason `colors_wanted` is split that way
|
||||
- **The session half is cached in a `OnceLock`, the way `should_use_colors` is:** neither the variable nor the git user can change mid-run, and the fallback costs a `git config` subprocess. `session_actor` takes the git user as a closure so that subprocess is not run when the variable already answered
|
||||
- **Precedence: flag, then `WORKLANE_ACTOR`, then `get_git_user()`, then `unknown`.** With `--actor-from-git` and no explicit value the git user is lifted *above* the variable rather than added beneath it — the flag says attribute this to the human, and a machine with no git user configured reads `unknown` instead of quietly attributing back to the agent. An explicit `--actor` wins outright either way. `resolve_actor` is the only caller of `get_git_user` for an entry's author, and every entry the CLI writes goes through it. The halves are separate pure functions, `session_actor` (the variable alone now) and `entry_actor`, tested without touching the process environment for the reason `colors_wanted` is split that way
|
||||
- **The variable half is cached in a `OnceLock` and the git user in another**, the way `should_use_colors` is: neither input can change mid-run, and the git user costs a subprocess. Two caches rather than one is the whole point: baking the git user into the session's answer would make `--actor-from-git` read whatever the run's *first* call produced, since with the variable set that call never fetched git at all. `entry_actor` takes the git user as a closure so the subprocess is not run when something ahead of it already answered
|
||||
- **The two flags are refused together at parse time**, clap `conflicts_with`: both answer who the entry is attributed to, and last-wins would be a silent answer to a contradictory call. `every_actor_command_takes_actor_from_git` walks the clap definition so the pair travels together onto any command that grows an `--actor`
|
||||
- An **empty `WORKLANE_ACTOR` counts as unset**, the convention `colors_wanted` follows for `NO_COLOR`, so a wrapper script can clear an inherited one. Whitespace counts the same, since a shell quoting a missing value writes one
|
||||
- **The actor is free text, checked against nothing**, like the `chown` user: there is no registry of actors, and the same reason `ls --tag` refuses to validate a tag
|
||||
- **It was `comment --owner`, renamed with no alias.** Owner is the ticket's assignee and has one writer, `chown`; this names the writer of the entry, which is a different field. Pre-1.0, and two names for one thing is what splitting `set` and `chown` avoided. `the_owner_flag_is_gone` pins the refusal, since an alias kept "for now" is what makes the wrong name permanent
|
||||
@@ -428,7 +432,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
|
||||
@@ -511,6 +515,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.32.4"
|
||||
version = "0.32.8"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"assert_cmd",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "worklane"
|
||||
version = "0.32.4"
|
||||
version = "0.32.8"
|
||||
edition = "2024"
|
||||
|
||||
[dependencies]
|
||||
|
||||
@@ -17,7 +17,7 @@ Worklane is a local Kanban flow for agentic software development.
|
||||
| `worklane chown <user> <ticket>` | Sets the Owner field, the only command that writes it. Free text, checked against nothing. User first and ticket second, after Unix `chown`. `worklane chown --clear <ticket>` returns the field to unset, taking the ticket in the flag since there is no user to give, and not to the git user `add` falls back to. Records an `owner` entry in the ticket's history, with the owner before and after; `--actor` names who made the change, which is not the same as the user argument |
|
||||
| `worklane check <ticket> [criteria...]` | Ticks acceptance criteria, each by number as shown by `show` or by a substring. Several in one call, or `all` for every one of them. Prompts with the numbered list if none is given, or errors with it when there is no terminal |
|
||||
| `worklane uncheck <ticket> [criteria...]` | Unticks acceptance criteria, addressed the same way |
|
||||
| `worklane comment <ticket> <body>` | Adds a comment to a ticket by UUID or title. The author is `--actor`, or `WORKLANE_ACTOR`, or the git user, in that order |
|
||||
| `worklane comment <ticket> <body>` | Adds a comment to a ticket by UUID or title. The author is `--actor`, or `WORKLANE_ACTOR`, or the git user, in that order; `--actor-from-git` lifts the git user over `WORKLANE_ACTOR`, for acting on the person's behalf without knowing how they spell themselves, and is refused beside `--actor` |
|
||||
| `worklane campaign add` | Files a campaign in `.worklane/campaigns/` with `--title`, `--description`, `--codename` and `--owner`. A campaign has no status: its state is derived, open until every member is done. `--codename` is one word to call it by, `v1` or `beaver`, which is what the board draws on every card in it and what every command that takes a campaign will also resolve it by |
|
||||
| `worklane campaign set <campaign>` | Replaces `--title`, which renames the file keeping the uuid, `--description` and `--codename`. At least one required. The way a campaign filed before codenames existed gets one, and the way a description filed with a typo in it gets fixed. Replacing a codename the campaign already has needs `--force`, since that is the word it is referred to by everywhere; setting the one it already has is a no-op either way. A description needs no `--force`: it is prose written to be revised. No `--clear` and no `--owner` |
|
||||
| `worklane campaign append <campaign>` | Adds a paragraph to a campaign's description with `--description`, which is required. The other half of `campaign set --description`, so adding a line to a description does not mean retyping the rest of it. Repeat the flag for more lines within the one paragraph. Its own subcommand rather than the top-level `append`, which resolves a ticket |
|
||||
@@ -33,7 +33,7 @@ Worklane is a local Kanban flow for agentic software development.
|
||||
|
||||
| Variable | Effect |
|
||||
|----------|--------|
|
||||
| `WORKLANE_ACTOR` | Who every entry the CLI writes is attributed to: a comment, and the `status`, `owner` and `tags` entries `mv`, `chown` and `set --tags` record. Set it once, in the environment an agent runs in, and every call it makes is attributed to it instead of to the git user of whoever's machine it is on. `--actor` overrides it per call, an empty value counts as unset, and with neither supplied the author is the git user and then `unknown`. Free text, checked against nothing |
|
||||
| `WORKLANE_ACTOR` | Who every entry the CLI writes is attributed to: a comment, and the `status`, `owner` and `tags` entries `mv`, `chown` and `set --tags` record. Set it once, in the environment an agent runs in, and every call it makes is attributed to it instead of to the git user of whoever's machine it is on. `--actor` overrides it per call and `--actor-from-git` lifts the git user over it per call (the two flags are refused together), an empty value counts as unset, and with neither supplied the author is the git user and then `unknown`. Free text, checked against nothing |
|
||||
| `NO_COLOR` | Set and non-empty turns colour off, whatever the value, per no-color.org. Colour is also off when output is not a terminal, and when `TERM` is `dumb` or empty |
|
||||
| `XDG_CONFIG_HOME` | Where `install-tool` looks for opencode's config root, `$XDG_CONFIG_HOME/opencode`, defaulting to `~/.config`. `install-skill` does not follow it: `~/.claude` is not an XDG path |
|
||||
|
||||
|
||||
+14
-6
@@ -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
|
||||
|
||||
|
||||
+10
-2
@@ -374,12 +374,20 @@ Code, and the environment opencode is started with for opencode, since it passes
|
||||
environment to the tools it runs.
|
||||
|
||||
**Reach for `--actor` only when the entry is somebody else's action**: the person asked
|
||||
you to move a ticket, or to put words on the board as their comment, so name them on the
|
||||
flag — the move was theirs and the words are theirs, and an entry carrying your name
|
||||
you to move a ticket, or to put words on the board as their comment, so name them on
|
||||
the flag — the move was theirs and the words are theirs, and an entry carrying your name
|
||||
reads later as though you decided both. Otherwise leave it off, unless your instructions
|
||||
say to use it. It is spelled the same on every command that writes an entry: `comment`,
|
||||
`mv`, `chown`, `set` and `assign`.
|
||||
|
||||
Acting for the person without knowing how they spell themselves? `--actor-from-git`
|
||||
attributes the entry to the detected git user instead of `WORKLANE_ACTOR`, so their name
|
||||
is never needed. It cannot be combined with `--actor`, and a machine with no git user
|
||||
configured has nobody to name: the entry reads `unknown` rather than falling back to your
|
||||
variable.
|
||||
|
||||
```
|
||||
worklane mv 1b78a24 --status done --actor "Ansho Rei"
|
||||
```
|
||||
worklane mv 1b78a24 --status done --actor "Ansho Rei"
|
||||
```
|
||||
|
||||
+108
-28
@@ -162,22 +162,35 @@ fn tag_value(raw: &str) -> Result<String, String> {
|
||||
Ok(value.to_string())
|
||||
}
|
||||
|
||||
/// Reject an annotation line that would be read back as a tag of its own.
|
||||
/// Reject an annotation the vocabulary file or the listing cannot carry.
|
||||
///
|
||||
/// The vocabulary is one heading per tag with its prose under it, so a line of prose
|
||||
/// starting with the section marker would split the annotation and declare whatever
|
||||
/// followed. Refused at parse time, where nothing has been written, rather than escaped on
|
||||
/// the way in: an annotation is prose, and quietly rewriting prose is worse than asking for
|
||||
/// a different line.
|
||||
/// followed. A tab anywhere in the value is refused for the listing's sake rather than the
|
||||
/// file's: `tags ls` prints one tag, its count and the annotation's opening line as three
|
||||
/// tab-separated fields, so an annotation holding a tab reads as the start of a fourth
|
||||
/// field and everything after it is silently gone.
|
||||
///
|
||||
/// Both are refused at parse time, where nothing has been written, rather than escaped on
|
||||
/// the way in: an annotation is prose, and quietly rewriting prose is worse than asking
|
||||
/// for a different line.
|
||||
fn annotation_line(raw: &str) -> Result<String, String> {
|
||||
match raw.lines().any(|line| line.starts_with(crate::tag::SECTION)) {
|
||||
true => Err(format!(
|
||||
if raw.lines().any(|line| line.starts_with(crate::tag::SECTION)) {
|
||||
return Err(format!(
|
||||
"an annotation line cannot start with '{}', which is how the vocabulary file \
|
||||
starts a tag",
|
||||
crate::tag::SECTION
|
||||
)),
|
||||
false => Ok(raw.to_string()),
|
||||
));
|
||||
}
|
||||
|
||||
if raw.contains('\t') {
|
||||
return Err(
|
||||
"an annotation cannot contain a tab, which is how `tags ls` separates its fields"
|
||||
.to_string(),
|
||||
);
|
||||
}
|
||||
|
||||
Ok(raw.to_string())
|
||||
}
|
||||
|
||||
/// What `--actor` says on every command that writes a history entry.
|
||||
@@ -186,6 +199,13 @@ fn annotation_line(raw: &str) -> Result<String, String> {
|
||||
/// command reads as five flags.
|
||||
const ACTOR_HELP: &str = "Who the entry is attributed to, overriding WORKLANE_ACTOR and the git user. Free text, checked against nothing";
|
||||
|
||||
/// What `--actor-from-git` says on every command that writes a history entry.
|
||||
///
|
||||
/// The counterpart to [`ACTOR_HELP`]: where that one names somebody specific, this one
|
||||
/// says attribute it to the human whose checkout this is, without knowing how they spell
|
||||
/// themselves.
|
||||
const ACTOR_FROM_GIT_HELP: &str = "Attribute the entry to the detected git user instead of WORKLANE_ACTOR, for acting on the person's behalf. Cannot be combined with --actor";
|
||||
|
||||
/// Arguments that carry prose, and therefore have to accept a value starting with
|
||||
/// a hyphen.
|
||||
///
|
||||
@@ -216,26 +236,7 @@ pub enum Command {
|
||||
},
|
||||
|
||||
/// Move a ticket to a different status
|
||||
Mv {
|
||||
/// Ticket UUID or title
|
||||
ticket: String,
|
||||
|
||||
/// Target status
|
||||
#[arg(short, long)]
|
||||
status: Status,
|
||||
|
||||
/// Force move (allows backward or non-sequential moves)
|
||||
#[arg(short, long)]
|
||||
force: bool,
|
||||
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
actor: Option<String>,
|
||||
|
||||
/// Why the ticket moved, recorded in the history entry beside the transition
|
||||
/// it explains. Prose, so it takes a leading hyphen
|
||||
#[arg(long, allow_hyphen_values = PROSE)]
|
||||
reason: Option<String>,
|
||||
},
|
||||
Mv(MvArgs),
|
||||
|
||||
/// Replace fields on an existing ticket
|
||||
Set(SetArgs),
|
||||
@@ -285,6 +286,9 @@ pub enum Command {
|
||||
/// is `chown`'s. It was `--owner`, which said the wrong one of the two.
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
actor: Option<String>,
|
||||
|
||||
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
|
||||
actor_from_git: bool,
|
||||
},
|
||||
|
||||
/// Group tickets that have to be finished together
|
||||
@@ -310,6 +314,9 @@ pub enum Command {
|
||||
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
actor: Option<String>,
|
||||
|
||||
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
|
||||
actor_from_git: bool,
|
||||
},
|
||||
|
||||
/// The tag vocabulary: what the board carries, and what each tag means
|
||||
@@ -687,6 +694,33 @@ pub struct AddArgs {
|
||||
pub priority: Option<u8>,
|
||||
}
|
||||
|
||||
/// `mv` grew past a handful of parameters when `--actor-from-git` arrived, so it is a
|
||||
/// struct like `set` and `append` rather than an inline variant.
|
||||
#[derive(clap::Args)]
|
||||
pub struct MvArgs {
|
||||
/// Ticket UUID or title
|
||||
pub ticket: String,
|
||||
|
||||
/// Target status
|
||||
#[arg(short, long)]
|
||||
pub status: Status,
|
||||
|
||||
/// Force move (allows backward or non-sequential moves)
|
||||
#[arg(short, long)]
|
||||
pub force: bool,
|
||||
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
pub actor: Option<String>,
|
||||
|
||||
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
|
||||
pub actor_from_git: bool,
|
||||
|
||||
/// Why the ticket moved, recorded in the history entry beside the transition
|
||||
/// it explains. Prose, so it takes a leading hyphen
|
||||
#[arg(long, allow_hyphen_values = PROSE)]
|
||||
pub reason: Option<String>,
|
||||
}
|
||||
|
||||
/// `set` replaces a field outright. Owner is deliberately absent: `chown` owns that
|
||||
/// field, and status is `mv`'s, so no field has two writers.
|
||||
///
|
||||
@@ -751,6 +785,9 @@ pub struct SetArgs {
|
||||
/// command's that is logged
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
pub actor: Option<String>,
|
||||
|
||||
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
|
||||
pub actor_from_git: bool,
|
||||
}
|
||||
|
||||
impl SetArgs {
|
||||
@@ -801,6 +838,9 @@ pub struct ChownArgs {
|
||||
/// change. Both are on this command because it writes both.
|
||||
#[arg(long, help = ACTOR_HELP)]
|
||||
pub actor: Option<String>,
|
||||
|
||||
#[arg(long, conflicts_with = "actor", help = ACTOR_FROM_GIT_HELP)]
|
||||
pub actor_from_git: bool,
|
||||
}
|
||||
|
||||
impl ChownArgs {
|
||||
@@ -1002,4 +1042,44 @@ mod tests {
|
||||
for two minor versions."
|
||||
);
|
||||
}
|
||||
|
||||
/// `--actor` and `--actor-from-git` are one pair that has to travel together: every
|
||||
/// command that takes one takes the other, documented by the same string, because
|
||||
/// the second is the first's spelling for "the human whose checkout this is".
|
||||
///
|
||||
/// A walker rather than five named commands, so a sixth entry-writing command fails
|
||||
/// this on its own `--actor` instead of being forgotten here too.
|
||||
#[test]
|
||||
fn every_actor_command_takes_actor_from_git() {
|
||||
let cli = Cli::command();
|
||||
let mut seen = 0;
|
||||
|
||||
for sub in cli.get_subcommands() {
|
||||
if sub.get_name() == "help" {
|
||||
continue;
|
||||
}
|
||||
|
||||
if !sub.get_arguments().any(|arg| arg.get_id().as_str() == "actor") {
|
||||
continue;
|
||||
}
|
||||
|
||||
seen += 1;
|
||||
let from_git = sub
|
||||
.get_arguments()
|
||||
.find(|arg| arg.get_id().as_str() == "actor_from_git")
|
||||
.unwrap_or_else(|| {
|
||||
panic!("`{}` takes --actor but not --actor-from-git", sub.get_name())
|
||||
});
|
||||
assert_eq!(
|
||||
from_git.get_help().map(|help| help.to_string()),
|
||||
Some(ACTOR_FROM_GIT_HELP.to_string()),
|
||||
"`{}` documents --actor-from-git differently",
|
||||
sub.get_name()
|
||||
);
|
||||
}
|
||||
|
||||
// A guard on the walker itself: if it stopped finding commands, every assertion
|
||||
// above would pass by never running.
|
||||
assert_eq!(seen, 5, "expected comment, mv, chown, set and assign to carry --actor");
|
||||
}
|
||||
}
|
||||
|
||||
+62
-28
@@ -8,7 +8,7 @@ use std::path::Path;
|
||||
use crate::campaign::*;
|
||||
use crate::command::{
|
||||
AddArgs, AppendArgs, CampaignAddArgs, CampaignAppendArgs, CampaignSetArgs, CheckArgs,
|
||||
ChownArgs, LsArgs, RelateArgs, SetArgs, TagAddArgs, TagSetArgs,
|
||||
ChownArgs, LsArgs, MvArgs, RelateArgs, SetArgs, TagAddArgs, TagSetArgs,
|
||||
};
|
||||
use crate::history::{Kind, change, format_history, read_history, write_entry};
|
||||
use crate::install;
|
||||
@@ -378,12 +378,8 @@ pub fn cmd_show(search: &str, worklane_dir: &Path) -> Result<()> {
|
||||
|
||||
/// What is being written, for the messages a failure carries.
|
||||
///
|
||||
/// A `&str` naming the thing rather than two copies of the write path: a campaign file is
|
||||
/// a ticket file in every way that matters here, `<uuid>_<slug>.md` in a directory, and the
|
||||
/// only difference is the word a failure has to use. Every message below puts it
|
||||
/// mid-sentence so there is no capital to case.
|
||||
const TICKET: &str = "ticket";
|
||||
const CAMPAIGN: &str = "campaign";
|
||||
/// `TICKET` and `CAMPAIGN` live in util.rs beside the writers that now carry the noun
|
||||
/// too; only the tag is spelled here, being a file no ticket command writes.
|
||||
const TAG: &str = "tag";
|
||||
|
||||
/// Write `content` over `path`, without ever leaving half a file behind.
|
||||
@@ -602,14 +598,15 @@ fn check_dependents(worklane_dir: &Path, uuid: &str, title: &str) -> Result<()>
|
||||
/// A status is a [`Status`] rather than a string, so an unknown one is clap's to refuse
|
||||
/// and nothing here has to check. What is left is the order of the flow, which is
|
||||
/// `Status::ALL`.
|
||||
pub fn cmd_mv(
|
||||
ticket_id: &str,
|
||||
target: Status,
|
||||
force: bool,
|
||||
actor: &Option<String>,
|
||||
reason: &Option<String>,
|
||||
start: &Path,
|
||||
) -> Result<()> {
|
||||
pub fn cmd_mv(args: &MvArgs, start: &Path) -> Result<()> {
|
||||
let MvArgs {
|
||||
ticket: ticket_id,
|
||||
status: target,
|
||||
force,
|
||||
actor,
|
||||
actor_from_git,
|
||||
reason,
|
||||
} = args;
|
||||
let target_status = target.as_str();
|
||||
|
||||
// A reason is one fact on one line, which is how the renderer draws it, so a
|
||||
@@ -628,13 +625,13 @@ pub fn cmd_mv(
|
||||
.iter()
|
||||
.position(|status| status.as_str() == current_status)
|
||||
.unwrap();
|
||||
let target_idx = Status::ALL.iter().position(|status| *status == target).unwrap();
|
||||
let target_idx = Status::ALL.iter().position(|status| *status == *target).unwrap();
|
||||
|
||||
// Discarding is not a stage of work, so the walk rules below do not apply to
|
||||
// entering it: a ticket is abandoned from wherever it stands. They do apply to
|
||||
// leaving it, which with discarded last in `Status::ALL` is always a backward move,
|
||||
// so un-discarding needs `-f` with no rule of its own.
|
||||
let discarding = target == Status::Discarded;
|
||||
let discarding = *target == Status::Discarded;
|
||||
|
||||
if !force && !discarding && target_idx < current_idx {
|
||||
return Err(anyhow!(
|
||||
@@ -651,8 +648,41 @@ pub fn cmd_mv(
|
||||
}
|
||||
|
||||
if current_status == target_status {
|
||||
// `current_status` is read off the directory, so this comparison is the field's
|
||||
// only chance to be seen. A ticket whose file sits here and whose Status field
|
||||
// says something else is a hand-moved file or a partial restore, and refusing it
|
||||
// as a no-op left a repair nobody could reach without moving the file away and
|
||||
// back; the mirror case, where the field leads the directory after a crash in
|
||||
// move_ticket_file, is what the next real mv corrects.
|
||||
let recorded = parse_ticket_field(&resolved, "Status");
|
||||
|
||||
if recorded == target_status {
|
||||
println!(
|
||||
"Ticket is already in '{}' status.",
|
||||
color_text(target_status, Color::Orange)
|
||||
);
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
// The repair is not a move, so none of what gates one applies: not `-f`, which
|
||||
// overrides transitions, and not the dependency guards behind it. Only the field
|
||||
// is rewritten — no stamp, because the work arrived nowhere new, and no history
|
||||
// entry, because an entry shaped like a transition would record a journey the
|
||||
// ticket never took.
|
||||
let corrected = set_status_field(&resolved, target_status, &title)?;
|
||||
save_ticket(
|
||||
&worklane_dir,
|
||||
¤t_status,
|
||||
&parse_ticket_field(&resolved, "ID"),
|
||||
&title,
|
||||
None,
|
||||
&corrected,
|
||||
)?;
|
||||
|
||||
println!(
|
||||
"Ticket is already in '{}' status.",
|
||||
"Corrected Status field on '{}': said {}, but the file sits in {}.",
|
||||
color_text(&title, Color::Green),
|
||||
color_text(&recorded, Color::Orange),
|
||||
color_text(target_status, Color::Orange)
|
||||
);
|
||||
return Ok(());
|
||||
@@ -688,7 +718,7 @@ pub fn cmd_mv(
|
||||
// crash-safe write the Status field does.
|
||||
let content = set_status_stamp(
|
||||
&content,
|
||||
target,
|
||||
*target,
|
||||
&Local::now().format(TIMESTAMP_FORMAT).to_string(),
|
||||
&title,
|
||||
)?;
|
||||
@@ -713,7 +743,7 @@ pub fn cmd_mv(
|
||||
&parse_ticket_field(&resolved, "ID"),
|
||||
Kind::Status,
|
||||
&change(¤t_status, target_status),
|
||||
&resolve_actor(actor.as_deref()),
|
||||
&resolve_actor(actor.as_deref(), *actor_from_git),
|
||||
&reason,
|
||||
)?;
|
||||
|
||||
@@ -731,6 +761,7 @@ pub fn cmd_comment(
|
||||
ticket_id: &str,
|
||||
body: &str,
|
||||
actor: &Option<String>,
|
||||
actor_from_git: bool,
|
||||
start: &Path,
|
||||
) -> Result<()> {
|
||||
if body.is_empty() {
|
||||
@@ -750,7 +781,7 @@ pub fn cmd_comment(
|
||||
&ticket_uuid,
|
||||
Kind::Comment,
|
||||
body,
|
||||
&resolve_actor(actor.as_deref()),
|
||||
&resolve_actor(actor.as_deref(), actor_from_git),
|
||||
"",
|
||||
)?;
|
||||
|
||||
@@ -934,7 +965,7 @@ pub fn cmd_set(args: &SetArgs, start: &Path) -> Result<()> {
|
||||
let mut cleared: Vec<&str> = Vec::new();
|
||||
|
||||
if let Some(new_title) = &args.title {
|
||||
let next = set_title(&content, new_title)?;
|
||||
let next = set_title(&content, new_title, TICKET)?;
|
||||
apply(&mut content, &mut changed, "title", next);
|
||||
}
|
||||
|
||||
@@ -999,7 +1030,7 @@ pub fn cmd_set(args: &SetArgs, start: &Path) -> Result<()> {
|
||||
&parse_ticket_field(&original, "Tags"),
|
||||
&parse_ticket_field(&content, "Tags"),
|
||||
),
|
||||
&resolve_actor(args.actor.as_deref()),
|
||||
&resolve_actor(args.actor.as_deref(), args.actor_from_git),
|
||||
"",
|
||||
)?;
|
||||
}
|
||||
@@ -1058,7 +1089,7 @@ pub fn cmd_chown(args: &ChownArgs, start: &Path) -> Result<()> {
|
||||
&parse_ticket_field(&original, "Owner"),
|
||||
&parse_ticket_field(&content, "Owner"),
|
||||
),
|
||||
&resolve_actor(args.actor.as_deref()),
|
||||
&resolve_actor(args.actor.as_deref(), args.actor_from_git),
|
||||
"",
|
||||
)?;
|
||||
|
||||
@@ -1641,7 +1672,7 @@ pub fn cmd_campaign_set(args: &CampaignSetArgs, start: &Path) -> Result<()> {
|
||||
let mut changed: Vec<&str> = Vec::new();
|
||||
|
||||
if let Some(new_title) = &args.title {
|
||||
let next = set_title(&content, new_title)?;
|
||||
let next = set_title(&content, new_title, CAMPAIGN)?;
|
||||
apply(&mut content, &mut changed, "title", next);
|
||||
}
|
||||
|
||||
@@ -1656,7 +1687,8 @@ pub fn cmd_campaign_set(args: &CampaignSetArgs, start: &Path) -> Result<()> {
|
||||
}
|
||||
|
||||
if let Some(codename) = &args.codename {
|
||||
let next = set_or_insert_metadata_field(&content, CODENAME_FIELD, codename, &title)?;
|
||||
let next =
|
||||
set_or_insert_metadata_field(&content, CODENAME_FIELD, codename, CAMPAIGN, &title)?;
|
||||
apply(&mut content, &mut changed, "codename", next);
|
||||
}
|
||||
|
||||
@@ -1742,6 +1774,7 @@ pub fn cmd_assign(
|
||||
campaign_search: &str,
|
||||
ticket_id: &str,
|
||||
actor: &Option<String>,
|
||||
actor_from_git: bool,
|
||||
start: &Path,
|
||||
) -> Result<()> {
|
||||
let worklane_dir = find_worklane_dir(start)?;
|
||||
@@ -1749,7 +1782,8 @@ pub fn cmd_assign(
|
||||
let (status, title, original) = resolve_ticket(ticket_id, &worklane_dir)?;
|
||||
let uuid = parse_ticket_field(&original, "ID");
|
||||
|
||||
let content = set_or_insert_metadata_field(&original, CAMPAIGN_FIELD, &campaign.uuid, &title)?;
|
||||
let content =
|
||||
set_or_insert_metadata_field(&original, CAMPAIGN_FIELD, &campaign.uuid, TICKET, &title)?;
|
||||
|
||||
if content == original {
|
||||
println!(
|
||||
@@ -1779,7 +1813,7 @@ pub fn cmd_assign(
|
||||
&uuid,
|
||||
Kind::Campaign,
|
||||
&change(&before, campaign.name()),
|
||||
&resolve_actor(actor.as_deref()),
|
||||
&resolve_actor(actor.as_deref(), actor_from_git),
|
||||
"",
|
||||
)?;
|
||||
|
||||
|
||||
+6
-5
@@ -489,10 +489,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 +500,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
|
||||
|
||||
+13
-13
@@ -57,22 +57,19 @@ fn main() -> Result<()> {
|
||||
let worklane_dir = find_worklane_dir(&start)?;
|
||||
cmd_show(&id, &worklane_dir)
|
||||
}
|
||||
Some(Command::Mv {
|
||||
ticket,
|
||||
status,
|
||||
force,
|
||||
actor,
|
||||
reason,
|
||||
}) => cmd_mv(&ticket, status, force, &actor, &reason, &start),
|
||||
Some(Command::Mv(args)) => cmd_mv(&args, &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)
|
||||
}
|
||||
Some(Command::Comment {
|
||||
ticket,
|
||||
body,
|
||||
actor,
|
||||
actor_from_git,
|
||||
}) => cmd_comment(&ticket, &body, &actor, actor_from_git, &start),
|
||||
Some(Command::Campaign { command }) => match command {
|
||||
CampaignCommand::Add(args) => cmd_campaign_add(&args, &start),
|
||||
CampaignCommand::Ls { ids } => {
|
||||
@@ -86,9 +83,12 @@ fn main() -> Result<()> {
|
||||
cmd_campaign_show(&campaign, &worklane_dir)
|
||||
}
|
||||
},
|
||||
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),
|
||||
// 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.
|
||||
|
||||
+162
-57
@@ -449,52 +449,78 @@ pub const ACTOR_ENV: &str = "WORKLANE_ACTOR";
|
||||
/// The author written when nothing names one.
|
||||
pub const UNKNOWN_ACTOR: &str = "unknown";
|
||||
|
||||
/// The actor for the whole run: the variable, then the git user.
|
||||
/// The actor for the whole run, from the variable alone.
|
||||
///
|
||||
/// Split out from the caching wrapper for the reason `colors_wanted` is: a threaded test
|
||||
/// binary cannot mutate the process environment to reach one branch at a time.
|
||||
///
|
||||
/// An empty `WORKLANE_ACTOR` counts as unset, the convention `colors_wanted` follows for
|
||||
/// `NO_COLOR`, so a wrapper script can clear an inherited one. `git_user` is a closure
|
||||
/// rather than a value because the fallback costs a subprocess and the variable usually
|
||||
/// answers first.
|
||||
fn session_actor(env: Option<&str>, git_user: impl FnOnce() -> Option<String>) -> Option<String> {
|
||||
match env.map(str::trim).filter(|value| !value.is_empty()) {
|
||||
Some(value) => Some(value.to_string()),
|
||||
None => git_user(),
|
||||
}
|
||||
/// `NO_COLOR`, so a wrapper script can clear an inherited one. This is the half the
|
||||
/// [`resolve_actor`] cache holds; the git user lives in a cache of its own, because with
|
||||
/// `--actor-from-git` it has to be fetched even though the variable answered.
|
||||
fn session_actor(env: Option<&str>) -> Option<String> {
|
||||
env.map(str::trim)
|
||||
.filter(|value| !value.is_empty())
|
||||
.map(str::to_string)
|
||||
}
|
||||
|
||||
/// The actor for one entry: the flag wins, otherwise the session's, otherwise unknown.
|
||||
/// The actor for one entry, from what named one.
|
||||
///
|
||||
/// Free text, validated against nothing, the way the `chown` user is: there is no
|
||||
/// registry of actors to check a name against.
|
||||
fn entry_actor(flag: Option<&str>, session: Option<&str>) -> String {
|
||||
[flag, session]
|
||||
.into_iter()
|
||||
.flatten()
|
||||
.map(str::trim)
|
||||
.find(|value| !value.is_empty())
|
||||
.unwrap_or(UNKNOWN_ACTOR)
|
||||
.to_string()
|
||||
///
|
||||
/// The chain depends on the flag. An explicit `--actor` wins outright either way. With
|
||||
/// `from_git`, the git user is lifted above the session rather than added beneath it:
|
||||
/// the flag says attribute this to the human, and a machine with no git user configured
|
||||
/// has nobody to name, which reads [`UNKNOWN_ACTOR`] rather than quietly attributing
|
||||
/// back to the agent. Without it, today's chain: the variable, then the git user.
|
||||
///
|
||||
/// `git_user` is a closure in both branches so the subprocess it costs is not run when
|
||||
/// something ahead of it already answered.
|
||||
fn entry_actor(
|
||||
flag: Option<&str>,
|
||||
from_git: bool,
|
||||
session: Option<&str>,
|
||||
git_user: impl FnOnce() -> Option<String>,
|
||||
) -> String {
|
||||
if let Some(name) = flag.map(str::trim).filter(|value| !value.is_empty()) {
|
||||
return name.to_string();
|
||||
}
|
||||
|
||||
if from_git {
|
||||
return git_user().unwrap_or_else(|| UNKNOWN_ACTOR.to_string());
|
||||
}
|
||||
|
||||
if let Some(name) = session.map(str::trim).filter(|value| !value.is_empty()) {
|
||||
return name.to_string();
|
||||
}
|
||||
|
||||
git_user().unwrap_or_else(|| UNKNOWN_ACTOR.to_string())
|
||||
}
|
||||
|
||||
/// Who to attribute an entry to, from the flag the call carried.
|
||||
/// Who to attribute an entry to, from the flags the call carried.
|
||||
///
|
||||
/// Precedence: flag, then `WORKLANE_ACTOR`, then the git user, then `unknown`. Every
|
||||
/// entry the CLI writes goes through here, so a board several agents write to says which
|
||||
/// of them wrote what instead of attributing all of it to one human.
|
||||
pub fn resolve_actor(flag: Option<&str>) -> String {
|
||||
// The session half is decided once, the way should_use_colors is: neither input can
|
||||
// change mid-run, and the git user costs a subprocess.
|
||||
static SESSION: OnceLock<Option<String>> = OnceLock::new();
|
||||
/// Precedence: flag, then — unless `from_git` lifted it — `WORKLANE_ACTOR`, then the git
|
||||
/// user, then `unknown`. Every entry the CLI writes goes through here, so a board
|
||||
/// several agents write to says which of them wrote what instead of attributing all of
|
||||
/// it to one human.
|
||||
pub fn resolve_actor(flag: Option<&str>, from_git: bool) -> String {
|
||||
// Each half is decided once, the way should_use_colors is: neither input can change
|
||||
// mid-run, and the git user costs a subprocess. They are two caches rather than one,
|
||||
// because baking the git user into the session's answer would leave `--actor-from-git`
|
||||
// reading whatever the run's *first* call produced — with the variable set, that call
|
||||
// never fetched git at all.
|
||||
static VARIABLE: OnceLock<Option<String>> = OnceLock::new();
|
||||
static GIT_USER: OnceLock<Option<String>> = OnceLock::new();
|
||||
|
||||
let session = SESSION.get_or_init(|| {
|
||||
let session = VARIABLE.get_or_init(|| {
|
||||
let env = std::env::var(ACTOR_ENV).ok();
|
||||
session_actor(env.as_deref(), get_git_user)
|
||||
session_actor(env.as_deref())
|
||||
});
|
||||
|
||||
entry_actor(flag, session.as_deref())
|
||||
entry_actor(flag, from_git, session.as_deref(), || {
|
||||
GIT_USER.get_or_init(get_git_user).clone()
|
||||
})
|
||||
}
|
||||
/// One file a search matched, and where it was found.
|
||||
pub struct Found {
|
||||
@@ -1514,6 +1540,17 @@ const METADATA_ORDER: [&str; 13] = [
|
||||
"Status",
|
||||
];
|
||||
|
||||
/// What is being written, for the messages a failure carries.
|
||||
///
|
||||
/// A `&str` naming the thing rather than two copies of every message that names its
|
||||
/// object: a campaign file is a ticket file in every way that matters here,
|
||||
/// `<uuid>_<slug>.md` in a directory, and the only difference is the word a failure has
|
||||
/// to use. Every message below puts it mid-sentence so there is no capital to case.
|
||||
/// Lived in the handlers until the writers here started carrying the noun too; both
|
||||
/// sides read these through one definition so the words cannot drift apart.
|
||||
pub const TICKET: &str = "ticket";
|
||||
pub const CAMPAIGN: &str = "campaign";
|
||||
|
||||
/// Rewrite a metadata field, adding the line when the file has no such field yet.
|
||||
///
|
||||
/// [`set_metadata_field`] refuses a field that is not already there, which is right for
|
||||
@@ -1526,6 +1563,7 @@ pub fn set_or_insert_metadata_field(
|
||||
content: &str,
|
||||
field: &str,
|
||||
value: &str,
|
||||
noun: &str,
|
||||
title: &str,
|
||||
) -> Result<String> {
|
||||
let prefix = format!("**{}**:", field);
|
||||
@@ -1534,7 +1572,7 @@ pub fn set_or_insert_metadata_field(
|
||||
metadata_field_body(line).starts_with(&prefix)
|
||||
}) {
|
||||
Some(updated) => Ok(updated),
|
||||
None => insert_metadata_field(content, field, value, title),
|
||||
None => insert_metadata_field(content, field, value, noun, title),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1543,14 +1581,26 @@ pub fn set_or_insert_metadata_field(
|
||||
/// A file with no Metadata section is an error rather than an insertion. There is no
|
||||
/// format to guess at there, and per 641e3d5 such a file has no fields at all, so
|
||||
/// writing one above the prose would be inventing a shape nothing else reads.
|
||||
fn insert_metadata_field(content: &str, field: &str, value: &str, title: &str) -> Result<String> {
|
||||
///
|
||||
/// The noun travels with the call rather than being spelled here, because both a ticket
|
||||
/// and a campaign reach this: `campaign set --codename` inserts into a campaign, and
|
||||
/// "Ticket 'v1 release' has no Metadata section" would be wrong about the one file it
|
||||
/// names.
|
||||
fn insert_metadata_field(
|
||||
content: &str,
|
||||
field: &str,
|
||||
value: &str,
|
||||
noun: &str,
|
||||
title: &str,
|
||||
) -> Result<String> {
|
||||
let lines: Vec<&str> = content.lines().collect();
|
||||
let heading = lines
|
||||
.iter()
|
||||
.position(|line| is_metadata_heading(line))
|
||||
.ok_or_else(|| {
|
||||
anyhow!(
|
||||
"Ticket '{}' has no Metadata section, so its {} field cannot be written",
|
||||
"There is no Metadata section on {} '{}', so its {} field cannot be written",
|
||||
noun,
|
||||
title,
|
||||
field
|
||||
)
|
||||
@@ -1640,7 +1690,7 @@ pub fn set_status_stamp(content: &str, target: Status, now: &str, title: &str) -
|
||||
match target.stamp_field() {
|
||||
// Inserted on demand, the way Campaign is: every ticket written before these
|
||||
// fields existed carries none of them.
|
||||
Some(field) => set_or_insert_metadata_field(&content, field, now, title),
|
||||
Some(field) => set_or_insert_metadata_field(&content, field, now, TICKET, title),
|
||||
None => Ok(content),
|
||||
}
|
||||
}
|
||||
@@ -1648,7 +1698,10 @@ pub fn set_status_stamp(content: &str, target: Status, now: &str, title: &str) -
|
||||
/// Rewrite the title heading, the first `# ` line in the file.
|
||||
///
|
||||
/// `## ` headings do not match: the second character has to be a space.
|
||||
pub fn set_title(content: &str, title: &str) -> Result<String> {
|
||||
///
|
||||
/// The noun travels with the call for the same reason [`insert_metadata_field`] carries
|
||||
/// one: `campaign set --title` rewrites a campaign's heading too.
|
||||
pub fn set_title(content: &str, title: &str, noun: &str) -> Result<String> {
|
||||
let mut updated = String::with_capacity(content.len());
|
||||
let mut found = false;
|
||||
|
||||
@@ -1664,7 +1717,7 @@ pub fn set_title(content: &str, title: &str) -> Result<String> {
|
||||
}
|
||||
|
||||
if !found {
|
||||
return Err(anyhow!("Ticket '{}' has no title heading", title));
|
||||
return Err(anyhow!("There is no title heading on {} '{}'", noun, title));
|
||||
}
|
||||
|
||||
Ok(updated)
|
||||
@@ -3651,48 +3704,99 @@ mod tests {
|
||||
/// closure returns a name that must not appear.
|
||||
#[test]
|
||||
fn the_variable_names_the_actor() {
|
||||
let session = session_actor(Some("claude"), || Some("Ansho Rei".to_string()));
|
||||
assert_eq!(entry_actor(None, session.as_deref()), "claude");
|
||||
let session = session_actor(Some("claude"));
|
||||
let git_user = || Some("Ansho Rei".to_string());
|
||||
assert_eq!(entry_actor(None, false, session.as_deref(), git_user), "claude");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_flag_overrides_the_variable() {
|
||||
let session = session_actor(Some("claude"), || None);
|
||||
assert_eq!(entry_actor(Some("opencode"), session.as_deref()), "opencode");
|
||||
let session = session_actor(Some("claude"));
|
||||
assert_eq!(
|
||||
entry_actor(Some("opencode"), false, session.as_deref(), || None),
|
||||
"opencode"
|
||||
);
|
||||
}
|
||||
|
||||
/// With neither supplied the author is still the git user.
|
||||
#[test]
|
||||
fn the_git_user_is_the_fallback() {
|
||||
let session = session_actor(None, || Some("Ansho Rei".to_string()));
|
||||
assert_eq!(entry_actor(None, session.as_deref()), "Ansho Rei");
|
||||
let git_user = || Some("Ansho Rei".to_string());
|
||||
assert_eq!(
|
||||
entry_actor(None, false, session_actor(None).as_deref(), git_user),
|
||||
"Ansho Rei"
|
||||
);
|
||||
}
|
||||
|
||||
/// An empty variable counts as unset, the way `NO_COLOR` does, so a wrapper script
|
||||
/// can clear an inherited one and get the git user back.
|
||||
/// can clear an inherited one and get the git user back. Whitespace is the same
|
||||
/// case: a shell that quotes a missing value writes one.
|
||||
#[test]
|
||||
fn an_empty_variable_reads_as_unset() {
|
||||
let session = session_actor(Some(""), || Some("Ansho Rei".to_string()));
|
||||
assert_eq!(entry_actor(None, session.as_deref()), "Ansho Rei");
|
||||
// Whitespace is the same case: a shell that quotes a missing value writes one
|
||||
let session = session_actor(Some(" "), || Some("Ansho Rei".to_string()));
|
||||
assert_eq!(entry_actor(None, session.as_deref()), "Ansho Rei");
|
||||
let git_user = || Some("Ansho Rei".to_string());
|
||||
for raw in ["", " "] {
|
||||
let session = session_actor(Some(raw));
|
||||
assert_eq!(entry_actor(None, false, session.as_deref(), git_user), "Ansho Rei");
|
||||
}
|
||||
}
|
||||
|
||||
/// And with nothing at all, including a git that has no user configured.
|
||||
#[test]
|
||||
fn nothing_at_all_is_unknown() {
|
||||
let session = session_actor(None, || None);
|
||||
assert_eq!(entry_actor(None, session.as_deref()), UNKNOWN_ACTOR);
|
||||
let session = session_actor(None);
|
||||
assert_eq!(entry_actor(None, false, session.as_deref(), || None), UNKNOWN_ACTOR);
|
||||
// An empty flag falls through rather than writing a blank author
|
||||
assert_eq!(entry_actor(Some(""), None), UNKNOWN_ACTOR);
|
||||
assert_eq!(entry_actor(Some(""), false, None, || None), UNKNOWN_ACTOR);
|
||||
}
|
||||
|
||||
/// Free text, validated against nothing, the way the `chown` user is.
|
||||
#[test]
|
||||
fn an_actor_is_free_text() {
|
||||
let session = session_actor(Some("claude-code, session 3 (opus)"), || None);
|
||||
assert_eq!(entry_actor(None, session.as_deref()), "claude-code, session 3 (opus)");
|
||||
let session = session_actor(Some("claude-code, session 3 (opus)"));
|
||||
assert_eq!(
|
||||
entry_actor(None, false, session.as_deref(), || None),
|
||||
"claude-code, session 3 (opus)"
|
||||
);
|
||||
}
|
||||
|
||||
/// The flag is the caller acting for the person whose checkout this is: the git user
|
||||
/// is lifted above the variable rather than added beneath it.
|
||||
#[test]
|
||||
fn from_git_lifts_the_git_user_over_the_variable() {
|
||||
let session = session_actor(Some("claude"));
|
||||
let git_user = || Some("Ansho Rei".to_string());
|
||||
assert_eq!(entry_actor(None, true, session.as_deref(), git_user), "Ansho Rei");
|
||||
}
|
||||
|
||||
/// An explicit `--actor` still wins outright beside the lift: it names somebody
|
||||
/// specific, which is the stronger statement of the two.
|
||||
#[test]
|
||||
fn the_flag_wins_over_from_git_too() {
|
||||
let session = session_actor(Some("claude"));
|
||||
let git_user = || Some("Ansho Rei".to_string());
|
||||
assert_eq!(
|
||||
entry_actor(Some("opencode"), true, session.as_deref(), git_user),
|
||||
"opencode"
|
||||
);
|
||||
}
|
||||
|
||||
/// The lift is not a fallback: asked to name the human and finding none configured,
|
||||
/// the entry reads unknown instead of quietly attributing back to the agent.
|
||||
#[test]
|
||||
fn from_git_with_no_git_user_is_unknown_not_the_variable() {
|
||||
let session = session_actor(Some("claude"));
|
||||
assert_eq!(entry_actor(None, true, session.as_deref(), || None), UNKNOWN_ACTOR);
|
||||
}
|
||||
|
||||
/// An empty variable still counts as unset with the lift on, which here means the
|
||||
/// git user answers as usual.
|
||||
#[test]
|
||||
fn from_git_leaves_the_empty_variable_unset() {
|
||||
let git_user = || Some("Ansho Rei".to_string());
|
||||
assert_eq!(
|
||||
entry_actor(None, true, session_actor(Some("")).as_deref(), git_user),
|
||||
"Ansho Rei"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -4207,7 +4311,7 @@ mod tests {
|
||||
let content = with_metadata("- **ID**: abc\n- **Owner**: alice\n- **Status**: backlog\n");
|
||||
|
||||
let updated =
|
||||
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "c-uuid", "T").unwrap();
|
||||
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "c-uuid", TICKET, "T").unwrap();
|
||||
|
||||
// Against METADATA_ORDER, so Status stays last where every file keeps it.
|
||||
assert!(
|
||||
@@ -4224,7 +4328,7 @@ mod tests {
|
||||
let content = with_metadata("- **ID**: abc\n- **Owner**: alice\n\n## Notes\nAfter.\n");
|
||||
|
||||
let updated =
|
||||
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "c-uuid", "T").unwrap();
|
||||
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "c-uuid", TICKET, "T").unwrap();
|
||||
|
||||
assert!(
|
||||
updated.contains("- **Owner**: alice\n- **Campaign**: c-uuid\n\n## Notes\nAfter.\n"),
|
||||
@@ -4240,7 +4344,7 @@ mod tests {
|
||||
with_metadata("- **ID**: abc\n- **Campaign**: first\n- **Status**: backlog\n");
|
||||
|
||||
let updated =
|
||||
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "second", "T").unwrap();
|
||||
set_or_insert_metadata_field(&content, CAMPAIGN_FIELD, "second", TICKET, "T").unwrap();
|
||||
|
||||
assert_eq!(updated.matches("**Campaign**:").count(), 1, "{updated}");
|
||||
assert!(updated.contains("- **Campaign**: second"), "{updated}");
|
||||
@@ -4253,7 +4357,8 @@ mod tests {
|
||||
let content = "# T\n\n## Description\n- **Campaign**: not a field\n\n\
|
||||
## Metadata\n\n- **ID**: abc\n- **Status**: backlog\n";
|
||||
|
||||
let updated = set_or_insert_metadata_field(content, CAMPAIGN_FIELD, "c-uuid", "T").unwrap();
|
||||
let updated =
|
||||
set_or_insert_metadata_field(content, CAMPAIGN_FIELD, "c-uuid", TICKET, "T").unwrap();
|
||||
|
||||
assert!(updated.contains("- **Campaign**: not a field"), "{updated}");
|
||||
assert!(
|
||||
@@ -4268,7 +4373,7 @@ mod tests {
|
||||
fn a_file_with_no_metadata_section_is_an_error_rather_than_an_insertion() {
|
||||
let content = "# T\n\n## Description\nBody.\n";
|
||||
|
||||
let error = set_or_insert_metadata_field(content, CAMPAIGN_FIELD, "c-uuid", "T")
|
||||
let error = set_or_insert_metadata_field(content, CAMPAIGN_FIELD, "c-uuid", TICKET, "T")
|
||||
.expect_err("a file with no Metadata section gained a field");
|
||||
|
||||
assert!(error.to_string().contains("no Metadata section"), "{error}");
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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