foster/deno
0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-03-03 09:31:22 -05:00
Code Issues Packages 1 Wiki Activity

docs(cli): Fix documentation about usage of deno completions script (#8369)

Browse source 
Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
This commit is contained in:
Mayank Agarwal 2020-11-22 20:59:22 +05:30 • committed by GitHub
parent 750f179aeb
commit 17d4cd9213
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
cli/flags.rs
View file

@ -814,8 +814,22 @@ fn completions_subcommand<'a, 'b>() -> App<'a, 'b> {
.about("Generate shell completions")
.long_about(
"Output shell completion script to standard output.
deno completions bash > /usr/local/etc/bash_completion.d/deno.bash
source /usr/local/etc/bash_completion.d/deno.bash",
bash:
deno completions bash | sudo tee /etc/bash_completion.d/deno.bash > /dev/null
source /etc/bash_completion.d/deno.bash
zsh:
deno completions zsh |sudo tee /usr/local/share/zsh/site-functions/_deno
Make sure to run compinit after the above command
fish:
deno completions fish > ~/.config/fish/completions/deno.fish
powershell:
deno completions powershell > $profile
.$profile",
)
}

32
docs/getting_started/setup_your_environment.md
View file

@ -32,43 +32,25 @@ The supported shells are:
Example (bash):
```shell
deno completions bash > /usr/local/etc/bash_completion.d/deno.bash
source /usr/local/etc/bash_completion.d/deno.bash
deno completions bash | sudo tee /etc/bash_completion.d/deno.bash > /dev/null
source /etc/bash_completion.d/deno.bash
```
Example (zsh without framework):
Example (zsh):
```shell
mkdir ~/.zsh # create a folder to save your completions. it can be anywhere
deno completions zsh > ~/.zsh/_deno
deno completions zsh | sudo tee /usr/local/share/zsh/site-functions/_deno
```
then add this to your `.zshrc`
Example (fish):
```shell
fpath=(~/.zsh $fpath)
autoload -Uz compinit
compinit -u
deno completions fish > ~/.config/fish/completions/deno.fish
```
and restart your terminal. note that if completions are still not loading, you
may need to run `rm ~/.zcompdump/` to remove previously generated completions
and then `compinit` to generate them again.
Example (zsh + oh-my-zsh) [recommended for zsh users] :
```shell
mkdir ~/.oh-my-zsh/custom/plugins/deno
deno completions zsh > ~/.oh-my-zsh/custom/plugins/deno/_deno
```
After this add deno plugin under plugins tag in `~/.zshrc` file. for tools like
`antigen` path will be `~/.antigen/bundles/robbyrussell/oh-my-zsh/plugins` and
command will be `antigen bundle deno` and so on.
Example (Powershell):
```shel
```shell
deno completions powershell > $profile
.$profile
```