Add completion

[baptistemehat]

Investigate how to add completion to the app for completing:

• forest subcommands
• tree and task names

[baptistemehat]

For zsh completion https://github.com/git/git/blob/master/contrib/completion/git-completion.zsh https://github.com/zsh-users/zsh-completions/blob/master/zsh-completions-howto.org https://github.com/zsh-users/zsh/blob/master/Etc/completion-style-guide

[baptistemehat]

Status

clap enables developpers to generate static completions at build time such as

forest <tab> 
task tree note switch ...

but for now, it does not provide ant way to generate dynamic completion functions (ie, retrieving task and note ids for completion) at build time:

forest note edit <tab>
099cc8   #my note
922aaf   # another note
...

What to do

From there I see two options:

• create a custom comletion for bash and zsh that completes the dynamic arguments (task uids, tree names, note uids, etc.)
• add a _complete command to forest and call it from the completion script. This command would perform all the completion for us

[baptistemehat]

Here is what just does:

• just --completion generates the completion for all shells, and some parts of the completion scripts get modified by the --completions command to add dynamic completion in raw bash|zsh|fish|...
  • https://github.com/casey/just/blob/28c4e9a13c20c9ce14e7eb72a52ac2f34f058a4e/.github/workflows/release.yaml#L97
  • https://github.com/casey/just/blob/28c4e9a13c20c9ce14e7eb72a52ac2f34f058a4e/src/completions.rs
• completion files are installed from the deb package
  • https://packages.debian.org/trixie/amd64/just/filelist

[baptistemehat]

Plan

For now, add the basic static buildtime-generated completions alongside the binary. Dynamic completion can wait.