kevin/asdf
1
Fork 0
mirror of https://github.com/asdf-vm/asdf.git synced 2024-11-15 01:28:17 -07:00
Code Issues Packages Projects Releases Wiki Activity

fix: remove automatic compinit (#678)

Browse Source 
* fix: remove automatic compinit

Raised by concerns in https://github.com/asdf-vm/asdf/issues/674 about performance implications and unexpected intrusive behaviour

* docs: fix ZSH compinit recommendations

* docs: clarify zsh completions further

* docs: fpath steps and notes on framework plugins

* docs: be verbose in explanation

* fix: remove fpath & compinit calls
This commit is contained in:
James Hegedus 2020-03-19 20:37:25 +00:00 committed by GitHub
parent a15cb5bccb
commit 3246c26d52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
asdf.sh
View File

@ -31,9 +31,3 @@ PATH="${ASDF_USER_SHIMS}:$PATH"
# shellcheck source=lib/asdf.sh
# Load the asdf wrapper function
. "${ASDF_DIR}/lib/asdf.sh"
if [ -n "${ZSH_VERSION:-}" ]; then
fpath=(${ASDF_DIR}/completions $fpath)
autoload -Uz compinit
compinit
fi

30
docs/core-manage-asdf-vm.md
View File

@ -76,26 +76,36 @@ echo -e "\n. $(brew --prefix asdf)/etc/bash_completion.d/asdf.bash" >> ~/.bash_p
Installation via **Git**:
```shell
echo -e '\n. $HOME/.asdf/asdf.sh' >> ~/.zshrc
```
?>If you are using a framework, such as [oh-my-zsh](https://ohmyz.sh/), these lines remain _below_ the line
where you source your framework.)
!>If you are not using a framework, or if on starting your shell you get an error message like `command not found: compinit`, then add the below line before the ones above.
Source the `asdf.sh` script in your shell config:
```shell
autoload -Uz compinit && compinit
echo -e "\n. $HOME/.asdf/asdf.sh" >> ~/.zshrc
```
or use a framework plugin like [asdf for oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/asdf) which will source this init script and setup completions.
ZSH Completions:
asdf ships with ZSH completions which will need to be setup if you're not using a ZSH framework plugin that does this for you. Add the following to your `.zshrc`:
```shell
# append completions to fpath
echo -e "\nfpath=(${ASDF_DIR}/completions $fpath)" >> ~/.zshrc
# initialise completions with ZSH's compinit
echo -e "\nautoload -Uz compinit && compinit" >> ~/.zshrc
```
- if you are using a custom `compinit` setup, ensure `compinit` is below your sourcing of `asdf.sh`
- if you are using a custom `compinit` setup with a ZSH framework, ensure `compinit` is below your sourcing of the framework
- if you are using a ZSH framework with an asdf plugin, then you shouldn't need to manually add `fpath`, the plugin may need to be updated to use the new ZSH completions properly
Installation via **Homebrew**:
```shell
echo -e "\n. $(brew --prefix asdf)/asdf.sh" >> ~/.zshrc
```
?> ASDF automatically adds it's completions to the function path (`$fpath`). This may clash with Homebrew's ZSH completions. See [Configuring Completions in ZSH](https://docs.brew.sh/Shell-Completion#configuring-completions-in-zsh) in the Homebrew docs.
Shell completions should automatically be installed and available.
#### ** Fish **