Skip to content

Commit

Permalink
Revert "docs(cli): Fix documentation about usage of deno completions … (
Browse files Browse the repository at this point in the history
denoland#8468)

This reverts commit 17d4cd9.
  • Loading branch information
bartlomieju committed Nov 23, 2020
1 parent fec7fdc commit 230a11e
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 22 deletions.
18 changes: 2 additions & 16 deletions cli/flags.rs
Original file line number Diff line number Diff line change
Expand Up @@ -819,22 +819,8 @@ fn completions_subcommand<'a, 'b>() -> App<'a, 'b> {
.about("Generate shell completions")
.long_about(
"Output shell completion script to standard output.
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",
deno completions bash > /usr/local/etc/bash_completion.d/deno.bash
source /usr/local/etc/bash_completion.d/deno.bash",
)
}

Expand Down
30 changes: 24 additions & 6 deletions docs/getting_started/setup_your_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,40 @@ The supported shells are:
Example (bash):

```shell
deno completions bash | sudo tee /etc/bash_completion.d/deno.bash > /dev/null
source /etc/bash_completion.d/deno.bash
deno completions bash > /usr/local/etc/bash_completion.d/deno.bash
source /usr/local/etc/bash_completion.d/deno.bash
```

Example (zsh):
Example (zsh without framework):

```shell
deno completions zsh | sudo tee /usr/local/share/zsh/site-functions/_deno
mkdir ~/.zsh # create a folder to save your completions. it can be anywhere
deno completions zsh > ~/.zsh/_deno
```

Example (fish):
then add this to your `.zshrc`

```shell
deno completions fish > ~/.config/fish/completions/deno.fish
fpath=(~/.zsh $fpath)
autoload -Uz compinit
compinit -u
```

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):

```shell
Expand Down

0 comments on commit 230a11e

Please sign in to comment.