Skip to content

Fix command completion for zsh #1055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 27, 2023
Merged

Conversation

terabyte128
Copy link
Contributor

zsh only reads the first line of a file when searching for #compdef lines. The completion script added a comment above this line and caused zsh autocomplete to fail.

https://zsh.sourceforge.io/Doc/Release/Completion-System.html

Name of feature

bugfix for zsh completion

Pain or issue this feature alleviates:

zsh autocompletion didn't work before

Why is this important to the project (if not answered above):

Is there documentation on how to use this feature? If so, where?

yes, already exists

In what environments or workflows is this feature supported?

anyone using zsh

In what environments or workflows is this feature explicitly NOT supported (if any)?

n/a

Supporting links/other PRs/issues:

https://zsh.sourceforge.io/Doc/Release/Completion-System.html

When compinit is run, it searches all such files accessible via fpath/FPATH and reads the first line of each of them. This line should contain one of the tags described below. Files whose first line does not start with one of these tags are not considered to be part of the completion system and will not be treated specially.

💔Thank you!

@CLAassistant
Copy link

CLAassistant commented Oct 27, 2023

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the needs triage Waiting for discussion / prioritization by team label Oct 27, 2023
zsh only reads the first line of a file when searching for `#compdef`
lines. The completion script added a comment above this line and caused
zsh autocomplete to fail.

https://zsh.sourceforge.io/Doc/Release/Completion-System.html
Copy link
Collaborator

@maraino maraino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @terabyte128.

@maraino maraino merged commit bf32ddf into smallstep:master Oct 27, 2023
@hslatman hslatman added this to the v0.25.1 milestone Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage Waiting for discussion / prioritization by team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants