summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBartek Iwańczuk <biwanczuk@gmail.com>2020-11-23 13:41:50 +0100
committerGitHub <noreply@github.com>2020-11-23 13:41:50 +0100
commit230a11e8a40fffffb2bdd4f705863183c52c45a9 (patch)
treec0465f51fe36c05151dc5d1935513cf964086193
parentfec7fdc691d02eeecb01fed51b4717abd4d79b6c (diff)
Revert "docs(cli): Fix documentation about usage of deno completions … (#8468)
This reverts commit 17d4cd92133bb822ff3a4f2f5bb32dfd17f99282.
-rw-r--r--cli/flags.rs18
-rw-r--r--docs/getting_started/setup_your_environment.md30
2 files changed, 26 insertions, 22 deletions
diff --git a/cli/flags.rs b/cli/flags.rs
index 62ba01854..761763627 100644
--- a/cli/flags.rs
+++ b/cli/flags.rs
@@ -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",
)
}
diff --git a/docs/getting_started/setup_your_environment.md b/docs/getting_started/setup_your_environment.md
index 0d320d446..0e31cd914 100644
--- a/docs/getting_started/setup_your_environment.md
+++ b/docs/getting_started/setup_your_environment.md
@@ -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