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
fix: Don't complete _command on zsh #1690
Conversation
Previously the generated zsh completion script started with the line #compdef _<command> <command> where <command> is the command that the zsh completion script is generated for. This enabled completions for both <command> and _<command>, but _<command> is the completion function itself and should not be completed. Furthermore, attempting to autocomplete _<command> (e.g. typing "_<command><Space><Tab>" in a zsh shell) causes zsh to hang. This commit fixes the #compdef line to only complete <command>, not _<command>. Co-authored-by: Arvid Norlander <VorpalBlade@users.noreply.github.com>
Wow 🤯 In fact the first zsh PR for Cobra, #497, did use I'll run some tests to confirm, but this seems to be right. Thanks for bringing it back to us @twpayne ! |
Any updates on this? My local testing indicates that this PR fixes a genuine bug. |
I plan on getting to this one before the release to run a couple of tests before merging. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've tested this with zsh 5.9 and zsh 5.1 (to get a range of versions covered) using a modified completion script for helm and it does work to use #compdef helm
as the first line.
I've also look at a few completions script in https://github.com/zsh-users/zsh-completions/tree/master/src and do see that they all use the #compdef <program>
form.
Thanks again @twpayne .
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/golang-jwt/jwt/v4](https://togithub.com/golang-jwt/jwt) | require | patch | `v4.4.1` -> `v4.4.2` | | [github.com/spf13/cobra](https://togithub.com/spf13/cobra) | require | minor | `v1.4.0` -> `v1.5.0` | | [github.com/stretchr/testify](https://togithub.com/stretchr/testify) | require | patch | `v1.7.2` -> `v1.7.5` | --- ### Release Notes <details> <summary>golang-jwt/jwt</summary> ### [`v4.4.2`](https://togithub.com/golang-jwt/jwt/releases/tag/v4.4.2) [Compare Source](https://togithub.com/golang-jwt/jwt/compare/v4.4.1...v4.4.2) #### What's Changed - Added MicahParks/keyfunc to extensions by [@​oxisto](https://togithub.com/oxisto) in [golang-jwt/jwt#194 - Update link to v4 on pkg.go.dev page by [@​polRk](https://togithub.com/polRk) in [golang-jwt/jwt#195 - add installation guidelines to the README file by [@​morelmiles](https://togithub.com/morelmiles) in [golang-jwt/jwt#204 - chore: replace ioutil with io and os by [@​estensen](https://togithub.com/estensen) in [golang-jwt/jwt#198 - CI check for Go code formatting by [@​mfridman](https://togithub.com/mfridman) in [golang-jwt/jwt#206 - Create SECURITY.md by [@​mfridman](https://togithub.com/mfridman) in [golang-jwt/jwt#171 - Update SECURITY.md by [@​oxisto](https://togithub.com/oxisto) in [golang-jwt/jwt#207 - Fixed integer overflow in NumericDate.MarshalJSON by [@​qqiao](https://togithub.com/qqiao) in [golang-jwt/jwt#200 - Claims in rsa_test.go Table Driven Test are Unused by [@​gkech](https://togithub.com/gkech) in [golang-jwt/jwt#212 #### New Contributors - [@​polRk](https://togithub.com/polRk) made their first contribution in [golang-jwt/jwt#195 - [@​morelmiles](https://togithub.com/morelmiles) made their first contribution in [golang-jwt/jwt#204 - [@​estensen](https://togithub.com/estensen) made their first contribution in [golang-jwt/jwt#198 - [@​qqiao](https://togithub.com/qqiao) made their first contribution in [golang-jwt/jwt#200 - [@​gkech](https://togithub.com/gkech) made their first contribution in [golang-jwt/jwt#212 **Full Changelog**: golang-jwt/jwt@v4.4.1...v4.4.2 </details> <details> <summary>spf13/cobra</summary> ### [`v1.5.0`](https://togithub.com/spf13/cobra/releases/tag/v1.5.0) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.4.0...v1.5.0) #### Spring 2022 Release 🌥️ Hello everyone! Welcome to another release of cobra. Completions continue to get better and better. This release adds a few really cool new features. We also continue to patch versions of our dependencies as they become available via dependabot. Happy coding! #### Active help 👐🏼 Shout out to [@​marckhouzam](https://togithub.com/marckhouzam) for a big value add: Active Help [spf13/cobra#1482. With active help, a program can provide some inline warnings or hints for users as they hit tab. Now, your CLIs can be even more intuitive to use! Currently active help is only supported for bash V2 and zsh. Marc wrote a whole guide on how to do this, so make sure to give it a good read to learn how you can add this to your cobra code! https://github.com/spf13/cobra/blob/master/active_help.md #### Group flags 🧑🏼🤝🧑🏼 Cobra now has the ability to mark flags as required or exclusive as a ***group***. Shout out to our newest maintainer [@​johnSchnake](https://togithub.com/johnSchnake) for this! [spf13/cobra#1654 Let's say you have a `username` flag that ***MUST*** be partnered with a `password` flag. Well, now, you can enforce those as being required together: ```go rootCmd.Flags().StringVarP(&u, "username", "u", "", "Username (required if password is set)") rootCmd.Flags().StringVarP(&pw, "password", "p", "", "Password (required if username is set)") rootCmd.MarkFlagsRequiredTogether("username", "password") ``` Flags may also be marked as "mutally exclusive" with the `MarkFlagsMutuallyExclusive(string, string ... )` command API. Refer to our [user guide documentation](https://togithub.com/spf13/cobra/blob/master/user_guide.md) for further info! #### Completions 👀 - Add backwards-compatibility tests for legacyArgs() by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#1547 - feat: Add how to load completions in your current zsh session by [@​ondrejsika](https://togithub.com/ondrejsika) in [spf13/cobra#1608 - Introduce FixedCompletions by [@​emersion](https://togithub.com/emersion) in [spf13/cobra#1574 - Add shell completion to flag groups by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#1659 - Modify brew prefix path in macOS system by [@​imxw](https://togithub.com/imxw) in [spf13/cobra#1719 - perf(bash-v2): use backslash escape string expansion for tab by [@​scop](https://togithub.com/scop) in [spf13/cobra#1682 - style(bash-v2): out is not an array variable, do not refer to it as such by [@​scop](https://togithub.com/scop) in [spf13/cobra#1681 - perf(bash-v2): standard completion optimizations by [@​scop](https://togithub.com/scop) in [spf13/cobra#1683 - style(bash): out is not an array variable, do not refer to it as such by [@​scop](https://togithub.com/scop) in [spf13/cobra#1684 - perf(bash-v2): short-circuit descriptionless candidate lists by [@​scop](https://togithub.com/scop) in [spf13/cobra#1686 - perf(bash-v2): speed up filtering entries with descriptions by [@​scop](https://togithub.com/scop) in [spf13/cobra#1689 - perf(bash-v2): speed up filtering menu-complete descriptions by [@​scop](https://togithub.com/scop) in [spf13/cobra#1692 - fix(bash-v2): skip empty completions when filtering descriptions by [@​scop](https://togithub.com/scop) in [spf13/cobra#1691 - perf(bash-v2): read directly to COMPREPLY on descriptionless short circuit by [@​scop](https://togithub.com/scop) in [spf13/cobra#1700 - fix: Don't complete \_command on zsh by [@​twpayne](https://togithub.com/twpayne) in [spf13/cobra#1690 - Improve fish_completions code quality by [@​t29kida](https://togithub.com/t29kida) in [spf13/cobra#1515 - Fix handling of descriptions for bash v3 by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#1735 - undefined or nil Args default to ArbitraryArgs by [@​umarcor](https://togithub.com/umarcor) in [spf13/cobra#1612 - Add Command.SetContext by [@​joshcarp](https://togithub.com/joshcarp) in [spf13/cobra#1551 - Wrap printf tab with quotes by [@​PapaCharlie](https://togithub.com/PapaCharlie) in [spf13/cobra#1665 #### Documentation 📝 - Fixed typos in completions docs - [@​cuishuang](https://togithub.com/cuishuang) [spf13/cobra#1625 - Removed `CHANGELOG.md` as it isn't updated - [@​johnSchnake](https://togithub.com/johnSchnake) [spf13/cobra#1634 - Minor typo fix in `shell_completion.md` - [@​danieldn](https://togithub.com/danieldn) [spf13/cobra#1678 - Changed branch name in the cobra generator link to 'main' - [@​skywalker2909](https://togithub.com/skywalker2909) [spf13/cobra#1645 - Fix Command.Context comment by [@​katexochen](https://togithub.com/katexochen) in [spf13/cobra#1639 - Change appropriate links from http:// to https:// where applicable - [@​deining](https://togithub.com/deining) [spf13/cobra#1695 #### Testing & CI ⚙️ - Test on Golang 1.18 - [@​umarcor](https://togithub.com/umarcor) [spf13/cobra#1635 - Use `RICHGO_FORCE_COLOR` - [@​umarcor](https://togithub.com/umarcor) [spf13/cobra#1647 - Adds size labeler GitHub action by [@​jpmcb](https://togithub.com/jpmcb) in [spf13/cobra#1610 - Update `stale-bot` settings - [@​jpmcb](https://togithub.com/jpmcb) [spf13/cobra#1609 #### Beep boop, bot commits 🤖 - Bumped golangci/golangci-lint-action from 3.1.0 to 3.2.0 - [@​dependabot](https://togithub.com/dependabot) [spf13/cobra#1697 - Bump codelytv/pr-size-labeler from 1.8.0 to 1.8.1 - [@​dependabot](https://togithub.com/dependabot) [spf13/cobra#1661 - Bump actions/stale from 1 to 5 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1618 - Bump actions/cache from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1640 - Bump actions/labeler from 3 to 4 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1620 - Bump golangci/golangci-lint-action from 2 to 3.1.0 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1615 - Bump actions/checkout from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1619 - Bump github.com/cpuguy83/go-md2man/v2 from 2.0.1 to 2.0.2 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1688 - Bump actions/setup-go from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1660 #### Misc 💭 - Use `errors.Is()` to check for errors - [@​Luap99](https://togithub.com/Luap99) [spf13/cobra#1730 - Prefer ReplaceAll instead of Replace(..., -1) by [@​WhyNotHugo](https://togithub.com/WhyNotHugo) in [spf13/cobra#1530 - Add Kubescape to projects - [@​avinashupadhya99](https://togithub.com/avinashupadhya99) [spf13/cobra#1642 - Add Pulumi as a project using cobra by [@​iwahbe](https://togithub.com/iwahbe) in [spf13/cobra#1720 - Add Polygon Edge as a project using Cobra by [@​zivkovicmilos](https://togithub.com/zivkovicmilos) in [spf13/cobra#1672 Shoutout to *ALL* our contributors (and all the new first time contributors!!) - great work everyone!! Cobra and it's huge impact wouldn't be possible without you 👏🏼 🚀 🐍 **Full Changelog**: spf13/cobra@v1.4.0...v1.5.0 </details> <details> <summary>stretchr/testify</summary> ### [`v1.7.5`](https://togithub.com/stretchr/testify/compare/v1.7.4...v1.7.5) [Compare Source](https://togithub.com/stretchr/testify/compare/v1.7.4...v1.7.5) ### [`v1.7.4`](https://togithub.com/stretchr/testify/compare/v1.7.3...v1.7.4) [Compare Source](https://togithub.com/stretchr/testify/compare/v1.7.3...v1.7.4) ### [`v1.7.3`](https://togithub.com/stretchr/testify/compare/v1.7.2...v1.7.3) [Compare Source](https://togithub.com/stretchr/testify/compare/v1.7.2...v1.7.3) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 5am on Thursday" in timezone America/New_York, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.
…is#1128) [](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/spf13/cobra](https://togithub.com/spf13/cobra) | require | minor | `v1.4.0` -> `v1.5.0` | --- ### Release Notes <details> <summary>spf13/cobra</summary> ### [`v1.5.0`](https://togithub.com/spf13/cobra/releases/tag/v1.5.0) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.4.0...v1.5.0) #### Spring 2022 Release 🌥️ Hello everyone! Welcome to another release of cobra. Completions continue to get better and better. This release adds a few really cool new features. We also continue to patch versions of our dependencies as they become available via dependabot. Happy coding! #### Active help 👐🏼 Shout out to [@​marckhouzam](https://togithub.com/marckhouzam) for a big value add: Active Help [spf13/cobra#1482. With active help, a program can provide some inline warnings or hints for users as they hit tab. Now, your CLIs can be even more intuitive to use! Currently active help is only supported for bash V2 and zsh. Marc wrote a whole guide on how to do this, so make sure to give it a good read to learn how you can add this to your cobra code! https://github.com/spf13/cobra/blob/master/active_help.md #### Group flags 🧑🏼🤝🧑🏼 Cobra now has the ability to mark flags as required or exclusive as a ***group***. Shout out to our newest maintainer [@​johnSchnake](https://togithub.com/johnSchnake) for this! [spf13/cobra#1654 Let's say you have a `username` flag that ***MUST*** be partnered with a `password` flag. Well, now, you can enforce those as being required together: ```go rootCmd.Flags().StringVarP(&u, "username", "u", "", "Username (required if password is set)") rootCmd.Flags().StringVarP(&pw, "password", "p", "", "Password (required if username is set)") rootCmd.MarkFlagsRequiredTogether("username", "password") ``` Flags may also be marked as "mutally exclusive" with the `MarkFlagsMutuallyExclusive(string, string ... )` command API. Refer to our [user guide documentation](https://togithub.com/spf13/cobra/blob/master/user_guide.md) for further info! #### Completions 👀 - Add backwards-compatibility tests for legacyArgs() by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#1547 - feat: Add how to load completions in your current zsh session by [@​ondrejsika](https://togithub.com/ondrejsika) in [spf13/cobra#1608 - Introduce FixedCompletions by [@​emersion](https://togithub.com/emersion) in [spf13/cobra#1574 - Add shell completion to flag groups by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#1659 - Modify brew prefix path in macOS system by [@​imxw](https://togithub.com/imxw) in [spf13/cobra#1719 - perf(bash-v2): use backslash escape string expansion for tab by [@​scop](https://togithub.com/scop) in [spf13/cobra#1682 - style(bash-v2): out is not an array variable, do not refer to it as such by [@​scop](https://togithub.com/scop) in [spf13/cobra#1681 - perf(bash-v2): standard completion optimizations by [@​scop](https://togithub.com/scop) in [spf13/cobra#1683 - style(bash): out is not an array variable, do not refer to it as such by [@​scop](https://togithub.com/scop) in [spf13/cobra#1684 - perf(bash-v2): short-circuit descriptionless candidate lists by [@​scop](https://togithub.com/scop) in [spf13/cobra#1686 - perf(bash-v2): speed up filtering entries with descriptions by [@​scop](https://togithub.com/scop) in [spf13/cobra#1689 - perf(bash-v2): speed up filtering menu-complete descriptions by [@​scop](https://togithub.com/scop) in [spf13/cobra#1692 - fix(bash-v2): skip empty completions when filtering descriptions by [@​scop](https://togithub.com/scop) in [spf13/cobra#1691 - perf(bash-v2): read directly to COMPREPLY on descriptionless short circuit by [@​scop](https://togithub.com/scop) in [spf13/cobra#1700 - fix: Don't complete \_command on zsh by [@​twpayne](https://togithub.com/twpayne) in [spf13/cobra#1690 - Improve fish_completions code quality by [@​t29kida](https://togithub.com/t29kida) in [spf13/cobra#1515 - Fix handling of descriptions for bash v3 by [@​marckhouzam](https://togithub.com/marckhouzam) in [spf13/cobra#1735 - undefined or nil Args default to ArbitraryArgs by [@​umarcor](https://togithub.com/umarcor) in [spf13/cobra#1612 - Add Command.SetContext by [@​joshcarp](https://togithub.com/joshcarp) in [spf13/cobra#1551 - Wrap printf tab with quotes by [@​PapaCharlie](https://togithub.com/PapaCharlie) in [spf13/cobra#1665 #### Documentation 📝 - Fixed typos in completions docs - [@​cuishuang](https://togithub.com/cuishuang) [spf13/cobra#1625 - Removed `CHANGELOG.md` as it isn't updated - [@​johnSchnake](https://togithub.com/johnSchnake) [spf13/cobra#1634 - Minor typo fix in `shell_completion.md` - [@​danieldn](https://togithub.com/danieldn) [spf13/cobra#1678 - Changed branch name in the cobra generator link to 'main' - [@​skywalker2909](https://togithub.com/skywalker2909) [spf13/cobra#1645 - Fix Command.Context comment by [@​katexochen](https://togithub.com/katexochen) in [spf13/cobra#1639 - Change appropriate links from http:// to https:// where applicable - [@​deining](https://togithub.com/deining) [spf13/cobra#1695 #### Testing & CI ⚙️ - Test on Golang 1.18 - [@​umarcor](https://togithub.com/umarcor) [spf13/cobra#1635 - Use `RICHGO_FORCE_COLOR` - [@​umarcor](https://togithub.com/umarcor) [spf13/cobra#1647 - Adds size labeler GitHub action by [@​jpmcb](https://togithub.com/jpmcb) in [spf13/cobra#1610 - Update `stale-bot` settings - [@​jpmcb](https://togithub.com/jpmcb) [spf13/cobra#1609 #### Beep boop, bot commits 🤖 - Bumped golangci/golangci-lint-action from 3.1.0 to 3.2.0 - [@​dependabot](https://togithub.com/dependabot) [spf13/cobra#1697 - Bump codelytv/pr-size-labeler from 1.8.0 to 1.8.1 - [@​dependabot](https://togithub.com/dependabot) [spf13/cobra#1661 - Bump actions/stale from 1 to 5 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1618 - Bump actions/cache from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1640 - Bump actions/labeler from 3 to 4 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1620 - Bump golangci/golangci-lint-action from 2 to 3.1.0 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1615 - Bump actions/checkout from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1619 - Bump github.com/cpuguy83/go-md2man/v2 from 2.0.1 to 2.0.2 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1688 - Bump actions/setup-go from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [spf13/cobra#1660 #### Misc 💭 - Use `errors.Is()` to check for errors - [@​Luap99](https://togithub.com/Luap99) [spf13/cobra#1730 - Prefer ReplaceAll instead of Replace(..., -1) by [@​WhyNotHugo](https://togithub.com/WhyNotHugo) in [spf13/cobra#1530 - Add Kubescape to projects - [@​avinashupadhya99](https://togithub.com/avinashupadhya99) [spf13/cobra#1642 - Add Pulumi as a project using cobra by [@​iwahbe](https://togithub.com/iwahbe) in [spf13/cobra#1720 - Add Polygon Edge as a project using Cobra by [@​zivkovicmilos](https://togithub.com/zivkovicmilos) in [spf13/cobra#1672 Shoutout to *ALL* our contributors (and all the new first time contributors!!) - great work everyone!! Cobra and it's huge impact wouldn't be possible without you 👏🏼 🚀 🐍 **Full Changelog**: spf13/cobra@v1.4.0...v1.5.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/gapic-showcase).
Cobra v1.5.0 contains a fix for the zsh autocompletion #compdef line to only complete <command>, not _<command> (the completion function itself), see spf13/cobra#1690 TestNewCmdCompletion for zsh is updated accordingly.
* bump golang to 1.19 * bump dependencies * bump golangci-lint to v1.49.0 * fix lint errors * add nolintlint linter * fix nolint directives * make gen-markdown * adapt test to change from spf13/cobra#1690
This is required for all Zsh completions generated by spf13/cobra above version 1.15.0 (spf13/cobra#1690).
As reported by @VorpalBlade in twpayne/chezmoi#2047: Previously the generated zsh completion script started with the line #compdef _<command> <command> where \<command\> is the command that the zsh completion script is generated for. This enabled completions for both \<command> and _\<command>, but _\<command> is the completion function itself and should not be completed. Furthermore, attempting to autocomplete _<command> (e.g. typing "_\<command>\<Space>\<Tab>" in a zsh shell) causes zsh to hang. This commit fixes the #compdef line to only complete \<command>, not _\<command>. Co-authored-by: Arvid Norlander <VorpalBlade@users.noreply.github.com> Merge spf13/cobra#1690
This is required for all Zsh completions generated by spf13/cobra above version 1.15.0 (spf13/cobra#1690).
As reported by @VorpalBlade in twpayne/chezmoi#2047:
Previously the generated zsh completion script started with the line
where <command> is the command that the zsh completion script is generated for.
This enabled completions for both <command> and _<command>, but _<command> is the completion function itself and should not be completed. Furthermore, attempting to autocomplete (e.g. typing "<command><Space><Tab>" in a zsh shell) causes zsh to hang.
This commit fixes the #compdef line to only complete <command>, not _<command>.
Co-authored-by: Arvid Norlander VorpalBlade@users.noreply.github.com