Load asdf completions #8837

filipegiusti · 2020-04-16T21:14:31Z

Standards checklist:

The PR title is descriptive.
The PR doesn't replicate another PR which is already open.
I have read the contribution guide and followed all the instructions.
The code follows the code style guide detailed in the wiki.
The code is mine or it's from somewhere with an MIT-compatible license.
The code is efficient, to the best of my ability, and does not waste computer resources.
The code is stable and I have tested it myself, to the best of my abilities.

Other comments:

May fix asdf-vm/asdf#692

It's a short term solution for #8779

Fix #8820

Tagging listed Maintainer of OMZ asdf plugin: @RobLoach

filipegiusti · 2020-04-16T21:17:15Z

@jthegedus may also be interested.

jthegedus · 2020-04-17T01:47:30Z

Thanks @filipegiusti I am indeed interested.

jthegedus · 2020-04-17T01:50:44Z

plugins/asdf/asdf.plugin.zsh

+    fpath=($ASDF_COMPLETIONS $fpath)
+    autoload -Uz compinit && compinit


This shouldn't be performed for any brew installed version of asdf as Homebrew has it's own setup for completions, which I believe I implemented in https://github.com/Homebrew/homebrew-core/blob/6e728e63ab37243b6832d2995e7efdbac7f0d612/Formula/asdf.rb#L25 (the correctness of my implementation needs to be validated).

~~I believe #L8 can be removed also as the Homebrew install should now handle the completions.~~

#L8 needs to be modified to conform to https://docs.brew.sh/Shell-Completion#configuring-completions-in-zsh

I'm not familiar with brew, so I may be completely wrong here.

The documentation suggest that FPATH=$(brew --prefix)/share/zsh/site-functions:$FPATH is needed to install all zsh completions when using brew, not just one plugin. ZSH brew plugin also doesn't do anything related to completions.

I think that your changes on brew formulae for asdf should sync link the _asdf file and as users of brew follow the instructions on https://docs.brew.sh/Shell-Completion#configuring-completions-in-zsh, it just work ®.

I made a few changes to not add the completion code on brew, however I can't test it on brew.

I have a suspicion that we should also be handling here different versions of asdf. Which asdf version added the zsh completion?

I can perform a test of brew tomorrow, though am also not particularly familiar.

0.7.6 was the last version this plugin properly supports.

0.7.8 added the ZSH completions properly.

jthegedus

This looks good to me for supporting asfd 0.7.8 and above. If backwards compatibility is required, then asdf 0.7.6 was the last version that relied upon the Bash completions

mcornella · 2020-05-05T18:47:51Z

Running compinit again in the plugin will cause duplicate work and slow down the startup significantly. My suggestion in #8779 (comment) was to change $fpath, then autoload the completion and compdef, something like this:

fpath=("$ASDF_DIR/completions" $fpath)
autoload -Uz _asdf
compdef _asdf asdf

That said, if the bash completion is present in all present asdf versions, the proper solution is to use it in conjunction with bashcompinit, which is already loaded by OMZ, so asdf-vm/asdf#692 shouldn't be an issue here.

I'm closing this then, in wait of new information.

jthegedus · 2020-05-06T03:38:47Z

@mcornella our goal with this plugin would be to use the ZSH completions and not rely on the bash completions. The confusion in that linked issue is people expecting this to load the ZSH completions with compinit, but getting the bash completions and not having the deps of our bash completions script.

Without the call to compinit in this plugin, would this work without users having to call compinit after they initialise OMZ and it's plugins? My understanding was compinit ran before any plugins and to get the effect we want we would need to run it again in the plugin here.

Quintasan · 2020-09-07T09:33:17Z

Soooooo this was closed and the only solution for now is to either source asdf completions BEFORE o-m-z without using the plugin or using the bash completions?

mcornella · 2020-09-07T09:48:56Z

As I said, the bash completion (which is perfectly functional) is present in all versions, unlike the zsh one. So it makes sense to keep it that way.

jthegedus · 2020-09-08T04:42:50Z

@Quintasan That's exactly what I do https://github.com/jthegedus/dotfiles/blob/c58a76734caa2d7bbba6acdeadcc439326dde0bb/dotfiles/.zshrc#L71

I agree not ideal.

@mcornella I feel

bash completion is present in all versions, unlike the zsh one

Is not a sound reason to avoid solving for ZSH native completions. The fact the Bash works and the compinit issues are a cause for headaches is a fair point though.

I hope there's a solution to this in the future, but until then I agree with @mcornella in using the Bash completions if you use this plugin.

digitalmoksha · 2021-02-03T17:29:38Z

Argh! This should work out of the box, I've already wasted an hour trying to get this to work

gaving · 2021-03-04T13:38:53Z

Came here from https://asdf-vm.com/#/core-manage-asdf

Confused 😵

I now have:-

autoload -U +X bashcompinit && bashcompinit
plugins=(
  asdf
  ....

To get things working.

TheTechRobo · 2021-03-04T14:04:30Z

@gaving The way I understand this PR is, you have to specifically load the PR in omz. Its not included by default.

Try omz pr test 8837 and see how that works. :nod:

jthegedus · 2021-03-04T22:09:32Z

@gaving what I suggest here - #8837 (comment) - is this:

fpath=($HOME/.asdf/completions $fpath)
plugins=(
	asdf
	...
)

The reason the documentation does not just say "Do X" is because there are many different ways to manage the ZSH completions depending on Shell manager (if one is used at all). You shouldn't need to run autoload etc with this OMZSH plugin as long as you include the Shell completions with fpath before the OMZSH plugins are listed.

Perhaps we should list each shell manager's instructions in the docs, though as solution in the plugin would be ideal, perhaps this PR can be modified to perform these suggestions #8837 (comment)

gaving · 2021-03-04T22:23:56Z

Ah thanks, thats much cleaner!

…

On Thu, 4 Mar 2021 at 22:09, James Hegedus ***@***.***> wrote: @gaving <https://github.com/gaving> try what I suggest here - #8837 (comment) <#8837 (comment)> The reason the documentation does not just say "Do X" is because there are many different ways to manage the ZSH completions depending on Shell setup. You shouldn't need to run autoload etc with this OMZSH plugin as long as you include the Shell completions with fpath before the OMZSH plugins are listed. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#8837 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAKVXOK64HF4AJFRNHCKW3TCAAKXANCNFSM4MKFUPIA> .

fxsalazar · 2021-03-25T12:39:35Z

I tried exactly #8837 (comment)

fpath=(${ASDF_DIR}/completions $fpath)
plugins=(
  asdf
)

source $ZSH/oh-my-zsh.sh

and still got the error .asdf/completions/asdf.bash:68: command not found: complete even when deleting the .zcompdump file. and restarting the terminal. Only solution was adding the autoload/compinit lines and removing the plugin.

Version:

asdf --version
v0.8.0-c6145d0

Use my own asdf loading snippet to work around ohmyzsh/ohmyzsh#8837

jthegedus · 2021-03-25T21:46:00Z

@fxsalazar Check if ASFD_DIR is populated at that point in your shell setup, I would wager it is not set and therefore the completions dir not being found properly

fxsalazar · 2021-03-26T11:48:27Z

fpath=(${ASDF_DIR}/completions $fpath)
plugins=(
  asdf
)

>> la .asdf/completions
total 40
-rwxr-xr-x  1  staff   6.2K Mar 25 12:42 _asdf
-rw-r--r--  1  staff   2.0K Mar 25 12:42 asdf.bash
-rw-r--r--  1  staff   6.9K Mar 25 12:42 asdf.fish
------------------------------------------------------------

Same result.

jthegedus · 2021-04-03T03:03:37Z

fpath=(${ASDF_DIR}/completions $fpath)
plugins=(
  asdf
)

>> la .asdf/completions
total 40
-rwxr-xr-x  1  staff   6.2K Mar 25 12:42 _asdf
-rw-r--r--  1  staff   2.0K Mar 25 12:42 asdf.bash
-rw-r--r--  1  staff   6.9K Mar 25 12:42 asdf.fish
------------------------------------------------------------

Same result.

What did you do differntly? If ASDF_DIR is not set before you use it in the fpath code then what you are doing is not going to work.

Also, you said

I tried exactly #8837 (comment)

But fpath=(${ASDF_DIR}/completions $fpath) != fpath=($HOME/.asdf/completions $fpath). Please try the exact code with $HOME and not $ASDF_DIR and report your result.

fxsalazar · 2021-04-03T13:05:55Z

fpath=($HOME/.asdf/completions $fpath)
plugins=(  
  asdf
)

source $ZSH/oh-my-zsh.sh

# . $HOME/.asdf/asdf.sh
# fpath=(${ASDF_DIR}/completions $fpath)
# autoload -Uz compinit && compinit

==>

# init terminal
Last login: Sat Apr  3 15:01:41 on ttys005
~/.asdf/completions/asdf.bash:68: command not found: complete

# asdf [tab]
~ » asdf _asdf:60: command not found: compgen

I did re-launch the terminal; cleaned the .zcomp* files.

relates to ohmyzsh/ohmyzsh#8837

devinrhode2 · 2022-12-20T20:35:31Z

@jthegedus do you know if the docs on asdf-vm.com are outdated or not?

jthegedus · 2022-12-20T20:55:28Z

@devinrhode2 The docs were written when this PR was pending, not closed. I am not a ZSH user so not sure if the issue has been resolved elsewhere or not. Happy to update the docs should that caveat no longer be the case.

devinrhode2 · 2022-12-20T21:02:32Z

Seems like it's still buggy in zgen

GraemeF · 2023-02-02T17:57:51Z

The completion is working fine for me (oh-my-zsh plugin on macos)

owpac · 2023-03-26T16:25:25Z

Hey guys!

The completions for ZSH is not yet supported by asdf plugin. I opened a PR here 6 months ago to resolve this. TBH, I'm not sure to perfectly understand all the issues around the ZSH completions problems. Is my PR resolving the issues? Is my PR not relevant?

iloveitaly · 2023-06-29T15:56:21Z

This is fixed in the asdf + direnv plugin redxtech/zsh-asdf-direnv#10

asadakbar · 2024-06-17T06:42:35Z

@carlosala Has this issue been corrected by your changes here 278bcfc? asdf is still referencing this issue in its zsh and git guide https://asdf-vm.com/guide/getting-started.html#_3-install-asdf.

carlosala · 2024-06-17T18:38:48Z

It should work, yes!

Load asdf completions

19f3550

ohmyzsh bot added the Area: plugin Issue or PR related to a plugin label Apr 16, 2020

jthegedus reviewed Apr 17, 2020

View reviewed changes

Only loads completion when not a brew installation

44c57d7

jthegedus approved these changes Apr 17, 2020

View reviewed changes

cewood mentioned this pull request Apr 18, 2020

Fix completions error for the asdf plugin #8820

Closed

7 tasks

Quintasan mentioned this pull request Apr 23, 2020

$HOME/.asdf/completions/asdf.bash:68: command not found: complete asdf-vm/asdf#692

Closed

mcornella closed this May 5, 2020

jthegedus mentioned this pull request Aug 21, 2020

Common Homebrew issues 🍻 asdf-vm/asdf#785

Closed

jthegedus mentioned this pull request Dec 29, 2020

docs: improve zsh completion directions for macOS,ZSH,Homebrew asdf-vm/asdf#843

Merged

kennethkalmer added a commit to kennethkalmer/dotfiles that referenced this pull request Mar 25, 2021

spacemacs 300 & asdf

9168c6e

Use my own asdf loading snippet to work around ohmyzsh/ohmyzsh#8837

rafaelsc04 mentioned this pull request Aug 6, 2021

docs: getting started translated pt-br asdf-vm/asdf#1019

Merged

loganlinn added a commit to loganlinn/dotfiles that referenced this pull request Sep 23, 2021

fix asdf completions

ddee0a1

relates to ohmyzsh/ohmyzsh#8837

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Load asdf completions #8837

Load asdf completions #8837

filipegiusti commented Apr 16, 2020

filipegiusti commented Apr 16, 2020

jthegedus commented Apr 17, 2020

jthegedus Apr 17, 2020 •

edited

Loading

jthegedus Apr 17, 2020 •

edited

Loading

filipegiusti Apr 17, 2020

filipegiusti Apr 17, 2020

filipegiusti Apr 17, 2020

jthegedus Apr 17, 2020

jthegedus left a comment

mcornella commented May 5, 2020

jthegedus commented May 6, 2020 •

edited

Loading

Quintasan commented Sep 7, 2020

mcornella commented Sep 7, 2020

jthegedus commented Sep 8, 2020

digitalmoksha commented Feb 3, 2021

gaving commented Mar 4, 2021

TheTechRobo commented Mar 4, 2021 •

edited by mcornella

Loading

jthegedus commented Mar 4, 2021 •

edited

Loading

gaving commented Mar 4, 2021 via email

fxsalazar commented Mar 25, 2021 •

edited

Loading

jthegedus commented Mar 25, 2021

fxsalazar commented Mar 26, 2021

jthegedus commented Apr 3, 2021

fxsalazar commented Apr 3, 2021 •

edited

Loading

devinrhode2 commented Dec 20, 2022

jthegedus commented Dec 20, 2022

devinrhode2 commented Dec 20, 2022

GraemeF commented Feb 2, 2023

owpac commented Mar 26, 2023

iloveitaly commented Jun 29, 2023

asadakbar commented Jun 17, 2024

carlosala commented Jun 17, 2024

		fpath=($ASDF_COMPLETIONS $fpath)
		autoload -Uz compinit && compinit

Load asdf completions #8837

Load asdf completions #8837

Conversation

filipegiusti commented Apr 16, 2020

Standards checklist:

Other comments:

filipegiusti commented Apr 16, 2020

jthegedus commented Apr 17, 2020

jthegedus Apr 17, 2020 • edited Loading

Choose a reason for hiding this comment

jthegedus Apr 17, 2020 • edited Loading

Choose a reason for hiding this comment

filipegiusti Apr 17, 2020

Choose a reason for hiding this comment

filipegiusti Apr 17, 2020

Choose a reason for hiding this comment

filipegiusti Apr 17, 2020

Choose a reason for hiding this comment

jthegedus Apr 17, 2020

Choose a reason for hiding this comment

jthegedus left a comment

Choose a reason for hiding this comment

mcornella commented May 5, 2020

jthegedus commented May 6, 2020 • edited Loading

Quintasan commented Sep 7, 2020

mcornella commented Sep 7, 2020

jthegedus commented Sep 8, 2020

digitalmoksha commented Feb 3, 2021

gaving commented Mar 4, 2021

TheTechRobo commented Mar 4, 2021 • edited by mcornella Loading

jthegedus commented Mar 4, 2021 • edited Loading

gaving commented Mar 4, 2021 via email

fxsalazar commented Mar 25, 2021 • edited Loading

jthegedus commented Mar 25, 2021

fxsalazar commented Mar 26, 2021

jthegedus commented Apr 3, 2021

fxsalazar commented Apr 3, 2021 • edited Loading

devinrhode2 commented Dec 20, 2022

jthegedus commented Dec 20, 2022

devinrhode2 commented Dec 20, 2022

GraemeF commented Feb 2, 2023

owpac commented Mar 26, 2023

iloveitaly commented Jun 29, 2023

asadakbar commented Jun 17, 2024

carlosala commented Jun 17, 2024

jthegedus Apr 17, 2020 •

edited

Loading

jthegedus Apr 17, 2020 •

edited

Loading

jthegedus commented May 6, 2020 •

edited

Loading

TheTechRobo commented Mar 4, 2021 •

edited by mcornella

Loading

jthegedus commented Mar 4, 2021 •

edited

Loading

fxsalazar commented Mar 25, 2021 •

edited

Loading

fxsalazar commented Apr 3, 2021 •

edited

Loading