Compare commits

..
2 Commits
Author SHA1 Message Date
Ansho ReiandClaude Opus 5 a885f81da5 (952a9f8) Complete the verb, the statuses, the tags and the campaigns in the prompt, and bump to 0.33.4
With the ticket suggested, the rest of the line was still typed blind. The
prompt now completes everything fish does: the verb and the verbs of a
group, the five statuses, the tags the board carries, the campaigns a
codename resolves against, and relate --clear's three kinds.

`ticket_argument` becomes `argument_at`, which answers what a position
names rather than whether it is a ticket. The tables say Ticket, Campaign
or Tag; clap says the rest, so the verbs, the statuses, `set --clear`'s
fields and the `completions` shells are never written down twice. Only
`relate --clear` needed a table of its own: the flag takes a kind and then
a target, so possible values on it would refuse every target.

The row draws the longest opening every candidate agrees on, which is
exactly what the next tab takes. One rule for one candidate and for many: a
ticket position has only the selected card, so the rest of its id is drawn
as before; the five statuses agree on nothing, so nothing is drawn and tab
steps through them one press at a time.

The walk holds the line as it stood before the first press, not the list
and not the candidate the last press chose, so every press re-derives the
candidates and stepping cannot narrow them to what it just typed. Every
edit ends it, beside `refused` and for the same reason.

193f9be is not inherited: `tags set` is offered only the tags the
vocabulary declares, and `tags add` and both `--tags` that take the whole
list are offered nothing.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-15 15:18:59 +02:00
Ansho ReiandClaude Opus 5 c714c73a75 (00a14e7) Suggest the selected ticket where a ticket argument goes, and accept it with tab, and bump to 0.33.3
The reader has the ticket selected, which is the whole reason to type a
command on the board rather than in a shell, so where the line is naming a
ticket the selected card's short id is drawn after the cursor in grey and
tab takes it into the line.

Where a ticket goes is completions.rs's answer, through a new
`ticket_argument` over the three tables the fish half is generated from. A
copy of the positions on the board would go wrong the next time a command
grew a ticket argument, and silently, since the tests guarding the first
copy would not read the second.

TICKET_FLAGS holds (command, flag) pairs now, the shape TAG_FLAGS already
had, and the `chown --clear` rule the fish block wrote out by hand is
generated from it. Only chown's --clear names a ticket: relate's takes a
kind and set's a field, and the flag alone cannot tell the three apart.

The suggestion is derived on every call rather than held on the Prompt, so
what the row draws and what tab takes are one answer, and it is offered
only with the cursor at the end of the line, while a card is selected, and
while the id still starts with what is typed.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-15 15:01:15 +02:00
6 changed files with 1056 additions and 49 deletions
Generated
+1 -1
View File
@@ -1563,7 +1563,7 @@ dependencies = [
[[package]]
name = "worklane"
version = "0.33.2"
version = "0.33.4"
dependencies = [
"anyhow",
"assert_cmd",
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "worklane"
version = "0.33.2"
version = "0.33.4"
edition = "2024"
[dependencies]
+5 -1
View File
@@ -10,9 +10,13 @@ The generated half, the fish half, and what keeps the two honest.
- **The strongest completion check loads the script into fish and asks it for candidates.** `fish_offers_the_commands_the_statuses_and_the_values` in `tests/cmd_completions.rs` sources the generated script into a throwaway shell standing in a real board, with this build's directory on the front of PATH, and compares `complete -C` against the ticket and the tag it put there. Every other test in the file reads the script as text, which cannot tell a rule that fires from one whose condition stopped matching, and that is how a completion actually breaks. **Assert the values, not the flag names**: clap emits every option's name on its own, so `--tags` and `--blocked-by` are offered with every hand-written rule deleted; what the dynamic half adds is what comes *after* the flag. Two traps, both paid for once: the shell must have `fish_complete_path` emptied, or `complete -C` autoloads `~/.config/fish/completions/worklane.fish` and answers from whatever version wrote that, which is a guard that cannot fail; and the script is written beside the board rather than in it, since a rule that fires nothing falls back to listing the directory
- **`fish --no-execute` is the floor under that, not an oracle.** It catches a script that does not parse, quotes still open at the end of the file or an unclosed block. Measured, not assumed: an apostrophe interpolated into a `-d` description partway down re-balances against the next quote and parses, corrupting every rule in between while the check passes; the same apostrophe in the last rule reaches the end unbalanced and is caught. Only fish gets this, because only fish gets a hand-written half
- **The rule counts in the completion tests are hardcoded on purpose.** The walkers go clap → list and never see an entry naming something that does not exist, so a bogus pair in `TAG_FLAGS` is caught by `every_tag_rule_takes_the_annotation_as_its_description` counting one rule too many. Deriving that number from the lists it checks would grow with the bogus entry and pass. The `seen` totals in the walkers are hardcoded for the mirror reason, and both carry the note
- **The five completion lists are kept honest by tests** that walk the clap definition and fail on an argument left out of them. `TICKET_COMMANDS` and `TICKET_SECOND_COMMANDS` by position, `TICKET_FLAGS`, `CAMPAIGN_COMMANDS`, `CAMPAIGN_NESTED_COMMANDS`, `CAMPAIGN_FLAGS` and `TAG_FLAGS` likewise, the last against the test-local `TAG_LIST_FLAGS` and `TAG_NEW_COMMANDS` for the tag arguments that deliberately get no rule. The walk is one function, `every_argument`, since the tests differ only in the id they look for. Each also asserts *how many* it found, so a walker that stopped finding arguments fails rather than passing every assertion by never running them
- **The completion lists are kept honest by tests** that walk the clap definition and fail on an argument left out of them. `TICKET_COMMANDS` and `TICKET_SECOND_COMMANDS` by position, `TICKET_FLAGS`, `CAMPAIGN_COMMANDS`, `CAMPAIGN_NESTED_COMMANDS`, `CAMPAIGN_FLAGS` and `TAG_FLAGS` likewise, the last against the test-local `TAG_LIST_FLAGS` and `TAG_NEW_COMMANDS` for the tag arguments that deliberately get no rule. The walk is one function, `every_argument`, since the tests differ only in the id they look for. Each also asserts *how many* it found, so a walker that stopped finding arguments fails rather than passing every assertion by never running them
- **A campaign is named in three shapes and a tag in one**, which is why the lists are not one list: a campaign is `assign`'s first positional, the first argument of `campaign show` and `campaign set`, and `ls --campaign`'s value, and each needs a different fish rule. A tag is only ever an option value, and its values come from a different command
- **`TICKET_FLAGS` holds pairs, the command and the flag, and every ticket rule in the fish half is generated from it.** Three commands carry a `--clear` and each takes something different: `chown`'s names the ticket, since with no user to give there is no positional for it; `relate`'s takes the kind and then the target; `set`'s takes a field name clap already offers. So the command is half of the fact, and a list of bare flag names could only be scoped by hand, which is what the `chown --clear` rule used to be. `every_ticket_flag_is_a_real_option` walks each pair against the command it names, which a flat list could not do
- **The lists answer the board as well as the shell.** `argument_at` reads every one of them to say what the argument at a given index of a typed line names — a ticket, a campaign, a tag, or a fixed list it takes off clap — which is what the command prompt completes against, see [tui-prompts.md](tui-prompts.md). Position is counted there exactly as it is counted here, so the two cannot come to disagree about `mv --status done <ticket>`; a second table on the board would be a copy the tests above never read. The values are the one half that is not shared: fish runs `worklane ls --ids` and the board reads the rows the tab already holds
- **`TAG_FLAGS` holds pairs where the others hold names**, because the two options that take one tag are spelled differently: `ls --tag` filters on one and `append --tags` adds them, so a single rule naming both would tell fish that each command accepts the other's flag. One rule per pair, generated in `fish_dynamic`. `add --tags` and `set --tags` are in the test's `TAG_LIST_FLAGS` instead and get no rule: they take the *whole* list, so the token at the cursor is `bug,tui` and fish replaces a token entire, which would throw away what is already typed. The test walks both `tag` and `tags`, so the next one has to say which of the two it is
- **A `ValueEnum` is never listed twice, and `argument_at` is why the fish half's two hand-written value lists are the only ones.** clap emits the possible values of an *option*, so `mv --status` and `set --clear` need nothing here and the board reads them off the same definition with `Arg::get_possible_values`. The `ls` status and the `completions` shell are positionals, which the fish generator emits nothing for, so those two are written into the block from the enums — and the board reaches them through `get_positionals`, which needs no `Command::build` the way `get_index` would
- **`RELATION_KIND_FLAGS` is the one position clap cannot answer for.** `relate --clear` takes a kind and then a target, two values of different kinds under one flag, so possible values on it would refuse every target. Both renderers therefore say so themselves: the fish rule lists `RelationKind::ALL` and the table names the pair
- **`ls --ids` is the machine-readable listing**, and one of the three outputs in the tree meant to be parsed: the short id, a tab, the title, unstyled. Two fields because fish reads what follows a tab as the description and a script reads `cut -f1`. It includes done, which the decorated listing leaves out, because a completion has to be able to name a finished ticket, and it skips a missing status directory rather than refusing, because an error printed over a shell prompt is worse than no candidates. The filters still apply, and an unknown `--campaign` is still refused
- **`campaign ls --ids` is the same flag and the same two fields for the other object**, and it deliberately skips the member counting the decorated listing does: `members()` reads every ticket on the board, and the caller here is a shell filling in candidates on a keypress. It also prints nothing on an empty board, where the decorated listing prints a sentence, because a sentence offered as a candidate is worse than no candidates
- **`worklane tags` is the third, and it is a command rather than a mode on `ls`.** Two reasons: `ls --tag <tag>` answers what carries a tag and cannot answer what tags exist, which is the question a grooming sweep starts from, and a `--tags` beside a `--tag` is one letter from a filter that means something else. Alphabetical and case sensitive, matching the filter, so `bug` and `Bug` list separately and land next to each other, which is where a near-duplicate is spotted. Every status, done included: a tag that has fallen out of use is still part of what the vocabulary has been. `assets/PLAN.md` used to tell the agent to count tags with a `show` per ticket, and now points here
+23 -1
View File
@@ -19,7 +19,7 @@ The three input modes on the board and the key that copies an id off it.
## The Command Prompt
- **`prompt: Option<Prompt>` is the whole mode**, the shape `search` and `detail` use: open and content cannot disagree, and closing it leaves nothing to reset. `Prompt` carries the line, the cursor as a byte offset into it, and `refused`, which is `Search::missed` with something to say
- **`Board::prompt_key` is third in the pre-dispatch**, beside `search_key` and `picker_key` and on the same contract: while a command is being typed `q` is a letter, `d` leaves the columns alone and `tab` stays out of the project tabs, and `ctrl-c` is the one key declined. It takes a `Size` for enter's sake: running a command reloads the board and then has to bring the ticket it moved back into view, which is the measurement `follow_selection` takes. Only one of the two prompts can be open at once: `:` is reachable from the action arms alone, and while either has the keyboard the other's key is a character in a line
- **`esc` and `enter` are the mode's own keys and are answered in `prompt_key`; everything else belongs to the line and goes to `Prompt::key`.** That is also what keeps the borrow straight, since closing the prompt takes the whole board and editing takes only the prompt. Left, right, home, end, backspace and `ctrl-w` behave as they do in a shell, and `ctrl-w` eats the separators behind the cursor before the word behind those, so one press at the end of `mv 1b78a24 ` takes the id. There is deliberately no `tab`: suggesting the selected ticket is 00a14e7, and until then it is a key that must not reach the tabs
- **`esc` and `enter` are the mode's own keys and are answered in `prompt_key`; everything else belongs to the line and goes to `Prompt::key`.** That is also what keeps the borrow straight, since closing the prompt takes the whole board and editing takes only the prompt. Left, right, home, end, backspace and `ctrl-w` behave as they do in a shell, and `ctrl-w` eats the separators behind the cursor before the word behind those, so one press at the end of `mv 1b78a24 ` takes the id. `tab` is the mode's too, for the reason the recall walk is: what it takes is made of the selected card and the line is only where it lands
- **The grammar is clap's, with nothing restated.** The line is tokenised by `split_line`, the binary's own name goes in front, and the arguments go to the same `Cli` definition the shell reaches, so a flag added to a command is typeable here the day it is added. Through `Cli::command().try_get_matches_from_mut` rather than `try_parse_from`, for what the matches give back: `command_name` walks the subcommands to name what resolved (`campaign show`, not `campaign`) instead of a `match` over every variant, which would be a second list of every verb the CLI has and one that goes stale silently
- **`refused` is cleared by an edit and not by a movement.** The message is about the line, and moving the cursor does not change the line. `Prompt::key` clears it in the three arms that write to the line
- **A line that ends inside a quote never reaches clap.** That is what `Unclosed` is for: a grammar complaint about a sentence nobody finished describes the wrong thing. Enter on an empty line, or one of nothing but separators, closes the prompt with nothing said, the way `esc` does — the bare form of the CLI opens a board and there is one on the screen
@@ -46,6 +46,28 @@ The three input modes on the board and the key that copies an id off it.
- **A failed write is silent, and an unreadable file is an empty recall.** The line is in memory either way, so the walk works for the run on a board whose folder cannot be written, and a board with no history yet is the ordinary case rather than something to say. A notice about a history file would be about the one thing the reader did not ask for
- **`.wlhistory` is not in `digest`.** Appending to it must not read as the tree moving, or every command typed would provoke a reload of every board on top of the one `run` already does
## The Prompt's Completion
- **The reader has the ticket selected, which is the whole reason to type a command on the board rather than in a shell.** So where the line is naming a ticket, the selected card's short id is drawn after the cursor and `tab` takes it into the line. Retyping seven characters off the card in front of you is the friction the prompt exists to remove
- **Where a ticket goes is `completions.rs`'s answer, not a table written here.** `argument_at` reads `TICKET_COMMANDS`, `TICKET_SECOND_COMMANDS` and `TICKET_FLAGS`, which `no_ticket_taking_subcommand_is_missing` and `every_ticket_flag_is_a_real_option` keep honest against clap's own definition, and the campaign and tag lists beside them. A second copy of the positions on the board would go wrong the next time a command grew a ticket argument, and it would go wrong *silently*, since the test guarding the first copy would not read the second
- **The ticket is not always the first argument, which is what a naive version gets wrong.** `chown alice <ticket>` and `assign v1 <ticket>` put it second on purpose, `relate x --blocked-by <ticket>` puts it in a flag, and `chown --clear <ticket>` does too, since with no user to give there is no positional for it. Nothing is offered where the argument is something else: `relate --clear` wants a kind, `set --clear` wants a field name, and `chown`'s first argument is a user
- **Position is counted, exactly as the fish half counts it**, so `mv --status done <ticket>` is not recognised: the ticket is `mv`'s first positional and the third argument on the line. That is the fish rules' limit as well, and one table answering both is worth more than two tables disagreeing about the corner
- **`TICKET_FLAGS` holds pairs, command and flag, where it used to hold bare flag names.** Three commands carry a `--clear` and only `chown`'s names a ticket, so the command is half of the fact. It also took the last hand-written ticket rule out of the fish block: every one of them is generated from the table now, and `every_ticket_flag_is_a_real_option` walks each pair against the command it names
- **It is derived on every call and held nowhere.** `Board::completion` is asked once by the draw and once by `tab`, so what is on the row and what the key takes cannot disagree, and there is no list to go stale when the line is edited or the board reloads under it. That is also what "any other key drops it" means: nothing is dropped, because nothing was kept
- **Only with the cursor at the end of the line.** The suggestion is drawn after the cursor and `tab` inserts it there, so with a command continuing past the cursor both would land in the middle of something already typed. A shell's own suggestion keeps the same rule
- **Only while a candidate still starts with what is typed**, and what is drawn is the rest of it rather than the whole. An offer that no longer matches the argument under it describes nothing, and once the whole of it is typed there is nothing left to add
- **Nothing with no card under the selection.** On the frame the selection is on a campaign or a tag, and neither is a ticket: `y` copies what the frame names there, and this deliberately does not
- **Everything else worklane can name is completed the same way**, which is what makes it one mechanism rather than a ticket suggestion with four more bolted on. `Argument` says what a position takes — a ticket, a campaign, a tag, or a fixed list — and `Board::candidates` says what the board currently holds of it. The verbs and the enum values are clap's own, so a command, a status, a shell or a clearable field added anywhere is typeable here the day it is added, and the campaigns and the tags are the tab's own rows, rebuilt at every reload beside the columns and drawn by the `c` and `t` pickers. **Nothing here reads the tree**: a keypress that went to disk would be a second source for what is already in memory
- **A campaign is offered by codename, and by its short id where it has none.** The codename is what the board draws on every card in the campaign and the shortest thing that addresses it; a campaign without one is labelled by its short id in both renderers, and leaving it out would hide it from the only place a reader can reach it by typing
- **`tags set` is offered only the declared tags.** It changes what a declared tag means and refuses one the vocabulary file does not declare, so the carried-but-undeclared ones are exactly the values it rejects. That is 193f9be in the fish half, which reads one listing for both, and the prompt does not inherit it. `tags add` gets nothing for the mirror reason, and neither `--tags` that takes the whole list does, since one tag offered into `bug,tui` is not what the field asked for
- **The clap definition is rebuilt on every call**, at 32µs in release against a board that redraws four times a second. A definition cached beside the board would be a second copy of what `Cli::command()` already answers; the fish half spends 2.5ms per keypress running worklane itself for the same values
- **What is drawn is the longest opening every candidate agrees on, which is exactly what the next `tab` takes.** One rule for one candidate and for many: a ticket position has only the selected card, so the rest of its id is drawn; the five statuses agree on nothing, so nothing is drawn and `tab` steps through them instead. The row never shows something a press would not do
- **`tab` again steps through the candidates in place, and wraps.** A shell does the same and it needs no list drawn over the columns, which is the trade — the board behind the prompt is what the reader is reading. Wrapping loses nothing typed, unlike the recall's walk, because every candidate still starts with the stem the walk was built from, which is why there is no `pending` here
- **Each press rebuilds the row from the line as it stood before the first**, so the candidates are read fresh every press and the only thing `Completing` holds is that line and how many presses have landed. Holding the list would be a copy going stale between two presses; holding the candidate the last press chose would narrow the list to it, and the walk would step once and stand still
- **Every edit ends the walk**, beside `refused` and for the same reason: the walk is about one argument and a line that has changed is a different argument. What the last press put on the row stays there, which is what makes `tab` then a letter the ordinary way to take a candidate
- **Nothing is drawn while a walk is on the row.** What is there is a whole candidate already, and a second offer drawn against it would read as part of the same word
- **Grey, which is what the palette already spends on a value that is not one.** It is not in the line until `tab` puts it there, and the reader has to tell the two apart at a glance. It takes what the line leaves of the field rather than a field of its own, so a long command loses the offer instead of pushing `esc` and `enter` off the row. The terminal cursor sits on its first cell, which is where the cursor already was
- **The row does not name `tab`.** The prompt names its two mode keys and no more — `ctrl-w`, the arrows and home and end are unnamed there as well — and the suggestion under the cursor is its own affordance
## Splitting a Typed Line
- **`split_line` is the whole module, and it knows nothing about `Board`.** The command prompt reads one string and clap reads an argv, so `comment 1b78a24 the offset was never passed` has to be tokenised before anything can parse it: split on whitespace it is five arguments and `comment` takes two. A pure function over the line and the cursor is what makes every rule reachable from a unit test, and it is in a file of its own rather than in `tui.rs`, which is eleven thousand lines already
- **The rules are the shell's, because that is what the prompt promises**: the line is spelled there exactly as it is spelled in the shell. Runs of whitespace separate arguments, single and double quotes group one, a backslash escapes the next character *except* inside single quotes where it is a backslash, and an explicitly empty `''` is an argument that exists and is empty — which is what `--title ""` being a usage error rather than a silent clear depends on. A leading hyphen is not special here: whether `--foo` is a flag or the text of a criterion is clap's question, and `PROSE` already answers it
+362 -33
View File
@@ -39,8 +39,19 @@ pub const TICKET_COMMANDS: [&str; 8] = [
/// campaign, and neither is completed.
pub const TICKET_SECOND_COMMANDS: [&str; 2] = ["chown", "assign"];
/// Options whose value is a ticket, as `relate` takes three of.
pub const TICKET_FLAGS: [&str; 3] = ["blocked-by", "regression-of", "relates-to"];
/// Options whose value is a ticket, as the command that takes it and the flag's long name.
///
/// Pairs rather than the flat list this was, for the reason [`TAG_FLAGS`] holds pairs: the
/// commands spell their flags differently and one of the spellings is shared. `relate`'s
/// three take a ticket, `chown --clear` takes one because there is no user to give it, and
/// `set --clear` takes a field name and `relate --clear` a relation kind — so a list of
/// bare flag names would offer tickets to those two as well.
pub const TICKET_FLAGS: [(&str, &str); 4] = [
("relate", "blocked-by"),
("relate", "regression-of"),
("relate", "relates-to"),
("chown", "clear"),
];
/// Subcommands whose first positional is a campaign.
///
@@ -90,6 +101,154 @@ pub const TAG_FLAGS: [(&str, &str); 2] = [("ls", "tag"), ("append", "tags")];
/// `no_tag_taking_option_is_missing` makes somebody decide.
pub const TAG_NESTED_COMMANDS: [(&str, &str); 1] = [("tags", "set")];
/// Options whose first value is a relation kind.
///
/// `relate --clear` alone, and it is a list rather than a line in [`argument_at`] for the
/// reason every other position is: what an argument names belongs beside the tables that
/// answer the same question about the rest of them. It cannot come off clap the way a
/// status does, which is why it is here at all — the flag takes a kind and then a target,
/// two values of different kinds under one name, so possible values on it would refuse
/// every target.
pub const RELATION_KIND_FLAGS: [(&str, &str); 1] = [("relate", "clear")];
/// What an argument of a typed line names, where worklane can answer what goes there.
///
/// The board's command prompt completes against this: the tables above say *what* the
/// position takes and the prompt says what the board currently holds of it. A ticket and a
/// campaign and a tag are all "a word off the board" to clap and three different questions
/// to the reader, which is why this is an enum rather than a candidate list — the values
/// live where the board is and the positions live here.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Argument {
/// A ticket on the board. One candidate, the card the reader has selected.
Ticket,
/// A campaign, which is named by its codename and drawn by it on every card it holds.
Campaign,
/// A tag. `declared` is `tags set`'s: it changes what a declared tag means and refuses
/// one the vocabulary file does not declare, so offering a carried-but-undeclared tag
/// there would offer exactly the values the command rejects. That is 193f9be in the
/// fish half, and this is the prompt not inheriting it.
Tag { declared: bool },
/// Values the tool itself holds: the subcommand names at a verb position, the possible
/// values of an argument clap built from a `ValueEnum`, and the relation kinds.
///
/// Read off the clap definition rather than written out, so a command, a status or a
/// clearable field added anywhere is typeable on the board the day it is added.
Fixed(Vec<String>),
}
/// What the argument at `index` of a typed line names, `index` counting from the verb at 0,
/// or nothing where worklane has nothing to offer.
///
/// The tables above are what answer it, reached rather than restated: a second copy of the
/// positions on the board would go wrong the next time a command grew a ticket argument, and
/// it would go wrong silently, since the tests that keep these honest against clap would
/// not read the copy.
///
/// Position is counted rather than inferred, exactly as the fish half counts it, so
/// `mv --status done <ticket>` is not recognised: the ticket is `mv`'s first *positional*
/// and the third argument on the line. That is the fish rules' limit too, and one answer
/// for both is worth more than two that disagree about the corner.
///
/// The clap definition is rebuilt on every call, at 32µs in release, and the caller is a
/// board that redraws four times a second: a definition cached beside the board would be a
/// second copy of what `Cli::command()` already answers, for a cost nothing can measure.
/// The fish half spends 2.5ms per keypress running worklane itself for the same answers.
pub fn argument_at(args: &[String], index: usize) -> Option<Argument> {
let cli = crate::command::Cli::command();
// The verb itself, which is every subcommand the tool has. Hidden ones are left out:
// they are not in the help either, and a candidate nobody can read about is one a
// reader has to go and look up.
if index == 0 {
return Some(Argument::Fixed(subcommand_names(&cli)));
}
let verb = args.first().map(String::as_str)?;
let group = cli.find_subcommand(verb);
// A flag's value is the argument after it, which is where the flag sits whether the
// value is half typed or has not been started.
if let Some(flag) = args.get(index - 1).and_then(|arg| arg.strip_prefix("--")) {
if TICKET_FLAGS.contains(&(verb, flag)) {
return Some(Argument::Ticket);
}
if CAMPAIGN_FLAGS.contains(&flag) {
return Some(Argument::Campaign);
}
if TAG_FLAGS.contains(&(verb, flag)) {
return Some(Argument::Tag { declared: false });
}
if RELATION_KIND_FLAGS.contains(&(verb, flag)) {
let kinds = RelationKind::ALL.iter().map(|kind| kind.flag().to_string());
return Some(Argument::Fixed(kinds.collect()));
}
// And everything else the flag could take, which is whatever clap knows: `--status`
// and `set --clear` are both `ValueEnum`s, so their values are already written down
// once, in the enum.
let arg = group?.get_arguments().find(|arg| arg.get_long() == Some(flag))?;
return fixed(arg);
}
// The positionals, at the index each table records.
match index {
1 if TICKET_COMMANDS.contains(&verb) => return Some(Argument::Ticket),
1 if CAMPAIGN_COMMANDS.contains(&verb) => return Some(Argument::Campaign),
2 if TICKET_SECOND_COMMANDS.contains(&verb) => return Some(Argument::Ticket),
_ => {}
}
let group = group?;
// The verb of a group, `campaign show` and `tags set`, which is a subcommand name
// exactly as the top-level verb is.
if index == 1 && group.has_subcommands() {
return Some(Argument::Fixed(subcommand_names(group)));
}
// And the first argument of one, which is where a campaign and a declared tag are named.
if index == 2
&& let Some(child) = args.get(1).map(String::as_str)
{
if CAMPAIGN_NESTED_COMMANDS.contains(&(verb, child)) {
return Some(Argument::Campaign);
}
if TAG_NESTED_COMMANDS.contains(&(verb, child)) {
return Some(Argument::Tag { declared: true });
}
}
// And whatever else the positional itself knows, which is the `ls` status and the
// `completions` shell: both are `ValueEnum`s that the fish generator has to list by
// hand, because it emits possible values for an option and none for a positional.
fixed(group.get_positionals().nth(index - 1)?)
}
/// The names a command answers to, hidden ones left out.
fn subcommand_names(command: &clap::Command) -> Vec<String> {
command
.get_subcommands()
.filter(|sub| !sub.is_hide_set())
.map(|sub| sub.get_name().to_string())
.collect()
}
/// The possible values of one argument, or nothing for an argument that takes free text.
///
/// `get_positionals` and `get_long` both read what the derive wrote, so nothing here needs
/// the command built the way `get_index` would.
fn fixed(arg: &clap::Arg) -> Option<Argument> {
let values: Vec<String> = arg
.get_possible_values()
.iter()
.filter(|value| !value.is_hide_set())
.map(|value| value.get_name().to_string())
.collect();
(!values.is_empty()).then_some(Argument::Fixed(values))
}
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);
@@ -107,7 +266,16 @@ pub fn generate(shell: Shell, out: &mut dyn io::Write) -> io::Result<()> {
fn fish_dynamic() -> String {
let ticket_commands = TICKET_COMMANDS.join(" ");
let ticket_second_commands = TICKET_SECOND_COMMANDS.join(" ");
let ticket_flags = flag_list(&TICKET_FLAGS);
let ticket_flags = TICKET_FLAGS
.iter()
.map(|(command, flag)| {
format!(
"complete -c worklane -n '__worklane_command_is {command}' -l {flag} \\\n \
-x -a '(worklane ls --ids)'"
)
})
.collect::<Vec<_>>()
.join("\n");
let relation_kinds = RelationKind::ALL
.iter()
.map(|kind| kind.flag())
@@ -207,17 +375,19 @@ complete -c worklane \
-n '__worklane_first_arg_of {ticket_commands}; or __worklane_second_arg_of {ticket_second_commands}' \
-a '(worklane ls --ids)'
# `relate` takes its targets as option values, so they are completed by flag rather
# than by position.
complete -c worklane -n '__worklane_command_is relate' {ticket_flags} \
-x -a '(worklane ls --ids)'
# The options whose value is a ticket, one rule per command so that a flag is offered
# only under the command that has it. `relate` takes its three targets this way rather
# than by position, and `chown --clear` names the ticket in the flag because with no user
# to give there is no second positional to put it in. Its `--clear` is scoped like every
# other: `set` has one that takes a field name, which clap already offers.
{ticket_flags}
# `--clear` is the one flag here whose first value is not a ticket, so it is not in
# `TICKET_FLAGS`: it takes the kind and then the target, and offering a board listing where
# the kind goes would be offering values it refuses. The kinds come from `RelationKind`
# rather than being spelled again. The target gets no rule at all, deliberately: fish
# completes the value after the flag, and the case this flag exists for is a target whose
# ticket is gone, which no listing of the board can offer.
# `relate --clear` is the one `--clear` whose first value is not a ticket, which is why
# that pair is not in `TICKET_FLAGS`: it takes the kind and then the target, and offering a
# board listing where the kind goes would be offering values it refuses. The kinds come
# from `RelationKind` rather than being spelled again. The target gets no rule at all,
# deliberately: fish completes the value after the flag, and the case this flag exists for
# is a target whose ticket is gone, which no listing of the board can offer.
complete -c worklane -n '__worklane_command_is relate' -l clear -x -a '{relation_kinds}'
# Campaigns, from `campaign ls --ids`, in the three places one is named: `assign`'s first
@@ -247,11 +417,6 @@ complete -c worklane -n '__worklane_command_is ls' {campaign_flags} \
# here are the values it refuses.
complete -c worklane -n '{tag_nested}' -a '(worklane tags | cut -f1,3)'
# `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.
complete -c worklane -n '__worklane_command_is chown' -l clear -x -a '(worklane ls --ids)'
# clap emits the statuses for `mv --status`, which is an option, but the fish generator
# emits nothing for the possible values of a positional. So the one place a status is
# positional needs them listed, and the same goes for the shell below.
@@ -489,6 +654,151 @@ mod tests {
);
}
/// One line, split the way the prompt splits it, and what the cursor's argument names.
///
/// The splitter is the prompt's own, so a row below states a line as a reader types it
/// rather than as a hand-written argument vector, and the two cannot come apart.
fn at_cursor(line: &str) -> Option<Argument> {
let split = crate::split::split_line(line, line.len());
argument_at(&split.args, split.cursor_arg)
}
/// The fixed values offered at the cursor, or nothing where what goes there is not a
/// fixed list.
fn values(line: &str) -> Option<Vec<String>> {
match at_cursor(line) {
Some(Argument::Fixed(values)) => Some(values),
_ => None,
}
}
/// Every position a ticket is taken in, as the line that reaches it.
#[test]
fn a_ticket_is_recognised_in_every_position_a_command_takes_one() {
for line in [
// The first positional, begun and half typed.
"show ",
"mv 1b7",
"comment ",
"check ",
// The second, where the first argument is a user or a campaign.
"chown alice ",
"assign v1 1b7",
// The three of `relate`'s flags, and `chown --clear`, which names the ticket
// in the flag because there is no user to give.
"relate 1b78a24 --blocked-by ",
"relate 1b78a24 --regression-of 417",
"relate 1b78a24 --relates-to ",
"chown --clear ",
] {
assert_eq!(
at_cursor(line),
Some(Argument::Ticket),
"`{line}` takes a ticket at the cursor and was not offered one"
);
}
}
/// The three places a campaign is named, and the two a tag is, which are why the lists
/// are not one list.
#[test]
fn a_campaign_and_a_tag_are_recognised_where_each_is_named() {
for line in [
"assign ",
"campaign show ",
"campaign set v1",
"ls --campaign ",
] {
assert_eq!(at_cursor(line), Some(Argument::Campaign), "`{line}`");
}
for line in ["ls --tag ", "append 1b78a24 --tags bu"] {
assert_eq!(at_cursor(line), Some(Argument::Tag { declared: false }), "`{line}`");
}
// `tags set` changes what a declared tag means and refuses one the file does not
// declare, so only the declared ones may be offered there. That is the fish half's
// 193f9be, which this deliberately does not inherit.
assert_eq!(at_cursor("tags set "), Some(Argument::Tag { declared: true }));
}
/// The verbs, which are clap's own subcommands at the top level and inside a group.
#[test]
fn the_verb_position_is_offered_the_subcommands() {
let top = values("").expect("the empty line names a verb");
for command in ["add", "ls", "mv", "relate", "campaign", "tags"] {
assert!(top.contains(&command.to_string()), "`{command}` is not offered: {top:?}");
}
// A group's own verb sits where a top-level command's first argument does, which is
// why `campaign show` needs a rule of its own in the fish half as well. In the
// order the definition spells them, since that is the order tab steps through.
let nested = values("campaign ").expect("a group names a verb");
assert_eq!(nested, ["add", "set", "append", "ls", "show"], "{nested:?}");
// `help` is clap's own and is added when the command is built, which nothing here
// does. That suits the board: what `help` prints is a page, and the prompt has a
// row.
assert!(!top.contains(&"help".to_string()), "{top:?}");
}
/// The values clap itself holds, which is every `ValueEnum` in the tool: nothing here
/// writes a status or a clearable field down a second time.
#[test]
fn an_enum_valued_argument_is_offered_the_enums_own_values() {
let statuses = values("mv 1b78a24 --status ").expect("--status takes a status");
let listed: Vec<String> = Status::ALL.iter().map(|s| s.as_str().to_string()).collect();
assert_eq!(statuses, listed, "the five statuses are not what `--status` offers");
// The one place a status is positional, which clap emits nothing for and the fish
// half lists by hand.
assert_eq!(values("ls "), Some(listed));
// And the other two enums a reader types: the fields `set --clear` empties and the
// shells `completions` writes for.
let fields = values("set 1b78a24 --clear ").expect("--clear takes a field");
assert!(fields.contains(&"acceptance".to_string()), "{fields:?}");
let shells = values("completions ").expect("completions takes a shell");
assert!(shells.contains(&"fish".to_string()), "{shells:?}");
}
/// `relate --clear` takes the kind and then the target, which is the one argument clap
/// cannot answer for: possible values on the flag would refuse every target.
#[test]
fn relate_clear_is_offered_the_relation_kinds_and_no_ticket() {
let kinds = values("relate 1b78a24 --clear ").expect("--clear takes a kind");
let listed: Vec<String> = RelationKind::ALL
.iter()
.map(|kind| kind.flag().to_string())
.collect();
assert_eq!(kinds, listed, "{kinds:?}");
// And the second value is a target the board may no longer hold, which is what the
// flag exists for, so nothing is offered there at all.
assert_eq!(at_cursor("relate 1b78a24 --clear blocked-by "), None);
}
/// The positions that take free text, where offering anything would be offering a guess.
#[test]
fn nothing_is_recognised_where_the_argument_is_free_text() {
for line in [
// `chown`'s first argument is a user, checked against nothing.
"chown ",
// `mv` has no second positional, and a comment body is prose.
"mv 1b78a24 ",
"comment 1b78a24 the ",
// `tags add` declares a word the board does not have yet, so the tags it does
// have are exactly the values it refuses.
"tags add ",
// And both `--tags` that take the whole list, where a single tag offered into
// `bug,tui` would be one the field never asked for.
"add --tags ",
"set 1b78a24 --tags bug,",
] {
assert_eq!(at_cursor(line), None, "`{line}` was offered a candidate where none goes");
}
}
/// **Every rule naming an option has to say which command it belongs to.** A bare
/// `complete -c worklane -l tag` tells fish the whole tool takes `--tag`, so
/// `worklane init --<TAB>` offered six options that only `relate` and `ls` have. This
@@ -522,6 +832,7 @@ mod tests {
.chain(TICKET_SECOND_COMMANDS.iter())
.chain(CAMPAIGN_COMMANDS.iter())
.copied()
.chain(TICKET_FLAGS.iter().map(|(command, _)| *command))
.chain(TAG_FLAGS.iter().map(|(command, _)| *command));
for name in top {
@@ -545,7 +856,9 @@ mod tests {
/// bare search for `-l clear` cannot tell them apart, which is what this used to do.
#[test]
fn each_clear_flag_is_completed_for_its_own_command() {
let script = fish_dynamic();
// Continuations joined first: a rule is one logical line, and the generated ones
// put the flag and its values on either side of a trailing backslash.
let script = fish_dynamic().replace("\\\n", " ");
let cli = command();
let rule_for = |name: &str| {
@@ -558,6 +871,7 @@ mod tests {
&& line.contains(&scope)
})
.unwrap_or_else(|| panic!("no --clear rule for {name}:\n{script}"))
.to_string()
};
let has_clear = |name: &str| {
@@ -584,26 +898,41 @@ mod tests {
"tickets offered where the kind goes: {relate}"
);
// `set --clear` takes a field name, which clap already offers, and `relate --clear`
// takes a kind. Only `chown`'s names a ticket, so only that pair is in the table.
assert!(
!TICKET_FLAGS.contains(&"clear"),
"--clear in TICKET_FLAGS would offer tickets to `set --clear`, which takes a field"
!TICKET_FLAGS.contains(&("set", "clear")),
"`set --clear` in TICKET_FLAGS would offer tickets where a field name goes"
);
assert!(
!TICKET_FLAGS.contains(&("relate", "clear")),
"`relate --clear` in TICKET_FLAGS would offer tickets where the kind goes"
);
assert!(
TICKET_FLAGS.contains(&("chown", "clear")),
"`chown --clear` names the ticket in the flag, so it belongs in TICKET_FLAGS"
);
}
/// The flags completed as tickets have to be `relate`'s actual flags, or the rule
/// completes an option nothing accepts.
/// Each flag completed as a ticket has to be an option its own command actually takes,
/// or the rule completes something nothing accepts.
///
/// The command is half of what is checked, which is what the pairs bought: a flat list
/// could only be walked against one command, and `--clear` is spelled the same on three.
#[test]
fn every_ticket_flag_is_a_real_option() {
let relate = command()
.find_subcommand("relate")
.expect("relate exists")
.clone();
let known: Vec<String> = relate
.get_arguments()
.filter_map(|arg| arg.get_long().map(str::to_string))
.collect();
for flag in TICKET_FLAGS {
assert!(known.contains(&flag.to_string()), "`relate` has no --{flag}");
let cli = command();
for (name, flag) in TICKET_FLAGS {
let subcommand = cli
.find_subcommand(name)
.unwrap_or_else(|| panic!("no such subcommand: {name}"));
assert!(
subcommand
.get_arguments()
.any(|arg| arg.get_long() == Some(flag)),
"`worklane {name}` has no --{flag}"
);
}
}
+664 -12
View File
@@ -28,6 +28,7 @@ use ratatui::widgets::{Block, Borders, Clear, Padding, Paragraph, Tabs, Wrap};
use crate::campaign::{CAMPAIGNS_DIR, CampaignIndex, Standing};
use crate::command::{Cli, Command};
use crate::completions::{Argument, argument_at};
use crate::history::{HistoryPart, history_parts, history_root, read_history};
use crate::split::{Unclosed, split_line};
use crate::tag::{NO_ANNOTATION, TAGS_FILE, TagIndex};
@@ -741,6 +742,26 @@ pub struct Prompt {
/// The half typed line `up` walked away from, put back by walking down past the newest
/// entry. `Some` exactly while `position` is.
pending: Option<String>,
/// Where a `tab` walk has got to, or `None` while nothing on the row came from one.
///
/// Cleared by every edit of the line, beside `refused` and for the same reason: the walk
/// is about an argument, and a line that has changed is a different argument.
completing: Option<Completing>,
}
/// A `tab` walk in progress: the line as it stood before the first press, and how many
/// presses have landed on it since.
///
/// The line rather than the candidate it chose, so each press rebuilds the row from what was
/// typed and reads the candidates fresh. Holding the list instead would be a copy going
/// stale between two presses, and holding the last candidate would narrow the list to it —
/// a walk that stepped once and then stood still.
#[derive(Debug)]
struct Completing {
line: String,
cursor: usize,
/// How many times `tab` has been pressed with nothing else in between, counting from 1.
presses: usize,
}
impl Prompt {
@@ -748,11 +769,11 @@ impl Prompt {
/// `esc` and `enter`: those two are the mode's rather than the line's, and they are
/// answered by [`Board::prompt_key`] before it gets here.
///
/// Left, right, home, end, backspace and `ctrl-w` behave as they do in a shell. There
/// is no `tab`: suggesting the selected ticket is 00a14e7, and until then it is a key
/// that must not reach the project tabs. Every other control combination lands on the
/// last arm and does nothing, which is what stops `ctrl-d` reaching the action bound
/// to `d`.
/// Left, right, home, end, backspace and `ctrl-w` behave as they do in a shell. `tab`
/// is not here either: it takes the suggestion, which is the board's rather than the
/// line's, since the selected card is what it is made of. Every other control
/// combination lands on the last arm and does nothing, which is what stops `ctrl-d`
/// reaching the action bound to `d`.
fn key(&mut self, key: KeyEvent, control: bool) {
match key.code {
KeyCode::Left if !control => self.cursor = self.left_of(),
@@ -763,15 +784,23 @@ impl Prompt {
// with it. Movement above deliberately does not clear it.
KeyCode::Backspace if !control => self.cut(self.left_of()),
KeyCode::Char('w') if control => self.cut(self.word_start()),
KeyCode::Char(typed) if !control => {
self.line.insert(self.cursor, typed);
self.cursor += typed.len_utf8();
self.refused = None;
}
KeyCode::Char(typed) if !control => self.insert(typed.encode_utf8(&mut [0; 4])),
_ => {}
}
}
/// Put `text` into the line at the cursor and leave the cursor after it, which is what
/// typing it would have done.
///
/// The message about the last enter goes with it, for the reason every other edit takes
/// it away: it was about a line that is no longer on the row.
fn insert(&mut self, text: &str) {
self.line.insert_str(self.cursor, text);
self.cursor += text.len();
self.refused = None;
self.completing = None;
}
/// The offset one character to the left of the cursor, or the cursor itself at the
/// start of the line. By characters, so a cursor never lands inside one.
fn left_of(&self) -> usize {
@@ -830,6 +859,7 @@ impl Prompt {
self.line.replace_range(from..self.cursor, "");
self.cursor = from;
self.refused = None;
self.completing = None;
}
/// Put a recalled line on the row with the cursor at its end, the way a shell hands
@@ -842,6 +872,7 @@ impl Prompt {
self.cursor = line.len();
self.line = line;
self.refused = None;
self.completing = None;
}
}
@@ -2355,6 +2386,9 @@ impl Board {
// the whole board rather than the prompt alone.
KeyCode::Up if !control => self.recall_back(),
KeyCode::Down if !control => self.recall_forward(),
// The mode's too, and never the tabs': every key belongs to the prompt while it
// is open, and what this one takes is made of the selected card.
KeyCode::Tab if !control => self.complete(),
_ => {
if let Some(prompt) = &mut self.prompt {
prompt.key(key, control);
@@ -2365,6 +2399,179 @@ impl Board {
true
}
/// Every candidate for the argument the cursor is in, and what has been typed into it.
///
/// The one question the row's suggestion and the `tab` walk both ask, so what is drawn
/// and what a press takes cannot come apart. Derived on every call and held nowhere:
/// the line is edited and the board reloads under it, and a list kept between two
/// presses would describe neither.
///
/// **What goes where is [`argument_at`]'s**, off the tables the fish completions are
/// generated from, and **what the board holds of it is this file's**. Nothing here reads
/// the tree: a ticket is the selected card, a campaign and a tag are the tab's own rows,
/// rebuilt at every reload beside the columns, and everything else is written down once
/// in the clap definition.
///
/// Two things have to hold, each its own answer to the reader:
///
/// - **The cursor is at the end of the line.** The suggestion is drawn after it and a
/// press replaces the argument it is in, so with the line continuing past the cursor
/// both would land in the middle of something already typed. That is the rule a
/// shell's own suggestion keeps.
/// - **A candidate still starts with what is typed.** An offer that no longer matches
/// the argument under it describes nothing.
///
/// The line it reads is the one that was on the row before `tab` was first pressed,
/// where a walk is under way: what is on the row then is a candidate, and reading the
/// stem off it would narrow the list to the candidate the last press chose.
fn completion(&self) -> Option<(String, Vec<String>)> {
let prompt = self.prompt.as_ref()?;
if prompt.cursor != prompt.line.len() {
return None;
}
let line = match &prompt.completing {
Some(walk) => walk.line.as_str(),
None => prompt.line.as_str(),
};
let split = split_line(line, line.len());
// Empty where the argument has been opened and nothing of it lies behind the
// cursor, which is every candidate offered.
let stem = match split.at_new_arg {
true => String::new(),
false => split.args[split.cursor_arg].clone(),
};
let offers: Vec<String> = self
.candidates(&split.args, split.cursor_arg)
.into_iter()
.filter(|candidate| candidate.starts_with(&stem))
.collect();
(!offers.is_empty()).then_some((stem, offers))
}
/// What the board currently holds of whatever the argument names.
///
/// The tab's own rows for a campaign and a tag, which `reload` rebuilds beside the
/// columns and the `c` and `t` pickers draw: the answer is already in memory, and a
/// read of the tree on a keypress would be a second source for it.
///
/// A campaign is offered by codename, which is what the board draws on every card in it
/// and the shortest thing that addresses it. One that has none falls back to its short
/// id, which is what the board labels it with and what `assign` resolves — leaving it
/// out would hide a campaign from the only place the reader can reach it by typing.
fn candidates(&self, args: &[String], index: usize) -> Vec<String> {
let tab = self.current();
let mut found: Vec<String> = match argument_at(args, index) {
None => return Vec::new(),
Some(Argument::Fixed(values)) => values,
Some(Argument::Ticket) => tab
.selected()
.map(|card| card.ticket.id.clone())
.into_iter()
.collect(),
Some(Argument::Campaign) => tab
.campaigns
.iter()
.map(|row| match &row.codename {
Some(codename) => codename.clone(),
None => short_id(&row.uuid).to_string(),
})
.collect(),
Some(Argument::Tag { declared }) => tab
.tags
.iter()
.filter(|row| !declared || row.declared())
.map(|row| row.name.clone())
.collect(),
};
// The merge tab holds several boards' campaigns, so one codename can arrive twice.
// A repeat is a press that appears to do nothing, which is worse than the tab
// costing a moment here.
let mut seen = std::collections::HashSet::new();
found.retain(|candidate| seen.insert(candidate.clone()));
found
}
/// What the row draws after the cursor: the part of the common prefix of the candidates
/// that is not typed yet, which is exactly what the next `tab` takes.
///
/// One rule for one candidate and for many. With a ticket there is only ever the
/// selected card, so what is drawn is the rest of its id; with the five statuses there
/// is nothing every candidate agrees on, so nothing is drawn and `tab` steps through
/// them instead. What the row shows is never something a press would not do.
///
/// Nothing while a walk is under way: the row is holding a whole candidate then, and a
/// second one drawn against it would read as part of the same word.
pub fn suggestion(&self) -> Option<String> {
if self.prompt.as_ref()?.completing.is_some() {
return None;
}
let (stem, offers) = self.completion()?;
common_prefix(&offers)
.strip_prefix(&stem)
.filter(|rest| !rest.is_empty())
.map(str::to_string)
}
/// `tab`: take what every candidate agrees on, and then step through them one press at
/// a time.
///
/// The first press takes the common prefix where there is more of it than has been
/// typed, which is the whole candidate when there is only one. From there each press
/// puts one candidate on the row in place of the last, wrapping at the end. A shell
/// does the same, and it needs no list drawn over the columns — which is the trade this
/// makes, since the board behind the prompt is what the reader is reading.
///
/// **Each press rebuilds the row from the line as it stood before the first**, so the
/// candidates are read fresh every time and nothing is stored but where the walk has
/// got to. Stepping off a candidate the last press typed would narrow the list to it.
///
/// The whole board rather than the prompt alone, for the reason the recall walk is:
/// what is on offer is made of the board and the line is only where it lands.
fn complete(&mut self) {
let Some((stem, offers)) = self.completion() else {
return;
};
let presses = self
.prompt
.as_ref()
.and_then(|prompt| prompt.completing.as_ref())
.map_or(0, |walk| walk.presses)
+ 1;
// The prefix step is only a step where it adds something. With the statuses, which
// agree on nothing, the first press is already the first candidate.
let common = common_prefix(&offers);
let taken = match (common.len() > stem.len(), presses) {
(true, 1) => common.as_str(),
(true, step) => offers[(step - 2) % offers.len()].as_str(),
(false, step) => offers[(step - 1) % offers.len()].as_str(),
};
let rest = taken[stem.len()..].to_string();
let Some(prompt) = &mut self.prompt else {
return;
};
let (line, cursor) = match prompt.completing.take() {
Some(walk) => (walk.line, walk.cursor),
None => (prompt.line.clone(), prompt.cursor),
};
prompt.line = line.clone();
prompt.cursor = cursor;
// After the insert, which clears the walk the way every other edit of the line does.
prompt.insert(&rest);
prompt.completing = Some(Completing { line, cursor, presses });
}
/// `up`: one line further back, or the newest line when the reader is still on their
/// own.
///
@@ -4554,7 +4761,7 @@ fn draw_footer(frame: &mut Frame, board: &Board, area: Rect) {
// and is asked first: an input cannot be covered, and it is the newest of the three
// things that can hold the row. Only one of the two prompts can be open at a time.
if let Some(prompt) = &board.prompt {
draw_prompt(frame, prompt, area);
draw_prompt(frame, prompt, board.suggestion().as_deref(), area);
return;
}
@@ -4760,7 +4967,14 @@ const PROMPT_OPENING: &str = " :";
///
/// `run` and not `check`: enter hands the line to the same handler the shell reaches, and
/// the row has to say which of the two it is about to do.
fn draw_prompt(frame: &mut Frame, prompt: &Prompt, area: Rect) {
///
/// The suggestion is drawn after the line in grey, which is what the palette already spends
/// on a value that is not one: it is not in the line until `tab` puts it there, and the
/// reader has to be able to tell the two apart at a glance. It takes what the line leaves
/// of the field rather than a field of its own, so a long command loses the offer instead
/// of pushing the keys off the row. The terminal cursor sits on its first cell, which is
/// where the cursor already was: what is under a cursor is still what will be typed over.
fn draw_prompt(frame: &mut Frame, prompt: &Prompt, suggestion: Option<&str>, area: Rect) {
let keys = key_hints(&[("↵", "run"), ("esc", "cancel")]);
let spent: usize = PROMPT_OPENING.chars().count()
+ KEY_GAP.chars().count()
@@ -4775,6 +4989,18 @@ fn draw_prompt(frame: &mut Frame, prompt: &Prompt, area: Rect) {
let (visible, at) = prompt_window(&prompt.line, prompt.cursor, room);
let mut spans = vec![Span::raw(format!("{PROMPT_OPENING}{visible}"))];
// Only ever drawn where the cursor is at the end of the line, which is what `visible`
// then ends at, so this follows the cursor rather than landing in front of the tail of
// a command.
if let Some(rest) = suggestion {
let left = room.saturating_sub(visible.chars().count());
let shown: String = rest.chars().take(left).collect();
if !shown.is_empty() {
spans.push(Span::styled(shown, Style::default().fg(Color::Grey.into())));
}
}
match &prompt.refused {
Some(message) => spans.push(Span::styled(
format!("{KEY_GAP}{message}"),
@@ -4794,6 +5020,28 @@ fn draw_prompt(frame: &mut Frame, prompt: &Prompt, area: Rect) {
frame.set_cursor_position((area.x + column.min(area.width.saturating_sub(1)), area.y));
}
/// The longest opening every one of `values` shares, which is what one `tab` can take
/// without choosing between them.
///
/// Counted in characters rather than bytes, so a tag spelled in more than ascii is cut on
/// one of its own letters. An empty list has no prefix and neither has a list whose members
/// start differently, which is the answer that puts the first press on the first candidate
/// instead.
fn common_prefix(values: &[String]) -> String {
let Some(first) = values.first() else {
return String::new();
};
values[1..].iter().fold(first.clone(), |prefix, value| {
prefix
.chars()
.zip(value.chars())
.take_while(|(held, c)| held == c)
.map(|(held, _)| held)
.collect()
})
}
/// The part of `line` a field `room` cells wide shows with the cursor at `cursor`, and the
/// column the cursor lands on inside it.
///
@@ -9047,6 +9295,410 @@ approach";
assert_eq!(prompt_line(&board), Some("ls backlog"), "the walk did not happen");
}
// ---------------------------------------------------------------- the suggestion --
/// The id of the card the selection is on, which is what every suggestion is made of.
fn selected_id(board: &Board) -> String {
board.selected().expect("a card is selected").ticket.id.clone()
}
/// Open a fresh prompt, type `line` into it, and answer what is suggested at the end
/// of it.
fn suggested(board: &mut Board, line: &str) -> Option<String> {
board.open_prompt();
type_line(board, line);
let rest = board.suggestion();
board.prompt = None;
rest
}
/// The same, for every candidate the argument at the end of `line` has rather than the
/// part of them the row draws.
fn offered(board: &mut Board, line: &str) -> Vec<String> {
board.open_prompt();
type_line(board, line);
let found = board.completion().map(|(_, offers)| offers).unwrap_or_default();
board.prompt = None;
found
}
/// Type `line` and then press tab `presses` times, and answer what is on the row.
fn tabbed(board: &mut Board, line: &str, presses: usize) -> String {
board.open_prompt();
type_line(board, line);
for _ in 0..presses {
press_prompt(board, KeyCode::Tab);
}
let row = prompt_line(board).expect("the prompt closed").to_string();
board.prompt = None;
row
}
/// Every position a command takes a ticket in, driven as a line typed at the prompt.
///
/// The whole id where the argument has been opened and nothing typed into it, which is
/// the ordinary case: the reader has the card in front of them and presses tab.
#[test]
fn the_selected_id_is_suggested_wherever_a_ticket_argument_goes() {
let (_root, mut board) = runnable();
let id = selected_id(&board);
for line in [
// The first positional.
"show ",
"mv ",
"comment ",
// The second, which is where `chown` and `assign` put it on purpose.
"chown alice ",
"assign v1 ",
// `relate`'s three flags, and `chown --clear`, which names the ticket in the
// flag since there is no user to give.
"relate 2222222 --blocked-by ",
"relate 2222222 --regression-of ",
"relate 2222222 --relates-to ",
"chown --clear ",
] {
assert_eq!(
suggested(&mut board, line).as_deref(),
Some(id.as_str()),
"`{line}` takes a ticket and was offered nothing"
);
}
}
/// And every position that takes something else, which is the half a version counting
/// the first argument alone gets wrong.
///
/// Asked of the candidates rather than of the row, because several of these positions
/// now have candidates of their own: what has to be true is that none of them is the
/// card under the selection.
#[test]
fn the_selected_id_is_not_offered_where_the_argument_is_not_a_ticket() {
let (_root, mut board) = runnable();
let id = selected_id(&board);
for line in [
// The verb itself, empty and half typed.
"",
"sh",
// `chown` takes a user first and `assign` a campaign.
"chown ",
"assign ",
// A status, and a campaign under its own command.
"ls ",
"campaign show ",
// The two `--clear` flags spelled like `chown`'s: a relation kind, and a field.
"relate 2222222 --clear ",
"set 2222222 --clear ",
// And `relate --clear`'s second value, which is a target the board may no
// longer hold.
"relate 2222222 --clear blocked-by ",
// One past the ticket, where `mv` wants a status.
"mv 2222222 ",
] {
assert!(
!offered(&mut board, line).contains(&id),
"`{line}` was offered the selected ticket where none goes"
);
}
}
/// A partly typed argument is completed rather than restated, and only while the
/// selected id still starts with what is on the row.
#[test]
fn a_half_typed_argument_is_suggested_only_while_the_id_starts_with_it() {
let (_root, mut board) = runnable();
let id = selected_id(&board);
let head = &id[..3];
assert_eq!(
suggested(&mut board, &format!("show {head}")).as_deref(),
Some(&id[3..]),
"the part already typed was offered a second time"
);
// The whole id typed leaves nothing to add, which is not a suggestion of nothing.
assert_eq!(suggested(&mut board, &format!("show {id}")), None);
// And a prefix the selection does not match describes another ticket entirely.
assert_eq!(suggested(&mut board, "show 9"), None);
}
/// Nothing is suggested with no card under the selection: on the frame, where the
/// selection is on a campaign or a tag rather than a ticket, and on an empty board.
#[test]
fn nothing_is_suggested_when_no_card_is_selected() {
let (_root, mut board) = runnable();
board.current_mut().focus = Focus::Frame;
assert_eq!(suggested(&mut board, "show "), None, "the frame offered a ticket");
let empty = board_dir();
let mut bare = one_board(&empty);
assert_eq!(suggested(&mut bare, "show "), None, "an empty board offered a ticket");
}
/// What the row shows: the suggestion after the cursor, in grey, and not in the line.
#[test]
fn the_suggestion_is_drawn_after_the_cursor_in_grey_and_is_not_yet_the_line() {
let (_root, mut board) = runnable();
let id = selected_id(&board);
board.open_prompt();
type_line(&mut board, "show ");
let row = footer(&board, SCREEN.width, SCREEN.height);
assert!(row.contains(&format!(":show {id}")), "the suggestion is not drawn: {row}");
assert_eq!(prompt_line(&board), Some("show "), "the suggestion went into the line");
let (colour, _) = footer_style(&board, SCREEN.width, SCREEN.height, &id);
assert_eq!(colour, Color::Grey.into(), "the suggestion is not drawn as a placeholder");
// The cursor stays where the line ends, which is the first cell of the suggestion.
let mut terminal = Terminal::new(TestBackend::new(SCREEN.width, SCREEN.height)).unwrap();
terminal.draw(|frame| draw(frame, &board)).unwrap();
let at = terminal.get_cursor_position().unwrap();
assert_eq!(at.x as usize, PROMPT_OPENING.chars().count() + "show ".len());
}
/// Tab takes it, and any other key leaves the line to say what was typed.
#[test]
fn tab_takes_the_suggestion_into_the_line_and_another_key_drops_it() {
let (_root, mut board) = runnable();
let id = selected_id(&board);
board.open_prompt();
type_line(&mut board, "show ");
press_prompt(&mut board, KeyCode::Tab);
assert_eq!(prompt_line(&board), Some(format!("show {id}").as_str()));
// Nothing is left to offer once the whole id is on the row, so a second press
// cannot double it.
press_prompt(&mut board, KeyCode::Tab);
assert_eq!(prompt_line(&board), Some(format!("show {id}").as_str()));
// And a key that takes the line off the id drops the offer rather than holding it.
board.prompt = None;
board.open_prompt();
type_line(&mut board, "show 9");
assert_eq!(board.suggestion(), None);
press_prompt(&mut board, KeyCode::Tab);
assert_eq!(prompt_line(&board), Some("show 9"), "tab typed a suggestion that had gone");
}
/// The swallow contract for the one key this ticket gives the prompt: `tab` is the
/// project key on the board and must not be while a command is being typed.
#[test]
fn tab_in_the_prompt_never_changes_the_project_tab() {
let alpha = board_dir();
let beta = board_dir();
write_ticket(&alpha, "backlog", "11111111-0000-4000-8000-000000000000", "Alpha", "");
write_ticket(&beta, "backlog", "22222222-0000-4000-8000-000000000000", "Beta", "");
let mut board = boards(&[("alpha", &alpha), ("beta", &beta)]);
assert!(board.tabbed(), "the fixture has nothing to switch between");
board.open_prompt();
// Both with something to take and with nothing, since the arm has to be the
// prompt's either way.
for line in ["show ", "ls "] {
board.prompt = Some(Prompt::default());
type_line(&mut board, line);
assert!(board.prompt_key(typed(KeyCode::Tab), SCREEN), "tab was not taken");
assert_eq!(board.tab, 0, "`{line}` let tab through to the tabs");
}
}
/// A board carrying everything the prompt completes off the tab's own rows: two
/// campaigns, one without a codename, and a vocabulary with a tag nothing declares.
fn completable() -> (Fixture, Board) {
let dir = board_dir();
write_tag_ticket(
&dir,
"backlog",
"11111111-0000-4000-8000-000000000000",
"One",
"bug,sync",
);
write_tag_ticket(&dir, "committed", "22222222-0000-4000-8000-000000000000", "Two", "bug");
write_campaign(&dir, "aaaaaaaa-0000-4000-8000-000000000000", "First release", "v1", "One.");
write_campaign(&dir, "bbbbbbbb-0000-4000-8000-000000000000", "Nameless", "", "Two.");
write_vocabulary(
&dir,
&[
("bug", "Behaviour that contradicts what the tool says."),
("chore", "Work."),
],
);
let board = one_board(&dir);
(dir, board)
}
/// The verb position, which is clap's own subcommands and the campaign group's own.
#[test]
fn the_verb_is_completed_from_the_subcommands() {
let (_dir, mut board) = completable();
assert!(offered(&mut board, "").contains(&"relate".to_string()));
// Narrowed to what has been typed, and the common opening taken on the first press.
assert_eq!(offered(&mut board, "comm"), ["comment"]);
assert_eq!(tabbed(&mut board, "comm", 1), "comment");
// A group's verbs sit where a top-level command's first argument does.
assert_eq!(tabbed(&mut board, "campaign sh", 1), "campaign show");
}
/// The five statuses, in both places one is named.
#[test]
fn a_status_argument_is_completed_from_the_status_enum() {
let (_dir, mut board) = completable();
let listed: Vec<String> = Status::ALL.iter().map(|s| s.as_str().to_string()).collect();
assert_eq!(offered(&mut board, "mv 1111111 --status "), listed);
assert_eq!(offered(&mut board, "ls "), listed);
// And narrowed by what is typed, where `d` reaches two of them.
assert_eq!(offered(&mut board, "ls d"), ["done", "discarded"]);
}
/// Tags and campaigns, which come off the rows the tab already holds.
#[test]
fn a_tag_and_a_campaign_are_completed_from_the_tabs_own_rows() {
let (_dir, mut board) = completable();
// Every tag the board declares or carries, which is what `--tag` matches.
assert_eq!(offered(&mut board, "ls --tag "), ["bug", "chore", "sync"]);
assert_eq!(offered(&mut board, "append 1111111 --tags s"), ["sync"]);
// A campaign by its codename, and by its short id where it has none: that is what
// the board labels it with and what `assign` resolves.
assert_eq!(offered(&mut board, "assign "), ["v1", "bbbbbbb"]);
assert_eq!(offered(&mut board, "campaign show v"), ["v1"]);
assert_eq!(offered(&mut board, "ls --campaign v"), ["v1"]);
}
/// `tags set` refuses a tag the vocabulary does not declare, so the prompt does not
/// offer one. That is the fish half's 193f9be, which this deliberately does not inherit.
#[test]
fn the_prompt_offers_no_candidate_the_command_would_refuse() {
let (_dir, mut board) = completable();
assert_eq!(offered(&mut board, "tags set "), ["bug", "chore"]);
assert!(
!offered(&mut board, "tags set ").contains(&"sync".to_string()),
"a carried but undeclared tag was offered where only a declared one is taken"
);
// `tags add` takes a word the board does not have yet, so every tag it has is a
// value it refuses, and both `--tags` that take the whole list would have one tag
// replace what is already in it.
for line in ["tags add ", "add --tags ", "set 1111111 --tags bug,"] {
assert!(offered(&mut board, line).is_empty(), "`{line}` offered a candidate");
}
}
/// The candidates are what the tab already holds, so a keypress never goes to disk.
///
/// Pinned by taking the board away from under it: a completion that read the tree would
/// answer nothing here, and one reading the rows `reload` built answers exactly what it
/// answered before. The rows outlive the directory because they are the same rows the
/// `c` and `t` pickers draw.
#[test]
fn the_candidates_come_off_the_loaded_rows_and_never_off_the_tree() {
let (dir, mut board) = completable();
let tags = offered(&mut board, "ls --tag ");
let campaigns = offered(&mut board, "assign ");
let id = selected_id(&board);
std::fs::remove_dir_all(&dir).unwrap();
assert_eq!(offered(&mut board, "ls --tag "), tags, "the tags were read off the tree");
assert_eq!(offered(&mut board, "assign "), campaigns, "the campaigns were");
assert_eq!(offered(&mut board, "show "), [id], "the ticket was");
// And the fixed lists were never anywhere but the clap definition.
assert!(offered(&mut board, "ls ").contains(&"backlog".to_string()));
}
/// `relate --clear` takes the kind first, and the three kinds are what is offered there
/// rather than the board listing the other three flags get.
#[test]
fn relate_clear_is_completed_with_the_relation_kinds() {
let (_dir, mut board) = completable();
let kinds: Vec<String> = RelationKind::ALL
.iter()
.map(|kind| kind.flag().to_string())
.collect();
assert_eq!(offered(&mut board, "relate 1111111 --clear "), kinds);
assert_eq!(
tabbed(&mut board, "relate 1111111 --clear b", 1),
"relate 1111111 --clear blocked-by"
);
// And the target after it is one the board may no longer hold.
assert!(offered(&mut board, "relate 1111111 --clear blocked-by ").is_empty());
}
/// The walk itself: the common opening on the first press, then one candidate per press
/// in place of the last, round to the start again.
#[test]
fn tab_takes_the_common_prefix_and_then_steps_through_the_candidates() {
let (_dir, mut board) = completable();
// `comment` and `completions` are what `co` narrows to, and `com` is as far as one
// press can go without choosing between them.
assert_eq!(tabbed(&mut board, "co", 0), "co");
assert_eq!(tabbed(&mut board, "co", 1), "com");
assert_eq!(tabbed(&mut board, "co", 2), "comment");
assert_eq!(tabbed(&mut board, "co", 3), "completions");
assert_eq!(tabbed(&mut board, "co", 4), "comment", "the walk did not come round");
// With nothing in common the first press is already the first candidate, and each
// one replaces the last rather than being typed after it.
assert_eq!(tabbed(&mut board, "ls ", 0), "ls ");
assert_eq!(tabbed(&mut board, "ls ", 1), "ls backlog");
assert_eq!(tabbed(&mut board, "ls ", 2), "ls committed");
assert_eq!(tabbed(&mut board, "ls ", 6), "ls backlog");
}
/// What the row draws is what the next press takes, which is why it is nothing where
/// the candidates agree on nothing.
#[test]
fn the_row_draws_the_common_prefix_and_nothing_where_there_is_none() {
let (_dir, mut board) = completable();
assert_eq!(suggested(&mut board, "comm").as_deref(), Some("ent"));
assert_eq!(
suggested(&mut board, "co").as_deref(),
Some("m"),
"`comment` and `completions` agree on one more letter"
);
assert_eq!(suggested(&mut board, "ls "), None, "the five statuses agree on nothing");
// And nothing at all while a walk is on the row: what is there is a whole candidate.
board.open_prompt();
type_line(&mut board, "co");
press_prompt(&mut board, KeyCode::Tab);
press_prompt(&mut board, KeyCode::Tab);
assert_eq!(prompt_line(&board), Some("comment"));
assert_eq!(board.suggestion(), None, "a second offer was drawn against a candidate");
}
/// The walk is over by the next keypress, so a candidate stepped onto is kept and the
/// next press starts a new one.
#[test]
fn an_edit_ends_the_walk_and_leaves_what_it_chose_on_the_row() {
let (_dir, mut board) = completable();
board.open_prompt();
type_line(&mut board, "ls d");
press_prompt(&mut board, KeyCode::Tab);
assert_eq!(prompt_line(&board), Some("ls done"));
// A backspace is an edit, so the next press walks the line as it now stands rather
// than stepping on from where the last one had got to.
press_prompt(&mut board, KeyCode::Backspace);
assert_eq!(prompt_line(&board), Some("ls don"));
press_prompt(&mut board, KeyCode::Tab);
assert_eq!(prompt_line(&board), Some("ls done"));
}
// ------------------------------------------------------------------ the copy key --
/// A sink that records what it was handed, standing in for the clipboard.