Compare commits

...
2 Commits
Author SHA1 Message Date
Ansho ReiandClaude Opus 5 8e2ab6332c (8c8a520) Ship a board administration skill, and bump to 0.26.1
Three skills taught the CLI, the review and the grooming sweep. Nothing taught
the board itself, and two jobs fell in the gap: deciding what the tags are, now
that `tags add` and `tags set` exist to declare them, and putting a board back
together when its files and fields disagree.

`worklane-admin` is the fourth. It is the one asset written to hold for a board
that tracks no software, since a vocabulary skill built around `bug` and `cli`
teaches nothing to a board tracking a household, so its worked examples span a
tool, a product strategy and a house. Tags as axes rather than as a pile of
words, what an annotation has to say to stop drift, which is the boundary
against the neighbouring tag and not the definition, and the fact that renaming
a tag means rewriting the Tags field of every ticket carrying it.

The repairs are by symptom and every one was run against a scratch board
rather than reasoned from the source, which is what the ticket demanded and
what turned up the one that matters: a ticket whose file sits in `done` while
its Status field says `backlog` cannot be repaired by one `mv`, because `mv`
reads the current status from the directory and refuses the target it is
already in. Two moves fix it. That is 7f772a7. Verifying also turned up that
nothing removes a relation, 8556048.

The line against `worklane-plan` is drawn in both documents: this one decides
the vocabulary, that one applies it across tickets.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-23 16:24:38 +02:00
Ansho ReiandClaude Opus 5 239d951b8c (9688d34) Add tags set, and bump to 0.26.0
A tag declared with the wrong annotation was stuck with it, which is 32e98ab's
hole arriving before the writer rather than after. The campaigns entry on this
board was already in that state: it reserved the singular for the campaign
command, and stopped being true the moment that tag was rolled in.

`worklane tags set <tag> --annotation` replaces the whole annotation.
`--annotation` is required, so a bare call is a usage error rather than a
silent no-op, and an empty one writes the placeholder, which is why there is
no `--clear`. `add` and `set` refuse what the other is for, each naming the
other, so which one wrote a line is never a question of which was typed.

No `--force`: a codename is guarded because a campaign is addressed by it,
where an annotation is prose written to be revised. No rename: the tag is the
key, so changing it means rewriting the Tags field of every ticket carrying
it.

`report` grew `report_in`, which takes the colour. `report` paints its subject
green and green means title, so a tag could not reuse it: a tag is drawn in a
`TAG_COLORS` slot or it is drawn wrong. Same wording, decision passed in,
which is the trade `paint` makes with `color_text`.

The no-op compares the rendered file rather than the annotation, the way
`apply` compares content for a ticket field.

`tags set` takes a tag the board already has, so it joins the new
`TAG_NESTED_COMMANDS` and gets a fish rule offering `worklane tags`; `tags
add` stays ruleless in `TAG_NEW_COMMANDS`. The guard now names both lists, so
the next tag positional has to pick one.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-23 16:09:03 +02:00
12 changed files with 630 additions and 15 deletions
+1
View File
@@ -13,6 +13,7 @@
- `assets/SKILL.md` - the agent skill for the CLI itself, embedded with `include_str!`
- `assets/REVIEW.md` - the agent skill for reviewing a finished ticket, shipped the same way. Assets are named after the role they teach; `SKILL.md` keeps its name because the role it teaches is the CLI
- `assets/PLAN.md` - the agent skill for grooming the whole board: priorities, due dates, tags and campaigns
- `assets/ADMIN.md` - the agent skill for the board itself: designing and annotating the tag vocabulary, and repairing a board whose files and fields have come apart. The one asset written to hold for a board that tracks no software, so its examples span three subjects on purpose. It draws the line against `PLAN.md` in both directions: this one decides the vocabulary, that one applies it
- `assets/TOOL.ts` - the opencode tool definitions wrapping the CLI, embedded the same way and installed by `install-tool`. The only asset that is not a document and the only one that reaches a single agent
- `tests/` - Integration tests using `assert_cmd` and `assert_fs`, one file per command
- Unit tests live beside the code in `#[cfg(test)] mod tests`, in `util.rs`, `handlers.rs` and `tui.rs`
Generated
+1 -1
View File
@@ -1503,7 +1503,7 @@ dependencies = [
[[package]]
name = "worklane"
version = "0.25.0"
version = "0.26.1"
dependencies = [
"anyhow",
"assert_cmd",
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "worklane"
version = "0.25.0"
version = "0.26.1"
edition = "2024"
[dependencies]
+1 -1
View File
@@ -25,7 +25,7 @@ Worklane is a local Kanban flow for agentic software development.
| `worklane assign <campaign> <ticket>` | Puts a ticket in a campaign, the only command that writes the Campaign field. Campaign first and ticket second, after `chown`. A ticket is in at most one, so assigning one that already belongs somewhere moves it |
| `worklane tags` | Lists the tags the board carries as the tag, a tab and how many tickets carry it, one per line, unstyled and alphabetical. Case sensitive like `ls --tag`, so `bug` and `Bug` list separately and land next to each other. Every status, done included. The one command that answers what tags exist rather than what carries a tag already known |
| `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. Three 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. 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-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 |
## Completions
+318
View File
@@ -0,0 +1,318 @@
---
name: worklane-admin
description: Set up and repair a worklane board itself, whatever it tracks: design and annotate the tag vocabulary with `worklane tags`, retire or rename a tag, and fix a board whose files and fields disagree, such as a ticket missing from `ls`, a duplicated id, a stray temp file or a move that will not go through. Use when the subject is the board's own configuration or health. Not for filing, working or reviewing a ticket, and not for priorities, due dates or campaigns.
---
# Administering a worklane board
For "set up a board for this", "what tags should this board have", "add a tag", "what
does this tag mean", "the board is in a weird state", "this ticket has gone missing".
The subject is the board itself: the vocabulary it files against, and the parts that can
come apart.
The CLI is the `worklane` skill: the statuses, how a ticket is addressed, which command
owns which field. Read it too.
**This is not `worklane-plan`.** That skill grooms the work: priorities, due dates,
retagging tickets, campaigns. This one decides what the tags *are* and puts the board
back together. The line between them is the tag section: designing and annotating the
vocabulary is here, applying it across tickets is there.
## A board is not only for software
Everything below holds for a board tracking a product strategy, a house move or a term's
teaching, and the worked examples say so. What changes between domains is the tags, never
the shape. Nothing in worklane knows what your tickets are about.
Two things you do not get to configure, whatever the board is for:
- **The four statuses.** `backlog`, `committed`, `reviewing`, `done`, in that order, one
step at a time. There is no way to rename them or add a fifth. If a board wants a
waiting-on-someone-else state, that is a tag, and the ticket stays in `committed`.
- **The fields.** Priority 1 to 5, Due, Owner, Tags, Campaign. A board that wants a
concept these do not cover expresses it as a tag or a campaign, not as a new field.
So the tag vocabulary is where a board is fitted to its subject, and it is most of this
document.
## Starting a board
```
worklane init # in the directory the board belongs to
```
Which directory decides which board. Commands walk up from the working directory to the
nearest `.worklane`, so a board in `~/house` answers every `worklane` run from anywhere
under `~/house` and nowhere else.
`init` makes the four status directories, the campaigns directory and an empty `tags.md`.
Run on a board that already exists it prints a line and changes nothing, which is what
makes it safe to run when you are not sure.
Then declare the vocabulary before the tickets pile up. Tags applied for months are far
harder to change than tags agreed once, because changing one means rewriting every ticket
carrying it.
## Designing a tag vocabulary
A tag is a word a ticket carries so the board can be cut by it later. `worklane ls --tag
kitchen` is the whole payoff, so the test of a good vocabulary is whether the cuts it
allows are cuts anyone wants.
### Work in axes
An axis is one question every ticket on this board can answer, with a small closed set of
answers. Pick two or three axes and keep them apart. Nearly every vocabulary that goes
bad is one where two axes were mixed into one pile of words.
A software tool:
| Axis | Answers |
|---|---|
| Kind | `feature`, `bug`, `chore`, `docs` |
| Area | `cli`, `tui`, `api`, `build` |
A product strategy:
| Axis | Answers |
|---|---|
| Kind | `research`, `decision`, `experiment`, `writeup` |
| Audience | `enterprise`, `self-serve`, `internal` |
A household:
| Axis | Answers |
|---|---|
| Kind | `repair`, `errand`, `admin`, `cleaning` |
| Room | `kitchen`, `garden`, `garage`, `car` |
Same shape, nothing in common. Derive the axes from the questions somebody will actually
ask this board, not from a template: if nobody will ever ask "show me everything in the
garage", `garage` is not earning its place.
### The rules
- **A tag is for kind, not for state.** State is the status directory. A `doing` tag
beside `committed`, a `blocked` tag beside a `blocked by` relation, a `done` tag at all:
each is a second copy of something the board already knows, and the copy is the one that
goes stale.
- **A tag is not a goal.** Everything for one outcome is a campaign, which has a title, a
description and a state derived from its members. `worklane campaign` owns that;
`worklane-plan` decides what belongs in one.
- **A tag is not a field.** No `p1` beside Priority, no `alice` beside Owner, no `august`
beside Due. The field is the writer and the tag will disagree with it.
- **A tag is not a person.** Owner is a field, and `chown` writes it.
- **Two axes, not two words for one thing.** Before adding a word, say which axis it is
on. If it does not fit one, either it is a new axis, which is a decision, or it is a
private note, which is not a tag.
- **Around a dozen tags, up to twenty.** Past that nobody remembers the vocabulary, so
they invent a near-duplicate instead of reusing what is there. Fewer, broader tags beat
a long tail nobody can recall.
- **Singular or plural, pick one and keep to it.** `bug`/`bugs` and `chore`/`chores` are
the commonest way a board ends up with two words for one idea.
- **Case matters.** `Bug` and `bug` are two tags to `--tag`, to `tags` and to the colour
a card is drawn in. Lowercase everything unless there is a reason.
### How many tags per ticket
One per axis is the target: a ticket is one kind of thing in one area. A ticket that wants
three areas is usually two tickets, and a ticket with no tag at all is invisible to every
question asked by tag.
## Annotating a tag
```
worklane tags # every tag carried, with counts
worklane tags add kitchen --annotation "..." # declare one, and say what it means
worklane tags set kitchen --annotation "..." # change what it means
```
`.worklane/tags.md` holds one section per declared tag, the tag as the heading and its
annotation under it. It is what a person opens to find out what the board means by a word,
and it is what an agent reads before choosing one.
**Declaring a tag tags nothing, and tagging a ticket declares nothing.** The two lists are
separate on purpose: `worklane tags` counts what the tickets carry, `tags.md` records what
the board agreed on, and the difference between them is the thing worth looking at. A tag
carried by tickets but never declared is a word somebody invented in a hurry.
### What an annotation has to say
The definition is the easy half and does the least work. What stops drift is the boundary
against the neighbouring tag, so write that.
Worthless, because nobody was ever unsure of this:
```
worklane tags add bug --annotation "Bugs."
```
Useful, because it answers the question somebody was actually about to get wrong:
```
worklane tags add bug \
--annotation "Behaviour that contradicts what the tool says it does, reproducible from a described state." \
--annotation "" \
--annotation "Not for something missing. A gap is a feature, however obvious the gap is."
```
The same for a household board:
```
worklane tags add repair \
--annotation "Something that worked and now does not." \
--annotation "" \
--annotation "Not for an improvement to something that works, which is a project, and not for a thing that needs replacing rather than fixing."
```
Repeat `--annotation` for more lines, and pass an empty one for a paragraph break. Three
lines is plenty: a definition, then the boundary.
Write an annotation for every tag, including the obvious ones. The obvious tags are the
ones two people quietly disagree about.
### Traps
- `tags add` refuses a tag that is already declared, and `tags set` refuses one that is
not. Each names the other, so the refusal tells you which you wanted.
- A tag cannot contain a comma, because a comma is what separates one tag from the next in
the Tags field. Surrounding spaces are trimmed.
- `worklane tags` counts tickets, so a tag you have declared and never applied does not
appear in it. That is not a fault; it is the file and the board disagreeing, which is
the state that tells you the vocabulary has not landed yet.
- Nothing removes a declaration. There is no `tags rm`, so a tag declared in error stays
in the file with whatever its annotation says. Say it is retired in the annotation.
## Changing the vocabulary later
### Renaming a tag
There is no rename. The tag is the key, so it means rewriting the Tags field of every
ticket carrying it, one at a time:
```
worklane ls --tag bugs --ids # every ticket carrying the old word
worklane show 1b78a24 # read the whole Tags field of each
worklane set 1b78a24 --tags bug,cli # restate all of them, with the new word
worklane tags add bug --annotation "..."
```
**`--tags` replaces the whole field.** Restate every tag the ticket should keep or the
ones you leave out are gone, with no undo. This is the most destructive command on the
board. Read the ticket's current tags before writing, never from memory, and run
`worklane tags` before and after: a count that moved where nothing was meant to change is
a tag lost to that rule.
Propose the whole list of edits and wait for approval before applying any of them, the way
`worklane-plan` requires for a sweep. The reason is the same: nothing records what a field
held before you wrote to it.
### Retiring a tag
Take it off the tickets the same way, then leave the declaration saying it is retired and
what replaced it. A tag with a count of zero and an annotation pointing elsewhere is a
better answer than a word that simply vanishes, because the next person will otherwise
reinvent it.
## Repairing a board
Every repair here has been run against a real board. Work by symptom.
**The rule that does not bend: do not edit a ticket file.** The filename, the `Status`
field and the directory have to agree, and the commands are what keep them agreeing. The
two exceptions below are files no command owns, and they are marked as such.
### A ticket has vanished from `ls`
`worklane ls` leaves `done` out of its listing, though it still counts it at the top. So
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:
```
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.
### A command says the id matches several tickets
```
Multiple tickets found matching 'bf2dc18':
1. (bf2dc18) Alpha [backlog]
2. (bf2dc18) Alpha [done]
```
The same file exists in two status directories, usually from a copy or a half-finished
restore. The ticket is now unaddressable: every command resolves before it acts, so `show`
and `mv` fail the same way and cannot be used to fix it.
**File exception.** Read both with `cat`, keep the one whose `Status` field agrees with
the directory it is in, and delete the other. If neither agrees, keep either and repair it
as above. Then confirm with `worklane show`.
### A move is refused by a blocker
```
Cannot move 'Beta' while it is blocked by:
...
Use --force (-f) to move it anyway.
```
Working as intended: a ticket cannot advance while something it waits on is unfinished.
Finish the blocker, or use `-f` if the dependency is no longer real. Note that the
relation stays on the ticket and will refuse the next move too, and there is no way to
take a relation off, so `-f` is the answer every time until the blocker is done.
If the message says `is blocked by X, which is not on the board`, the blocker has been
deleted. That is a warning rather than a refusal and the move goes through.
### `show` renders `_missing_`
A relation or a Campaign field naming something the board no longer holds. Harmless to
read and impossible to clear, since `relate` only adds and `assign` only moves a ticket
between campaigns that exist. For a campaign, `worklane assign <a-real-campaign> <ticket>`
overwrites it. For a relation, leave it.
### A status is missing from `worklane ls`
The count list at the top of `ls` names every status directory it found, so a status that
is absent from it has had its directory deleted. Nothing errors until something tries to
move a ticket there, which then fails with a raw file error.
**File exception.** `worklane init` will not repair it, since it refuses on a board that
already exists. Recreate the directory:
```
mkdir .worklane/reviewing
```
### A `.wl-*.tmp` file in `.worklane/`
The staging file for a write that was killed part way. Every write stages here and renames
into place, so a leftover means the write did not finish; nothing reads these and no
listing shows them.
**File exception.** Delete it. Then check the ticket it names with `worklane show` and
redo whatever the interrupted command was.
### Nothing works and the error names `.worklane`
Check where you are. Commands resolve the nearest `.worklane` at or above the working
directory, so running from the wrong directory addresses another board or none. `worklane
ls` from where you think the board is, is the fastest way to find out.
## What this skill does not touch
- **Priorities, due dates, campaign membership and retagging sweeps.** That is
`worklane-plan`. Deciding the vocabulary is here; applying it across the board is there.
- **Filing a ticket, working one, moving it through the statuses.** That is the `worklane`
skill.
- **Judging whether a finished ticket is really done.** That is `worklane-review`.
- **The content of a ticket.** A description or an acceptance criterion that is wrong is
the author's, and the answer is a comment on that ticket.
+11
View File
@@ -136,6 +136,14 @@ field on purpose, which is a different thing from emptying it by forgetting a ta
proposed: a count that dropped where nothing was meant to change is a tag lost to the
replace-the-whole-field rule above.
**Designing the vocabulary is the `worklane-admin` skill, not this one.** What the tags
should be, what each one means, how one is declared with `worklane tags add` and annotated
so the next person picks the same word: read that document before proposing a vocabulary,
and read `.worklane/tags.md` before proposing a tag. This section is the sweep over
tickets already tagged, which is a different job. A board whose tags are declared has an
annotation per tag, and a ticket that contradicts one is mis-tagged against a written
standard rather than against your reading of the board.
Derive the vocabulary from the board rather than inventing one. Read `worklane tags`, count
what is actually used, and show the count before proposing anything. What to report:
@@ -199,6 +207,9 @@ out of it. The last part is what makes it a goal rather than a pile.
columns is reporting progress that did not happen.
- **Owner.** `chown` records a commitment a person made. Propose it, do not write it,
unless you were asked to assign the work.
- **The tag vocabulary itself, and the state of the board's own files.** Declaring a tag,
writing what it means, retiring one, or repairing a ticket whose file and fields have
come apart: all `worklane-admin`. A sweep applies the vocabulary, it does not decide it.
- **New tickets.** Grooming is about what is on the board. Something genuinely missing is
worth filing, by the rules in the `worklane` skill, but say it is a new ticket rather
than folding it into a grooming sweep.
+38 -2
View File
@@ -490,13 +490,14 @@ pub struct CampaignAddArgs {
/// break a script for the sake of symmetry. So the bare form stays the listing, and `tags
/// ls` is the same thing spelled the way `campaign ls` is.
///
/// No `set`: changing an annotation is 9688d34, and a half of `add`/`set` that only ever
/// declares is the honest half to ship first.
#[derive(clap::Subcommand)]
pub enum TagCommand {
/// Declare a tag, and what it means
Add(TagAddArgs),
/// Replace what a declared tag means
Set(TagSetArgs),
/// List the tags the board carries, and how many tickets carry each
Ls,
}
@@ -518,6 +519,41 @@ pub struct TagAddArgs {
pub annotation: Vec<String>,
}
/// What can be replaced on a tag that is already declared: what it means, and nothing else.
///
/// No `--force`, unlike [`CampaignSetArgs`]. A codename is guarded because once a campaign
/// has one it is how the campaign is addressed, on every card and at every command line, so
/// replacing it silently breaks the way it is referred to. An annotation is prose written to
/// be revised and nothing addresses anything by it, so a guard would stand in front of the
/// command's whole purpose.
///
/// No rename. The tag *is* the key, so changing it means rewriting the Tags field of every
/// ticket carrying it. That is a migration, not a flag on `set`.
///
/// No `--clear`. An annotation is emptied with `--annotation ""`, which writes the same
/// placeholder a tag declared without one gets, so a second spelling would add nothing.
/// [`Clearable`] is a ticket's fields anyway, per [`SetArgs`].
///
/// `--annotation` is required, so a bare `worklane tags set <tag>` is a usage error rather
/// than a silent no-op, exactly as the group on [`CampaignSetArgs`] makes it for a campaign.
#[derive(clap::Args)]
pub struct TagSetArgs {
/// The tag to change, spelled the way it is declared
#[arg(value_parser = tag_value)]
pub tag: String,
/// What the tag means and when it is appropriate, replacing whatever it said before. Use
/// multiple flags for multiline annotations
#[arg(
short,
long,
required = true,
allow_hyphen_values = PROSE,
value_parser = annotation_line
)]
pub annotation: Vec<String>,
}
/// `ls` holds four filters, an output mode and nothing else, which is the boundary the
/// Rust Style rule in AGENTS.md names: two of the filters are adjacent `Option<String>`
/// values that a caller can swap silently, so the mode that joined them came as a
+27 -6
View File
@@ -66,6 +66,15 @@ pub const CAMPAIGN_FLAGS: [&str; 1] = ["campaign"];
/// one where `ls --ids` answers the tickets.
pub const TAG_FLAGS: [&str; 1] = ["tag"];
/// Nested commands whose first argument is a tag the board already has.
///
/// `tags set` changes what a declared tag means, so the values it takes are exactly the
/// ones `worklane tags` prints. `tags add` is deliberately absent: the tag it takes is one
/// the board does not have yet, so offering the ones it does would offer exactly the values
/// it refuses. Which of the two a new tag positional belongs to is what
/// `no_tag_taking_option_is_missing` makes somebody decide.
pub const TAG_NESTED_COMMANDS: [(&str, &str); 1] = [("tags", "set")];
pub fn generate(shell: Shell, out: &mut dyn io::Write) -> io::Result<()> {
let mut command = crate::command::Cli::command();
clap_complete::generate(shell, &mut command, "worklane", out);
@@ -92,6 +101,11 @@ fn fish_dynamic() -> String {
.join("; or ");
let campaign_flags = flag_list(&CAMPAIGN_FLAGS);
let tag_flags = flag_list(&TAG_FLAGS);
let tag_nested = TAG_NESTED_COMMANDS
.iter()
.map(|(parent, child)| format!("__worklane_nested_arg_of {parent} {child}"))
.collect::<Vec<_>>()
.join("; or ");
let statuses = possible_values(Status::value_variants());
let shells = possible_values(Shell::value_variants());
let skills = SKILLS
@@ -182,6 +196,11 @@ complete -c worklane -n '__worklane_command_is ls' {campaign_flags} \
# worth reading: it says which spelling the board actually uses.
complete -c worklane -n '__worklane_command_is ls' {tag_flags} -x -a '(worklane tags)'
# And `tags set` names one that is already declared, so it reads the same listing. `tags
# add` has no rule on purpose: it takes a tag the board does not have, so the candidates
# here are the values it refuses.
complete -c worklane -n '{tag_nested}' -a '(worklane tags)'
# `chown --clear` names the ticket in the flag too, since with no user to give there is
# no second positional to put it in. Scoped to `chown`, unlike the rule above: `set`
# has a `--clear` of its own that takes a field name, and clap already offers those.
@@ -377,16 +396,18 @@ mod tests {
let name = path.join(" ");
let Some(long) = arg.get_long() else {
let nested = match path.as_slice() {
let known = match path.as_slice() {
[parent, child] => {
TAG_NEW_COMMANDS.contains(&(parent.as_str(), child.as_str()))
let pair = (parent.as_str(), child.as_str());
TAG_NESTED_COMMANDS.contains(&pair) || TAG_NEW_COMMANDS.contains(&pair)
}
_ => false,
};
assert!(
nested,
"`worklane {name}` takes a tag as a positional, \
which the fish block has no rule for"
known,
"`worklane {name}` takes a tag as a positional, so it belongs in \
TAG_NESTED_COMMANDS if the tag already exists and TAG_NEW_COMMANDS if it \
does not"
);
continue;
};
@@ -397,7 +418,7 @@ mod tests {
);
}
assert_eq!(seen, 2, "expected ls --tag and tags add");
assert_eq!(seen, 3, "expected ls --tag, tags add and tags set");
}
/// **Every rule naming an option has to say which command it belongs to.** A bare
+61 -3
View File
@@ -8,7 +8,7 @@ use std::path::Path;
use crate::campaign::*;
use crate::command::{
AddArgs, AppendArgs, CampaignAddArgs, CampaignSetArgs, CheckArgs, ChownArgs, LsArgs,
RelateArgs, SetArgs, TagAddArgs,
RelateArgs, SetArgs, TagAddArgs, TagSetArgs,
};
use crate::install;
use crate::tag::{TAGS_FILE, TagIndex, tags_path};
@@ -872,12 +872,23 @@ fn apply(content: &mut String, changed: &mut Vec<&'static str>, field: &'static
}
fn report(fields: &[&str], title: &str, verb: &str) {
report_in(fields, title, Color::Green, verb)
}
/// The same, for a subject that is not a title.
///
/// Green means title, everywhere, so the one caller whose subject is a tag cannot use it:
/// a tag is drawn in a `TAG_COLORS` slot or it is drawn wrong, and green is deliberately
/// not one of them. The colour is passed in rather than decided here, which is the trade
/// `paint` makes with `color_text`, and it keeps the wording in one place so a tag reports
/// a no-op in the same words a ticket does.
fn report_in(fields: &[&str], title: &str, color: Color, verb: &str) {
if fields.is_empty() {
println!("No changes to '{}'", color_text(title, Color::Green));
println!("No changes to '{}'", color_text(title, color));
return;
}
println!("{} {} on '{}'", verb, fields.join(", "), color_text(title, Color::Green));
println!("{} {} on '{}'", verb, fields.join(", "), color_text(title, color));
}
pub fn cmd_set(args: &SetArgs, start: &Path) -> Result<()> {
@@ -1296,6 +1307,53 @@ pub fn cmd_tag_add(args: &TagAddArgs, start: &Path) -> Result<()> {
Ok(())
}
/// Replace what a declared tag means.
///
/// The other half of `tags add`, and the half `campaign` still lacks for its description,
/// 32e98ab. An annotation is the sentence a whole team files tickets against, so getting it
/// wrong once must not be permanent.
///
/// **A tag that is not declared is refused rather than declared here.** `add` and `set` are
/// a pair, each refusing what the other is for, so which of the two wrote a line is never a
/// question of which one happened to be typed. The refusal names the other command, the way
/// `add`'s names this one.
///
/// The no-op compares the rendered file rather than the annotation, which is what `apply`
/// does for a ticket: the file is the thing that would be written, so it is the thing worth
/// asking whether the write would change.
pub fn cmd_tag_set(args: &TagSetArgs, start: &Path) -> Result<()> {
let worklane_dir = find_worklane_dir(start)?;
let mut index = TagIndex::load(&worklane_dir)?;
if !index.declared(&args.tag) {
return Err(anyhow!(
"No tag '{}' is declared, so nothing was written. \
Use `worklane tags add` to declare it",
args.tag
));
}
let original = index.render();
index.declare(&args.tag, &trim_blank_ends(&args.annotation).join("\n"));
let next = index.render();
let mut changed: Vec<&'static str> = Vec::new();
if original != next {
changed.push("annotation");
write_then_replace(
&worklane_dir,
&tags_path(&worklane_dir),
TAGS_FILE,
&next,
TAG,
&args.tag,
)?;
}
report_in(&changed, &args.tag, tag_color(&args.tag), "Updated");
Ok(())
}
/// Replace fields on a campaign that is already filed.
///
/// `cmd_set` for a campaign, and built out of the same parts: `set_title` for the heading,
+47 -1
View File
@@ -69,11 +69,29 @@ pub const PLAN_SKILL: Asset = Asset {
content: include_str!("../assets/PLAN.md"),
};
/// The skill that sets a board up and puts one back together.
///
/// Its own document for the reason the two above are, and the split against `PLAN_SKILL`
/// is the one worth stating: that document grooms the *work*, priorities and dates and
/// campaigns, and this one configures the *board*, the tag vocabulary and the faults a
/// board can develop. The tag section is where they meet, so each points at the other.
///
/// The one document that has to hold for a board that tracks no software at all. The other
/// three describe a workflow that happens to be this repo's; a vocabulary skill written
/// around `bug` and `cli` would teach nothing to a board tracking a household, so the
/// examples in it deliberately span three subjects.
pub const ADMIN_SKILL: Asset = Asset {
name: "worklane-admin",
what: "skill",
relative: "worklane-admin/SKILL.md",
content: include_str!("../assets/ADMIN.md"),
};
/// Every skill this binary carries, in the order they install.
///
/// A `static` rather than a `const` so the slice borrowed from it outlives the
/// statement that took it: a `const` is inlined at each use and the borrow dies there.
pub static SKILLS: [Asset; 3] = [SKILL, REVIEW_SKILL, PLAN_SKILL];
pub static SKILLS: [Asset; 4] = [SKILL, REVIEW_SKILL, PLAN_SKILL, ADMIN_SKILL];
/// The opencode tool definitions, the second kind of asset this binary carries.
///
@@ -466,6 +484,34 @@ mod tests {
}
}
/// What makes the admin document usable on a board that tracks no software, and what
/// keeps its repairs honest.
///
/// 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.
#[test]
fn the_admin_skill_stays_domain_neutral_and_keeps_its_verified_repairs() {
for required in [
"household", // the vocabulary section spans three subjects
"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
"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
] {
assert!(
ADMIN_SKILL.content.contains(required),
"the admin skill no longer says {required:?}"
);
}
}
/// The decisions that make the review document a review rather than a rewrite.
///
/// Each of these is a rule an edit would drop without breaking anything else: a
+1
View File
@@ -88,6 +88,7 @@ fn main() -> Result<()> {
cmd_tags(&worklane_dir)
}
Some(TagCommand::Add(args)) => cmd_tag_add(&args, &start),
Some(TagCommand::Set(args)) => cmd_tag_set(&args, &start),
},
// 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.
+123
View File
@@ -411,3 +411,126 @@ fn the_bare_form_and_ls_are_the_same_listing() {
assert_eq!(bare.stdout, group.stdout);
assert_eq!(String::from_utf8_lossy(&bare.stdout), "bug\t1\ncli\t1\n");
}
// -------------------------------------------------- changing what a tag means --
/// The replacement lands, and replaces rather than appends.
#[test]
fn tags_set_replaces_what_a_tag_means() {
let temp = TempDir::new().unwrap();
setup_worklane(&temp);
run(&temp, &["tags", "add", "bug", "-a", "The first sentence."]);
let out = run(&temp, &["tags", "set", "bug", "-a", "The second sentence."]);
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
assert_eq!(declared(&temp, "bug").as_deref(), Some("The second sentence."));
assert!(!vocabulary(&temp).contains("first"), "the old annotation survived");
}
/// Paragraph breaks survive the round trip, which is the whole difference between an
/// annotation and a one-line description of a tag.
#[test]
fn a_multiline_annotation_survives_being_set() {
let temp = TempDir::new().unwrap();
setup_worklane(&temp);
run(&temp, &["tags", "add", "bug"]);
run(
&temp,
&[
"tags",
"set",
"bug",
"-a",
"What it is.",
"-a",
"",
"-a",
"When to use it.",
],
);
assert_eq!(declared(&temp, "bug").as_deref(), Some("What it is.\n\nWhen to use it."));
}
/// Set to what it already says, nothing is written and the command says so, the way `set`
/// and `chown` report a field that already holds the value.
#[test]
fn setting_an_annotation_to_what_it_already_says_writes_nothing() {
let temp = TempDir::new().unwrap();
setup_worklane(&temp);
run(&temp, &["tags", "add", "bug", "-a", "The sentence."]);
let before = fs::metadata(temp.path().join(".worklane").join("tags.md"))
.unwrap()
.modified()
.unwrap();
let out = run(&temp, &["tags", "set", "bug", "-a", "The sentence."]);
assert!(out.status.success());
assert!(String::from_utf8_lossy(&out.stdout).contains("No changes"), "{out:?}");
let after = fs::metadata(temp.path().join(".worklane").join("tags.md"))
.unwrap()
.modified()
.unwrap();
assert_eq!(before, after, "the file was rewritten for a no-op");
}
/// `add` and `set` are a pair, each refusing what the other is for, so the refusal names
/// the other command rather than leaving it to be found.
#[test]
fn setting_a_tag_that_is_not_declared_is_refused_and_names_add() {
let temp = TempDir::new().unwrap();
setup_worklane(&temp);
run(&temp, &["tags", "add", "bug"]);
let out = run(&temp, &["tags", "set", "cli", "-a", "Anything."]);
assert!(!out.status.success());
let stderr = String::from_utf8_lossy(&out.stderr);
assert!(stderr.contains("tags add"), "{stderr}");
assert!(declared(&temp, "cli").is_none(), "the tag was declared by set");
}
/// A bare `tags set <tag>` is a usage error. Nothing to write is a mistake in the call, not
/// a command that quietly does nothing.
#[test]
fn setting_nothing_is_a_usage_error() {
let temp = TempDir::new().unwrap();
setup_worklane(&temp);
run(&temp, &["tags", "add", "bug", "-a", "The sentence."]);
let out = run(&temp, &["tags", "set", "bug"]);
assert_eq!(out.status.code(), Some(2), "{out:?}");
assert_eq!(declared(&temp, "bug").as_deref(), Some("The sentence."));
}
/// An annotation can be emptied back to the placeholder, which is the state a tag declared
/// without one is already in. That is why there is no `--clear`.
#[test]
fn an_annotation_can_be_emptied_back_to_the_placeholder() {
let temp = TempDir::new().unwrap();
setup_worklane(&temp);
run(&temp, &["tags", "add", "bug", "-a", "The sentence."]);
run(&temp, &["tags", "set", "bug", "-a", ""]);
assert_eq!(declared(&temp, "bug").as_deref(), Some("_No annotation provided._"));
}
/// The other tags keep their sections, since the whole file is re-rendered on every write.
#[test]
fn setting_one_annotation_leaves_the_others_alone() {
let temp = TempDir::new().unwrap();
setup_worklane(&temp);
run(&temp, &["tags", "add", "bug", "-a", "About bugs."]);
run(&temp, &["tags", "add", "tui", "-a", "About the board."]);
run(&temp, &["tags", "set", "bug", "-a", "Rewritten."]);
assert_eq!(declared(&temp, "bug").as_deref(), Some("Rewritten."));
assert_eq!(declared(&temp, "tui").as_deref(), Some("About the board."));
}