Files
worklane/docs/completions.md
T

7.5 KiB

Shell Completions

The generated half, the fish half, and what keeps the two honest.

  • Two halves, and the split is the point. clap_complete generates the structure from the clap definition, so a new flag or subcommand is completed without anyone touching completions.rs. Only fish gets the second half, appended by fish_dynamic(), and it holds exactly what clap cannot know: the tickets on the board
  • The dynamic values come from worklane itself, as worklane ls --ids in a command substitution, one run per keypress at 2.5ms in release. So the completions are only as current as the binary on PATH: an older one without --ids completes nothing, which is a reinstall rather than a bug
  • What clap does and does not emit. It emits the possible values of an option, which is why mv --status <TAB> needs nothing here, and nothing for a positional, which is why the ls status and the completions shell are listed in the fish half. Both lists are read off the enums with possible_values, never written out, so a fifth status appears in the script on its own
  • Position is counted, not inferred. The four __worklane_* predicates all read $tokens[2] and the token count rather than using __fish_seen_subcommand_from, because campaign ls and campaign show are also an ls and a show that fish has seen, and because matching against the ticket list would run worklane again inside the condition. first_arg_of and second_arg_of count a top-level command's arguments, nested_arg_of matches a parent and a child so campaign show <TAB> can be told from chown alice <TAB>, which sit at the same token count, and command_is asks only which command this is, at any position in it
  • Every rule carrying -l needs a __worklane_command_is, and every_rule_naming_an_option_is_scoped_to_a_command is what enforces it. A bare complete -c worklane -l tag does not just complete that option's values, it tells fish the whole tool accepts --tag: worklane init --<TAB> offered six options that only relate and ls have. Fixed in 55ee6e3. __fish_seen_subcommand_from ls is not the scope to use, for the nesting reason above
  • 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
  • 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
  • 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
  • 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