Dynamic completions wishlist

[senekor]

As dynamic completions are being worked on, let's use this issue to gather ideas for possible completions in one place. I'll try to keep the list in the issue description up to date according to the discussion below.

• [ ] #4737
• [ ] complete bookmark names wherever appropriate (jj bookmark, jj git)
• [ ] workspace names where appropriate
• [ ] Completion of aliases
  • [ ] make sure they are resolved for completion of further args
• [ ] Completion of revisions for all commands
  • [ ] Short change IDs will be used as candidates for completion.
  • [ ] Use description as help text.
  • [ ] Revisions completed are customized based on the given command:
  • [ ] commands which mutate the repository: revset mutable()
  • [ ] commands which do not mutate the repository: revset all()
  • [ ] jj squash --into: revset trunk()::@ as priority
  • [ ] There is a limit of 1000 changes shown.
  • [ ] Local and remote branches are also completed (they appear at the end of the list of
• [ ] Completion of files for certain commands
  • [ ] If the command uses a -r or --from flag, the list of files is read from the given revision.
  • [ ] Otherwise, the list of files are read from the given working copy.
  • [ ] file show, file chmod, interdiff: List of files in revision
  • [ ] commit: List of modified files in working copy
  • [ ] split, squash: List of modified files in revision
  • [ ] resolve: List of conflicted files in revision
  • [ ] restore, untrack: List of files in revision, or modified files if in working copy
• [ ] Completion of remote names for jj remote and jj git push
  • [ ] complete name of new remote with "origin" and "upstream"? opinionated, but probably useful.
  • [ ] git remote urls could be completed from ssh config and known_hosts
• [ ] Completion of operation IDs for jj undo and jj operation

open questions:

• [ ] Should we allow snapshotting of the working copy, so that e.g. jj commit/squash/split <TAB> works without having to run another jj command first? places to scrape for ideas and implementation:

places to scrape for ideas and implementations:

• [x] our wiki where manually written dynamic completions for specific shells have been shared, e.g. here
• [ ] completions of git

[bnjmnt4n]

Here's the features that I implemented for my custom Fish completions:

• Completion of aliases
• Completion of revisions for all commands
  • Short change IDs will be used as candidates for completion.
  • Revisions completed are customized based on the given command. Commands which mutate the repository will use the revset mutable() to get the list of completed revisions, while commands which do not mutate the repository will use the revset all().
  • There is a limit of 1000 changes shown.
  • Local and remote branches are also completed (they appear at the end of the list of completions).
• Completion of files for certain commands
  • If the command uses a -r or --from flag, the list of files is read from the given revision.
  • Otherwise, the list of files are read from the given working copy.
  • file show, file chmod, interdiff: List of files in revision
  • commit: List of modified files in working copy
  • split, squash: List of modified files in revision
  • resolve: List of conflicted files in revision
  • restore, untrack: List of files in revision, or modified files if in working copy
  • TODO: Should we allow snapshotting of the working copy, so that e.g. jj commit/squash/split <TAB> works without having to run another jj command first?
• Completion of bookmark names for jj bookmark and jj git
• Completion of remote names for jj remote and jj git push
• Completion of operation IDs for jj undo and jj operation

[senekor]

Awesome, thank you so much!

Otherwise, the list of files are read from the given working copy.

Is this different from telling the shell to use its built-in file path completion? clap has some specific hints that don't require dynamic completions. I guess the difference would be the inclusion of gitignored files?

Should we allow snapshotting of the working copy, so that e.g. jj commit/squash/split works without having to run another jj command first?

I have currently disabled it in my PR. We could allow it for those commands specifically, so we don't incur the performance overhead on commands where it doesn't matter. I have never tried it, but there is the file watcher option for snapshotting too, right? So if users run into performance problems, they could solve it for themselves that way.

[bnjmnt4n]

Otherwise, the list of files are read from the given working copy.

Is this different from telling the shell to use its built-in file path completion? clap has some specific hints that don't require dynamic completions. I guess the difference would be the inclusion of gitignored files?

To clarify, here's the full original statement:

• If the command uses a -r or --from flag, the list of files is read from the given revision.
• Otherwise, the list of files are read from the given working copy.

This will allow file completion of paths at a different revision e.g. jj restore --from XXX file[TAB] can provide a completion if the file doesn't exist in the current working directory but exists in the given revision. Additionally, jj also permits sparse working copies which means that a file might not be checked out in the working directory, but it will still be helpful to do e.g. jj file show file[TAB].

[senekor]

Aah, I didn't think about sparse checkouts, that makes sense!