Don't recommend saving shell completions to disk #782
Conversation
|
Validated updated instructions with |
Currently our docs advise users of several shells to save the output of `oxide completion` to a file and source that in their init. This has led to users having outdated completions when they upgrade to a new version of the CLI. Update the docs to recommend generating the completions on the fly at startup. Doing this will add a bit of latency to their shell startup, but user instructions should prioritize reliability over performance.
wfchandler
force-pushed
the
wc/update-completion-doc
branch
from
185be59
to
3933f43
Compare
|
@david-crespo it's a bit slower than that, since the shell needs to evaluate the generated text: $ hyperfine 'zsh -c eval "$(oxide completion -s zsh)"'
Benchmark 1: zsh -c eval "$(oxide completion -s zsh)"
Time (mean ± σ): 32.7 ms ± 0.7 ms [User: 12.5 ms, System: 5.0 ms]
Range (min … max): 31.6 ms … 35.4 ms 85 runs |
|
Eagerly awaiting the M4 MBPs 
|
| @@ -27,26 +27,20 @@ use std::io; | |||
| /// | |||
There was a problem hiding this comment.
I don't get why this isn't working for me on macos:
$ eval $(./target/debug/oxide completion --shell bash)
-bash: syntax error near unexpected token `)'
$ ./target/debug/oxide completion --shell bash > foo
$ . foo
# works fineThere was a problem hiding this comment.
try quotes around the $()?
Edit: yep this makes it not error out
There was a problem hiding this comment.
also the default shell on mac is zsh
There was a problem hiding this comment.
Confirmed that error is due to lack of quotes.
bash-5.2$ eval $(./target/debug/oxide completion -s bash)
bash: syntax error near unexpected token `)'
bash-5.2$ eval "$(./target/debug/oxide completion -s bash)"
bash-5.2$ echo $?
0| /// ``` | ||
| /// | ||
| /// and check that you have the following lines in your `~/.zshrc`: | ||
| /// Add this to your `~/.zshrc`: | ||
| /// | ||
| /// ```sh |
There was a problem hiding this comment.
these ```sh are in the console output for oxide completion --help -- we don't have to change that now, but that seems kind of lousy to me -- what do you think?
There was a problem hiding this comment.
If we wanted to be really cool we could render the markdown
Currently our docs advise users of several shells to save the output of
oxide completionto a file and source that in their init. This has led to users having outdated completions when they upgrade to a new version of the CLI.Update the docs to recommend generating the completions on the fly at startup. Doing this will add a bit of latency to their shell startup, but user instructions should prioritize reliability over performance.