perf(bash-v2): standard completion optimizations #1683
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
(Test suite fix is #1684.) |
Refactor to remove two loops over the entire list of candidates. Format descriptions only for completions that are actually going to be displayed, instead of for all candidates. Format descriptions inline in completions array, removing need for a command substitution/subshell and a printf escape per displayed completion.
scop
force-pushed
the
perf/bash-v2-improvements
branch
from
0ff4078
to
94850da
Compare
|
(Force-pushed just to generalize the commit message some.) |
|
Thanks @scop ! I will have a look over the weekend. |
This was referenced Apr 30, 2022
scop
commented
Apr 30, 2022
| # Strip any description before checking the length | ||
| comp=${comp%%%%$tab*} | ||
| comp=${compline%%$tab*} | ||
| # Only consider the completions that match | ||
| comp=$(compgen -W "$comp" -- "$cur") |
There was a problem hiding this comment.
Doing this for every candidate separately would be something to look into getting rid of next, but I suggest we postpone looking into it as far as this PR is concerned and not get delayed because of it here.
marckhouzam
requested changes
Apr 30, 2022
|
Thanks! Addressed. Quite a bit more care would have been required for the method I used to do make the submitted change. Will have a look at the other open PR if it had similar issues. |
marckhouzam
reviewed
May 2, 2022
marckhouzam
reviewed
May 2, 2022
marckhouzam
approved these changes
May 3, 2022
There was a problem hiding this comment.
This is great!
The https://github.com/marckhouzam/cobra-completion-testing tests pass and we can see a nice improvement in speed using marckhouzam/cobra-completion-testing#15. On my machine I see :
- 1000 completions without descriptions 2.688s sec on master -> 1.073 sec with the PR
- 1000 completions with descriptions 2.965s sec on master -> 1.245 sec with the PR
The helm completion tests also pass and I did some manual testing too.
Excellent work @scop, thank you!
I will go ahead and merge to continue working on the other speed improvements.
Closed
gcf-merge-on-green bot
referenced
this pull request
in renovate-bot/gapic-showcase
Jun 27, 2022
…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 [https://github.com/spf13/cobra/pull/1482](https://togithub.com/spf13/cobra/pull/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! [https://github.com/spf13/cobra/pull/1654](https://togithub.com/spf13/cobra/pull/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 [https://github.com/spf13/cobra/pull/1547](https://togithub.com/spf13/cobra/pull/1547) - feat: Add how to load completions in your current zsh session by [@​ondrejsika](https://togithub.com/ondrejsika) in [https://github.com/spf13/cobra/pull/1608](https://togithub.com/spf13/cobra/pull/1608) - Introduce FixedCompletions by [@​emersion](https://togithub.com/emersion) in [https://github.com/spf13/cobra/pull/1574](https://togithub.com/spf13/cobra/pull/1574) - Add shell completion to flag groups by [@​marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/1659](https://togithub.com/spf13/cobra/pull/1659) - Modify brew prefix path in macOS system by [@​imxw](https://togithub.com/imxw) in [https://github.com/spf13/cobra/pull/1719](https://togithub.com/spf13/cobra/pull/1719) - perf(bash-v2): use backslash escape string expansion for tab by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1682](https://togithub.com/spf13/cobra/pull/1682) - style(bash-v2): out is not an array variable, do not refer to it as such by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1681](https://togithub.com/spf13/cobra/pull/1681) - perf(bash-v2): standard completion optimizations by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1683](https://togithub.com/spf13/cobra/pull/1683) - style(bash): out is not an array variable, do not refer to it as such by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1684](https://togithub.com/spf13/cobra/pull/1684) - perf(bash-v2): short-circuit descriptionless candidate lists by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1686](https://togithub.com/spf13/cobra/pull/1686) - perf(bash-v2): speed up filtering entries with descriptions by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1689](https://togithub.com/spf13/cobra/pull/1689) - perf(bash-v2): speed up filtering menu-complete descriptions by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1692](https://togithub.com/spf13/cobra/pull/1692) - fix(bash-v2): skip empty completions when filtering descriptions by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1691](https://togithub.com/spf13/cobra/pull/1691) - perf(bash-v2): read directly to COMPREPLY on descriptionless short circuit by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1700](https://togithub.com/spf13/cobra/pull/1700) - fix: Don't complete \_command on zsh by [@​twpayne](https://togithub.com/twpayne) in [https://github.com/spf13/cobra/pull/1690](https://togithub.com/spf13/cobra/pull/1690) - Improve fish_completions code quality by [@​t29kida](https://togithub.com/t29kida) in [https://github.com/spf13/cobra/pull/1515](https://togithub.com/spf13/cobra/pull/1515) - Fix handling of descriptions for bash v3 by [@​marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/1735](https://togithub.com/spf13/cobra/pull/1735) - undefined or nil Args default to ArbitraryArgs by [@​umarcor](https://togithub.com/umarcor) in [https://github.com/spf13/cobra/pull/1612](https://togithub.com/spf13/cobra/pull/1612) - Add Command.SetContext by [@​joshcarp](https://togithub.com/joshcarp) in [https://github.com/spf13/cobra/pull/1551](https://togithub.com/spf13/cobra/pull/1551) - Wrap printf tab with quotes by [@​PapaCharlie](https://togithub.com/PapaCharlie) in [https://github.com/spf13/cobra/pull/1665](https://togithub.com/spf13/cobra/pull/1665) #### Documentation 📝 - Fixed typos in completions docs - [@​cuishuang](https://togithub.com/cuishuang) [https://github.com/spf13/cobra/pull/1625](https://togithub.com/spf13/cobra/pull/1625) - Removed `CHANGELOG.md` as it isn't updated - [@​johnSchnake](https://togithub.com/johnSchnake) [https://github.com/spf13/cobra/pull/1634](https://togithub.com/spf13/cobra/pull/1634) - Minor typo fix in `shell_completion.md` - [@​danieldn](https://togithub.com/danieldn) [https://github.com/spf13/cobra/pull/1678](https://togithub.com/spf13/cobra/pull/1678) - Changed branch name in the cobra generator link to 'main' - [@​skywalker2909](https://togithub.com/skywalker2909) [https://github.com/spf13/cobra/pull/1645](https://togithub.com/spf13/cobra/pull/1645) - Fix Command.Context comment by [@​katexochen](https://togithub.com/katexochen) in [https://github.com/spf13/cobra/pull/1639](https://togithub.com/spf13/cobra/pull/1639) - Change appropriate links from http:// to https:// where applicable - [@​deining](https://togithub.com/deining) [https://github.com/spf13/cobra/pull/1695](https://togithub.com/spf13/cobra/pull/1695) #### Testing & CI ⚙️ - Test on Golang 1.18 - [@​umarcor](https://togithub.com/umarcor) [https://github.com/spf13/cobra/pull/1635](https://togithub.com/spf13/cobra/pull/1635) - Use `RICHGO_FORCE_COLOR` - [@​umarcor](https://togithub.com/umarcor) [https://github.com/spf13/cobra/pull/1647](https://togithub.com/spf13/cobra/pull/1647) - Adds size labeler GitHub action by [@​jpmcb](https://togithub.com/jpmcb) in [https://github.com/spf13/cobra/pull/1610](https://togithub.com/spf13/cobra/pull/1610) - Update `stale-bot` settings - [@​jpmcb](https://togithub.com/jpmcb) [https://github.com/spf13/cobra/pull/1609](https://togithub.com/spf13/cobra/pull/1609) #### Beep boop, bot commits 🤖 - Bumped golangci/golangci-lint-action from 3.1.0 to 3.2.0 - [@​dependabot](https://togithub.com/dependabot) [https://github.com/spf13/cobra/pull/1697](https://togithub.com/spf13/cobra/pull/1697) - Bump codelytv/pr-size-labeler from 1.8.0 to 1.8.1 - [@​dependabot](https://togithub.com/dependabot) [https://github.com/spf13/cobra/pull/1661](https://togithub.com/spf13/cobra/pull/1661) - Bump actions/stale from 1 to 5 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1618](https://togithub.com/spf13/cobra/pull/1618) - Bump actions/cache from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1640](https://togithub.com/spf13/cobra/pull/1640) - Bump actions/labeler from 3 to 4 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1620](https://togithub.com/spf13/cobra/pull/1620) - Bump golangci/golangci-lint-action from 2 to 3.1.0 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1615](https://togithub.com/spf13/cobra/pull/1615) - Bump actions/checkout from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1619](https://togithub.com/spf13/cobra/pull/1619) - Bump github.com/cpuguy83/go-md2man/v2 from 2.0.1 to 2.0.2 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1688](https://togithub.com/spf13/cobra/pull/1688) - Bump actions/setup-go from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1660](https://togithub.com/spf13/cobra/pull/1660) #### Misc 💭 - Use `errors.Is()` to check for errors - [@​Luap99](https://togithub.com/Luap99) [https://github.com/spf13/cobra/pull/1730](https://togithub.com/spf13/cobra/pull/1730) - Prefer ReplaceAll instead of Replace(..., -1) by [@​WhyNotHugo](https://togithub.com/WhyNotHugo) in [https://github.com/spf13/cobra/pull/1530](https://togithub.com/spf13/cobra/pull/1530) - Add Kubescape to projects - [@​avinashupadhya99](https://togithub.com/avinashupadhya99) [https://github.com/spf13/cobra/pull/1642](https://togithub.com/spf13/cobra/pull/1642) - Add Pulumi as a project using cobra by [@​iwahbe](https://togithub.com/iwahbe) in [https://github.com/spf13/cobra/pull/1720](https://togithub.com/spf13/cobra/pull/1720) - Add Polygon Edge as a project using Cobra by [@​zivkovicmilos](https://togithub.com/zivkovicmilos) in [https://github.com/spf13/cobra/pull/1672](https://togithub.com/spf13/cobra/pull/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).
hoshsadiq
pushed a commit
to zulucmd/zulu
that referenced
this pull request
Dec 31, 2022
style(bash-v2): out is not an array variable, do not refer to it as such Even though this to my surprise works, it doesn't accomplish anything but some confusion. Remove it. Merge spf13/cobra#1681 --- perf(bash-v2): use backslash escape string expansion for tab Using a command substitution, i.e. a subshell, with `printf` is expensive for this purpose. For example `__*_format_comp_descriptions` is run once for each completion candidate; the expense adds up and shows when there are a lot of them. This shaves off roughly 25% of the times I receive for my test case in #1680 (~2 seconds before, ~1.5 after). Merge spf13/cobra#1682 --- perf(bash-v2): standard completion optimizations Refactor to remove two loops over the entire list of candidates. Format descriptions only for completions that are actually going to be displayed, instead of for all candidates. Format descriptions inline in completions array, removing need for a command substitution/subshell and a printf escape per displayed completion. These changes shave off a second or so from my case at hand in #1680, it was roughly ~1.7s before, is now ~0.7s after. The diff is largish, but the bulk of it is in `__%[1]s_format_comp_descriptions` due to indentation changes, there aren't that many lines actually changed in it either. `git show -w` helps with the review. Caveat: I have not actually tested generating completions with this code. I worked on the improvements by tweaking an existing emitted completion shell file, then manually ported the changes to the template in Go code here. Hopefully I didn't introduce bugs while doing that. (The code compiles, and test suite fails just like it did before this change, no regressions noticed.) Merge spf13/cobra#1683 --- perf(bash-v2): short-circuit descriptionless candidate lists If the list of candidates has no descriptions, short circuit all the description processing logic, basically just do a `compgen -W` for the whole list and be done with it. We could conceivably do some optimizations like this and more when generating the completions with `--no-descriptions` in Go code, by omitting some parts we know won't be needed, or doing some things differently. But doing it this way in bash, the improvements are available also to completions generated with descriptions enabled when they are invoked for completion cases that produce no descriptions. The result after this for descriptionless entries seems fast enough so it seems there's no immediate need to look into doing that. This alone pretty much eliminates all the slowness related to my specific use case in #1680, bringing it down to ~0.07s (yes, there _is_ a zero on the right of the period), so for the time being I'm not inclined to look into further optimizations at least for the code path where there are no descriptions. Related to #1683, but I suggest merging both as they affect different scenarios. Same caveat as in #1683 about testing and the way the change was made applies here. Merge spf13/cobra#1686 --- perf(bash-v2): speed up filtering entries with descriptions Use simple prefix match instead of single word `compgen -W` command substitution for each candidate match. It's a bit late, but I can't think of a case where this replacement wouldn't be ok this late at night. Performancewise this improves the cases with descriptions quite a bit, with current marckhouzam/cobra-completion-testing#15 on my box, the v2 numbers look like the following (I've stripped the v1 numbers from each list below). Before (current master, #1686 not merged yet): ``` Processing 1000 completions took 0.492 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.600 seconds which is less than the 2.0 seconds limit Processing 1000 completions took 0.455 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.578 seconds which is less than the 2.0 seconds limit Processing 1000 completions took 0.424 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.570 seconds which is less than the 2.0 seconds limit Processing 1000 completions took 0.502 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.585 seconds which is less than the 2.0 seconds limit ``` After (also without #1686): ``` Processing 1000 completions took 0.070 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.165 seconds which is less than the 2.0 seconds limit Processing 1000 completions took 0.072 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.181 seconds which is less than the 2.0 seconds limit Processing 1000 completions took 0.089 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.254 seconds which is less than the 2.0 seconds limit Processing 1000 completions took 0.058 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.122 seconds which is less than the 2.0 seconds limit ``` For curiosity, even though this improves the descriptionless case quite a bit too, #1686 is still relevant, with it applied on top of this one: ``` Processing 1000 completions took 0.036 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.165 seconds which is less than the 2.0 seconds limit Processing 1000 completions took 0.047 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.183 seconds which is less than the 2.0 seconds limit Processing 1000 completions took 0.051 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.264 seconds which is less than the 2.0 seconds limit Processing 1000 completions took 0.036 seconds which is less than the 1.0 seconds limit Processing 1000 completions took 0.122 seconds which is less than the 2.0 seconds limit ``` Merge spf13/cobra#1689 --- fix(bash-v2): skip empty completions when filtering descriptions `read` gives a last null value following a trailing newline. Regression from fb8031162c2ffab270774f13c6904bb04cbba5a7. We could drop the `\n` from the feeding `printf` to accomplish the same end result, but I'm planning to submit some related cleanups a bit later that wouldn't play well with that approach, so I went with explicit filtering here. Merge spf13/cobra#1691 --- perf(bash-v2): speed up filtering menu-complete descriptions Similarly as fb8031162c2ffab270774f13c6904bb04cbba5a7 (+ the empty entry fix in spf13/cobra#1691) did for the "regular", non-menu completion cases. I have no numbers on this, but I'm assuming the speedups seen elsewhere are here too, and didn't notice anything breaking in casual manual tests. Could be useful to add some perf numbers for the menu-complete code path too to [marckhouzam/cobra-completion-testing](https://github.com/marckhouzam/cobra-completion-testing/) (maybe as well as other tests, haven't checked if there are any). Merge spf13/cobra#1692 --- perf(bash-v2): read directly to COMPREPLY on descriptionless short circuit Not that it'd really matter that much performancewise given the level we are at for this case, but this change makes the short circuit roughly twice as fast on my box as it was for the 1000 rounds done in marckhouzam/cobra-completion-testing. Perhaps more importantly, this makes the code arguably slightly cleaner. Before: ``` ... <= TIMING => no descriptions: 1000 completions took 0.039 seconds < 0.2 seconds limit ... <= TIMING => no descriptions: 1000 completions took 0.046 seconds < 0.2 seconds limit ... ``` After: ``` ... <= TIMING => no descriptions: 1000 completions took 0.022 seconds < 0.2 seconds limit ... <= TIMING => no descriptions: 1000 completions took 0.024 seconds < 0.2 seconds limit ... ``` Merge spf13/cobra#1700
ti-chi-bot bot
referenced
this pull request
in PingCAP-QE/ee-apps
Dec 9, 2023
](https://renovatebot.com){kind=link}
[](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.1.3` -> `v1.8.0` | --- ### Release Notes <details> <summary>spf13/cobra (github.com/spf13/cobra)</summary> ### [`v1.8.0`](https://togithub.com/spf13/cobra/releases/tag/v1.8.0) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.7.0...v1.8.0) #### ✨ Features - Support usage as plugin for tools like kubectl by [@​nirs](https://togithub.com/nirs) in [https://github.com/spf13/cobra/pull/2018](https://togithub.com/spf13/cobra/pull/2018) - this means that programs that utilize a "plugin-like" structure have much better support and usage (like for completions, command paths, etc.) - Move documentation sources to site/content by [@​umarcor](https://togithub.com/umarcor) in [https://github.com/spf13/cobra/pull/1428](https://togithub.com/spf13/cobra/pull/1428) - Add 'one required flag' group by [@​marevers](https://togithub.com/marevers) in [https://github.com/spf13/cobra/pull/1952](https://togithub.com/spf13/cobra/pull/1952) - this includes a new `MarkFlagsOneRequired` API for flags which can be used to mark a flag group as required and cause command failure if at least one is not used when invoked. - Customizable error message prefix by [@​5ouma](https://togithub.com/5ouma) in [https://github.com/spf13/cobra/pull/2023](https://togithub.com/spf13/cobra/pull/2023) - This adds the `SetErrPrefix` and `ErrPrefix` APIs on the `Command` struct to allow for setting a custom prefix for errors - feat: add getters for flag completions by [@​avirtopeanu-ionos](https://togithub.com/avirtopeanu-ionos) in [https://github.com/spf13/cobra/pull/1943](https://togithub.com/spf13/cobra/pull/1943) - Feature: allow running persistent run hooks of all parents by [@​vkhoroz](https://togithub.com/vkhoroz) in [https://github.com/spf13/cobra/pull/2044](https://togithub.com/spf13/cobra/pull/2044) - Improve API to get flag completion function by [@​marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/2063](https://togithub.com/spf13/cobra/pull/2063) #### 🐛 Bug fixes - Fix typo in fish completions by [@​twpayne](https://togithub.com/twpayne) in [https://github.com/spf13/cobra/pull/1945](https://togithub.com/spf13/cobra/pull/1945) - Fix grammar: 'allows to' by [@​supertassu](https://togithub.com/supertassu) in [https://github.com/spf13/cobra/pull/1978](https://togithub.com/spf13/cobra/pull/1978) - powershell: escape variable with curly brackets by [@​Luap99](https://togithub.com/Luap99) in [https://github.com/spf13/cobra/pull/1960](https://togithub.com/spf13/cobra/pull/1960) - Don't complete --help flag when flag parsing disabled by [@​marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/2061](https://togithub.com/spf13/cobra/pull/2061) - Replace all non-alphanumerics in active help env var program prefix by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1940](https://togithub.com/spf13/cobra/pull/1940) #### 🔧 Maintenance - build(deps): bump golangci/golangci-lint-action from 3.4.0 to 3.5.0 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1971](https://togithub.com/spf13/cobra/pull/1971) - build(deps): bump golangci/golangci-lint-action from 3.5.0 to 3.6.0 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1976](https://togithub.com/spf13/cobra/pull/1976) - build(deps): bump golangci/golangci-lint-action from 3.6.0 to 3.7.0 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/2021](https://togithub.com/spf13/cobra/pull/2021) - build(deps): bump actions/setup-go from 3 to 4 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1934](https://togithub.com/spf13/cobra/pull/1934) - build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.2 to 2.0.3 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/2047](https://togithub.com/spf13/cobra/pull/2047) - build(deps): bump actions/checkout from 3 to 4 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/2028](https://togithub.com/spf13/cobra/pull/2028) - command: temporarily disable G602 due to [securego/gosec#1005](https://togithub.com/securego/gosec/issues/1005) by [@​umarcor](https://togithub.com/umarcor) in [https://github.com/spf13/cobra/pull/2022](https://togithub.com/spf13/cobra/pull/2022) #### 🧪 Testing & CI/CD - test: make fish_completions_test more robust by [@​branchvincent](https://togithub.com/branchvincent) in [https://github.com/spf13/cobra/pull/1980](https://togithub.com/spf13/cobra/pull/1980) - golangci: enable 'unused' and disable deprecated replaced by it by [@​umarcor](https://togithub.com/umarcor) in [https://github.com/spf13/cobra/pull/1983](https://togithub.com/spf13/cobra/pull/1983) - cleanup: minor corrections to unit tests by [@​JunNishimura](https://togithub.com/JunNishimura) in [https://github.com/spf13/cobra/pull/2003](https://togithub.com/spf13/cobra/pull/2003) - ci: test golang 1.21 by [@​nunoadrego](https://togithub.com/nunoadrego) in [https://github.com/spf13/cobra/pull/2024](https://togithub.com/spf13/cobra/pull/2024) - Fix linter errors by [@​marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/2052](https://togithub.com/spf13/cobra/pull/2052) - Add tests for flag completion registration by [@​marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/2053](https://togithub.com/spf13/cobra/pull/2053) #### ✏️ Documentation - doc: fix typo, Deperecated -> Deprecated by [@​callthingsoff](https://togithub.com/callthingsoff) in [https://github.com/spf13/cobra/pull/2000](https://togithub.com/spf13/cobra/pull/2000) - Add notes to doc about the execution condition of \*PreRun and \*PostRun functions by [@​haoming29](https://togithub.com/haoming29) in [https://github.com/spf13/cobra/pull/2041](https://togithub.com/spf13/cobra/pull/2041) *** Thank you everyone who contributed to this release and all your hard work! Cobra and this community would never be possible without all of you!!!! 🐍 **Full Changelog**: spf13/cobra@v1.7.0...v1.8.0 ### [`v1.7.0`](https://togithub.com/spf13/cobra/releases/tag/v1.7.0) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.6.1...v1.7.0) ##### ✨ Features - Allow to preserve ordering of completions in `bash`, `zsh`, `pwsh`, & `fish`: [@​h4ck3rk3y](https://togithub.com/h4ck3rk3y) [#​1903](https://togithub.com/spf13/cobra/issues/1903) - Add support for PowerShell 7.2+ in completions: [@​oldium](https://togithub.com/oldium) [#​1916](https://togithub.com/spf13/cobra/issues/1916) - Allow sourcing zsh completion script: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1917](https://togithub.com/spf13/cobra/issues/1917) ##### 🐛 Bug fixes - Don't remove flag values that match sub-command name: [@​brianpursley](https://togithub.com/brianpursley) [#​1781](https://togithub.com/spf13/cobra/issues/1781) - Fix powershell completions not returning single word: [@​totkeks](https://togithub.com/totkeks) [#​1850](https://togithub.com/spf13/cobra/issues/1850) - Remove masked `template` import variable name: [@​yashLadha](https://togithub.com/yashLadha) [#​1879](https://togithub.com/spf13/cobra/issues/1879) - Correctly detect completions with dash in argument: [@​oncilla](https://togithub.com/oncilla) [#​1817](https://togithub.com/spf13/cobra/issues/1817) ##### 🧪 Testing & CI/CD - Deprecate Go 1.15 in CI: [@​umarcor](https://togithub.com/umarcor) [#​1866](https://togithub.com/spf13/cobra/issues/1866) - Deprecate Go 1.16 in CI: [@​umarcor](https://togithub.com/umarcor) [#​1926](https://togithub.com/spf13/cobra/issues/1926) - Add testing for Go 1.20 in CI: [@​umarcor](https://togithub.com/umarcor) [#​1925](https://togithub.com/spf13/cobra/issues/1925) - Add tests to illustrate unknown flag bug: [@​brianpursley](https://togithub.com/brianpursley) [#​1854](https://togithub.com/spf13/cobra/issues/1854) ##### 🔧 Maintenance - Update main image to better handle dark backgrounds: [@​Deleplace](https://togithub.com/Deleplace) and [@​marckhouzam](https://togithub.com/marckhouzam) [#​1883](https://togithub.com/spf13/cobra/issues/1883) - Fix `stale.yaml` mispellings: [@​enrichman](https://togithub.com/enrichman) [#​1863](https://togithub.com/spf13/cobra/issues/1863) - Remove stale bot from GitHub actions: [@​jpmcb](https://togithub.com/jpmcb) [#​1908](https://togithub.com/spf13/cobra/issues/1908) - Add makefile target for installing dependencies: [@​umarcor](https://togithub.com/umarcor) [#​1865](https://togithub.com/spf13/cobra/issues/1865) - Add Sia to projects using Cobra: [@​mike76-dev](https://togithub.com/mike76-dev) [#​1844](https://togithub.com/spf13/cobra/issues/1844) - Add `Vitess` and `Arewefastyet` to projects using cobra: [@​frouioui](https://togithub.com/frouioui) [#​1932](https://togithub.com/spf13/cobra/issues/1932) - Fixup for Kubescape github org: [@​dwertent](https://togithub.com/dwertent) [#​1874](https://togithub.com/spf13/cobra/issues/1874) - Fix route for GitHub workflows badge: [@​sh-cho](https://togithub.com/sh-cho) [#​1884](https://togithub.com/spf13/cobra/issues/1884) - Fixup for GoDoc style documentation: [@​yashLadha](https://togithub.com/yashLadha) [#​1885](https://togithub.com/spf13/cobra/issues/1885) - Various bash scripting improvements for completion: [@​scop](https://togithub.com/scop) [#​1702](https://togithub.com/spf13/cobra/issues/1702) - Add Constellation to projects using Cobra: [@​datosh](https://togithub.com/datosh) [#​1829](https://togithub.com/spf13/cobra/issues/1829) ##### ✏️ Documentation - Add documentation about disabling completion descriptions: [@​Shihta](https://togithub.com/Shihta) [#​1901](https://togithub.com/spf13/cobra/issues/1901) - Improve `MarkFlagsMutuallyExclusive` example in user guide: [@​janhn](https://togithub.com/janhn) [#​1904](https://togithub.com/spf13/cobra/issues/1904) - Update `shell_completions.md`: [@​gusega](https://togithub.com/gusega) [#​1907](https://togithub.com/spf13/cobra/issues/1907) - Update copywrite year: [@​umarcor](https://togithub.com/umarcor) [#​1927](https://togithub.com/spf13/cobra/issues/1927) - Document suggested layout of subcommands: [@​lcarva](https://togithub.com/lcarva) [#​1930](https://togithub.com/spf13/cobra/issues/1930) - Replace deprecated ExactValidArgs with MatchAll in doc: [@​doniacld](https://togithub.com/doniacld) [#​1836](https://togithub.com/spf13/cobra/issues/1836) *** This release contains several long running fixes, improvements to powershell completions, and further optimizations for completions. Thank you everyone who contributed to this release and all your hard work! Cobra and this community would never be possible without all of you! 🐍 Full changelog: spf13/cobra@v1.6.1...v1.7.0 ### [`v1.6.1`](https://togithub.com/spf13/cobra/releases/tag/v1.6.1) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.6.0...v1.6.1) ##### Bug fixes 🐛 - Fixes a panic when `AddGroup` isn't called before `AddCommand(my-sub-command)` is executed. This can happen within more complex cobra file structures that have many different `init`s to be executed. Now, the check for groups has been moved to `ExecuteC` and provides more flexibility when working with grouped commands - [@​marckhouzam](https://togithub.com/marckhouzam) (and shout out to [@​aawsome](https://togithub.com/aawsome), [@​andig](https://togithub.com/andig) and [@​KINGSABRI](https://togithub.com/KINGSABRI) for a deep investigation into this! 👏🏼) ### [`v1.6.0`](https://togithub.com/spf13/cobra/releases/tag/v1.6.0) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.5.0...v1.6.0) ##### Summer 2022 Release Some exciting changes make their way to Cobra! Command completions continue to get better and better (including adding `--help` and `--version` automatic flags to the completions list). Grouping is now possible in your help output as well! And you can now use the `OnFinalize` method to cleanup things when all "work" is done. Checkout the full changelog below: *** ##### Features 🌠 - Add groups for commands in help: [@​aawsome](https://togithub.com/aawsome) [@​marckhouzam](https://togithub.com/marckhouzam) [#​1003](https://togithub.com/spf13/cobra/issues/1003) - Support for case-insensitive command names: [@​YuviGold](https://togithub.com/YuviGold) [#​1802](https://togithub.com/spf13/cobra/issues/1802) - Expose `ValidateRequiredFlags` and `ValidateFlagGroups`: [@​skeetwu](https://togithub.com/skeetwu) [#​1760](https://togithub.com/spf13/cobra/issues/1760) - Add `--version` flag to help output: [@​fnickels](https://togithub.com/fnickels) [#​1707](https://togithub.com/spf13/cobra/issues/1707) - Add `--help` and `--version` flag in completions: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1813](https://togithub.com/spf13/cobra/issues/1813) - Add `OnFinalize` method: [@​yann-soubeyrand](https://togithub.com/yann-soubeyrand) [#​1788](https://togithub.com/spf13/cobra/issues/1788) - Allow user to add completion for powershell alias: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1621](https://togithub.com/spf13/cobra/issues/1621) - Make `InitDefaultcompletionCmd` public: [@​gssbzn](https://togithub.com/gssbzn) [#​1467](https://togithub.com/spf13/cobra/issues/1467) ##### Deprecation 👎🏼 - `ExactValidArgs` is deprecated (but not being removed entirely). This is abit nuanced, so checkout [#​1643](https://togithub.com/spf13/cobra/issues/1643) for further information and the [updated `user_guide.md`](https://togithub.com/spf13/cobra/blob/main/user_guide.md) on how this may affect you (and how you can take advantage of the *correct* behavior in the validators): [@​umarcor](https://togithub.com/umarcor) [#​1643](https://togithub.com/spf13/cobra/issues/1643) ##### Bug fixes 🐛 - Fix (bash-v2) `activeHelp` length check syntax: [@​scop](https://togithub.com/scop) [#​1762](https://togithub.com/spf13/cobra/issues/1762) - Fix correct command path in `see_also` for yaml documentation: [@​zregvart](https://togithub.com/zregvart) [#​1771](https://togithub.com/spf13/cobra/issues/1771) - Fix showing flags that shadow parent persistent flag in child help messaging: [@​brianpursley](https://togithub.com/brianpursley) [#​1776](https://togithub.com/spf13/cobra/issues/1776) ##### Dependencies 🗳️ - Upgrade to use `gopkg.in/yaml.v3`: [@​tklauser](https://togithub.com/tklauser) [#​1766](https://togithub.com/spf13/cobra/issues/1766) ##### Testing 🤔 - Test on Golang 1.19: [@​umarcor](https://togithub.com/umarcor) & [@​jpmcb](https://togithub.com/jpmcb) [#​1782](https://togithub.com/spf13/cobra/issues/1782) - Renamed powershell completion tests: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1803](https://togithub.com/spf13/cobra/issues/1803) - Use `action/setup-go` cache: [@​umarcor](https://togithub.com/umarcor) [#​1783](https://togithub.com/spf13/cobra/issues/1783) - Add `workflow_dispatch` to CI actions: [@​umarcor](https://togithub.com/umarcor) [#​1387](https://togithub.com/spf13/cobra/issues/1387) - Add minimum GitHub token permissions for workflows: [@​varunsh-coder](https://togithub.com/varunsh-coder) [#​1792](https://togithub.com/spf13/cobra/issues/1792) ##### Docs ✏️ - Fixup spelling for GitHub CLI: [@​eltociear](https://togithub.com/eltociear) [#​1744](https://togithub.com/spf13/cobra/issues/1744) - Clarify `SetContext` documentation: [@​katexochen](https://togithub.com/katexochen) [#​1748](https://togithub.com/spf13/cobra/issues/1748) - Instruct user to `go install` for binary: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1726](https://togithub.com/spf13/cobra/issues/1726) - User guide cleanup: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1656](https://togithub.com/spf13/cobra/issues/1656) - Document option to hide the default completion command: [@​marckhouzam](https://togithub.com/marckhouzam) [#​1779](https://togithub.com/spf13/cobra/issues/1779) ##### Misc 💭 - Add KubeVirt, CloudQuery, Cilium, Okteto, Zitadel, Allero to projects using cobra: [@​maiqueb](https://togithub.com/maiqueb) [#​1741](https://togithub.com/spf13/cobra/issues/1741), [@​yevgenypats](https://togithub.com/yevgenypats) [#​1742](https://togithub.com/spf13/cobra/issues/1742), [@​tklauser](https://togithub.com/tklauser) [#​1745](https://togithub.com/spf13/cobra/issues/1745), [@​jLopezbarb](https://togithub.com/jLopezbarb) [#​1759](https://togithub.com/spf13/cobra/issues/1759), [@​fforootd](https://togithub.com/fforootd) [#​1772](https://togithub.com/spf13/cobra/issues/1772), [@​dimabru](https://togithub.com/dimabru) [#​1819](https://togithub.com/spf13/cobra/issues/1819) - Use correct stale action `exempt` yaml keys: [@​jpmcb](https://togithub.com/jpmcb) [#​1800](https://togithub.com/spf13/cobra/issues/1800) - Add missing license headers: [@​umarcor](https://togithub.com/umarcor) [#​1809](https://togithub.com/spf13/cobra/issues/1809) *Note:* Per [#​1804](https://togithub.com/spf13/cobra/issues/1804), we will be moving away from "seasonal" releases and doing more generic point release targets. Continue to track the milestones and issues in the `spf13/cobra` GitHub repository for more information! Great work everyone! Cobra would never be possible without your contributions! 🐍 **Full Changelog**: spf13/cobra@v1.5.0...v1.6.0 ### [`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 [https://github.com/spf13/cobra/pull/1482](https://togithub.com/spf13/cobra/pull/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! [https://github.com/spf13/cobra/pull/1654](https://togithub.com/spf13/cobra/pull/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 [https://github.com/spf13/cobra/pull/1547](https://togithub.com/spf13/cobra/pull/1547) - feat: Add how to load completions in your current zsh session by [@​ondrejsika](https://togithub.com/ondrejsika) in [https://github.com/spf13/cobra/pull/1608](https://togithub.com/spf13/cobra/pull/1608) - Introduce FixedCompletions by [@​emersion](https://togithub.com/emersion) in [https://github.com/spf13/cobra/pull/1574](https://togithub.com/spf13/cobra/pull/1574) - Add shell completion to flag groups by [@​marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/1659](https://togithub.com/spf13/cobra/pull/1659) - Modify brew prefix path in macOS system by [@​imxw](https://togithub.com/imxw) in [https://github.com/spf13/cobra/pull/1719](https://togithub.com/spf13/cobra/pull/1719) - perf(bash-v2): use backslash escape string expansion for tab by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1682](https://togithub.com/spf13/cobra/pull/1682) - style(bash-v2): out is not an array variable, do not refer to it as such by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1681](https://togithub.com/spf13/cobra/pull/1681) - perf(bash-v2): standard completion optimizations by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1683](https://togithub.com/spf13/cobra/pull/1683) - style(bash): out is not an array variable, do not refer to it as such by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1684](https://togithub.com/spf13/cobra/pull/1684) - perf(bash-v2): short-circuit descriptionless candidate lists by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1686](https://togithub.com/spf13/cobra/pull/1686) - perf(bash-v2): speed up filtering entries with descriptions by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1689](https://togithub.com/spf13/cobra/pull/1689) - perf(bash-v2): speed up filtering menu-complete descriptions by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1692](https://togithub.com/spf13/cobra/pull/1692) - fix(bash-v2): skip empty completions when filtering descriptions by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1691](https://togithub.com/spf13/cobra/pull/1691) - perf(bash-v2): read directly to COMPREPLY on descriptionless short circuit by [@​scop](https://togithub.com/scop) in [https://github.com/spf13/cobra/pull/1700](https://togithub.com/spf13/cobra/pull/1700) - fix: Don't complete \_command on zsh by [@​twpayne](https://togithub.com/twpayne) in [https://github.com/spf13/cobra/pull/1690](https://togithub.com/spf13/cobra/pull/1690) - Improve fish_completions code quality by [@​t29kida](https://togithub.com/t29kida) in [https://github.com/spf13/cobra/pull/1515](https://togithub.com/spf13/cobra/pull/1515) - Fix handling of descriptions for bash v3 by [@​marckhouzam](https://togithub.com/marckhouzam) in [https://github.com/spf13/cobra/pull/1735](https://togithub.com/spf13/cobra/pull/1735) - undefined or nil Args default to ArbitraryArgs by [@​umarcor](https://togithub.com/umarcor) in [https://github.com/spf13/cobra/pull/1612](https://togithub.com/spf13/cobra/pull/1612) - Add Command.SetContext by [@​joshcarp](https://togithub.com/joshcarp) in [https://github.com/spf13/cobra/pull/1551](https://togithub.com/spf13/cobra/pull/1551) - Wrap printf tab with quotes by [@​PapaCharlie](https://togithub.com/PapaCharlie) in [https://github.com/spf13/cobra/pull/1665](https://togithub.com/spf13/cobra/pull/1665) #### Documentation 📝 - Fixed typos in completions docs - [@​cuishuang](https://togithub.com/cuishuang) [https://github.com/spf13/cobra/pull/1625](https://togithub.com/spf13/cobra/pull/1625) - Removed `CHANGELOG.md` as it isn't updated - [@​johnSchnake](https://togithub.com/johnSchnake) [https://github.com/spf13/cobra/pull/1634](https://togithub.com/spf13/cobra/pull/1634) - Minor typo fix in `shell_completion.md` - [@​danieldn](https://togithub.com/danieldn) [https://github.com/spf13/cobra/pull/1678](https://togithub.com/spf13/cobra/pull/1678) - Changed branch name in the cobra generator link to 'main' - [@​skywalker2909](https://togithub.com/skywalker2909) [https://github.com/spf13/cobra/pull/1645](https://togithub.com/spf13/cobra/pull/1645) - Fix Command.Context comment by [@​katexochen](https://togithub.com/katexochen) in [https://github.com/spf13/cobra/pull/1639](https://togithub.com/spf13/cobra/pull/1639) - Change appropriate links from http:// to https:// where applicable - [@​deining](https://togithub.com/deining) [https://github.com/spf13/cobra/pull/1695](https://togithub.com/spf13/cobra/pull/1695) #### Testing & CI ⚙️ - Test on Golang 1.18 - [@​umarcor](https://togithub.com/umarcor) [https://github.com/spf13/cobra/pull/1635](https://togithub.com/spf13/cobra/pull/1635) - Use `RICHGO_FORCE_COLOR` - [@​umarcor](https://togithub.com/umarcor) [https://github.com/spf13/cobra/pull/1647](https://togithub.com/spf13/cobra/pull/1647) - Adds size labeler GitHub action by [@​jpmcb](https://togithub.com/jpmcb) in [https://github.com/spf13/cobra/pull/1610](https://togithub.com/spf13/cobra/pull/1610) - Update `stale-bot` settings - [@​jpmcb](https://togithub.com/jpmcb) [https://github.com/spf13/cobra/pull/1609](https://togithub.com/spf13/cobra/pull/1609) #### Beep boop, bot commits 🤖 - Bumped golangci/golangci-lint-action from 3.1.0 to 3.2.0 - [@​dependabot](https://togithub.com/dependabot) [https://github.com/spf13/cobra/pull/1697](https://togithub.com/spf13/cobra/pull/1697) - Bump codelytv/pr-size-labeler from 1.8.0 to 1.8.1 - [@​dependabot](https://togithub.com/dependabot) [https://github.com/spf13/cobra/pull/1661](https://togithub.com/spf13/cobra/pull/1661) - Bump actions/stale from 1 to 5 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1618](https://togithub.com/spf13/cobra/pull/1618) - Bump actions/cache from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1640](https://togithub.com/spf13/cobra/pull/1640) - Bump actions/labeler from 3 to 4 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1620](https://togithub.com/spf13/cobra/pull/1620) - Bump golangci/golangci-lint-action from 2 to 3.1.0 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1615](https://togithub.com/spf13/cobra/pull/1615) - Bump actions/checkout from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1619](https://togithub.com/spf13/cobra/pull/1619) - Bump github.com/cpuguy83/go-md2man/v2 from 2.0.1 to 2.0.2 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1688](https://togithub.com/spf13/cobra/pull/1688) - Bump actions/setup-go from 2 to 3 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/spf13/cobra/pull/1660](https://togithub.com/spf13/cobra/pull/1660) #### Misc 💭 - Use `errors.Is()` to check for errors - [@​Luap99](https://togithub.com/Luap99) [https://github.com/spf13/cobra/pull/1730](https://togithub.com/spf13/cobra/pull/1730) - Prefer ReplaceAll instead of Replace(..., -1) by [@​WhyNotHugo](https://togithub.com/WhyNotHugo) in [https://github.com/spf13/cobra/pull/1530](https://togithub.com/spf13/cobra/pull/1530) - Add Kubescape to projects - [@​avinashupadhya99](https://togithub.com/avinashupadhya99) [https://github.com/spf13/cobra/pull/1642](https://togithub.com/spf13/cobra/pull/1642) - Add Pulumi as a project using cobra by [@​iwahbe](https://togithub.com/iwahbe) in [https://github.com/spf13/cobra/pull/1720](https://togithub.com/spf13/cobra/pull/1720) - Add Polygon Edge as a project using Cobra by [@​zivkovicmilos](https://togithub.com/zivkovicmilos) in [https://github.com/spf13/cobra/pull/1672](https://togithub.com/spf13/cobra/pull/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 ### [`v1.4.0`](https://togithub.com/spf13/cobra/releases/tag/v1.4.0) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.3.0...v1.4.0) ### Winter 2022 Release ❄️ Another season, another release! #### Goodbye viper! 🐍 🚀 The core Cobra library no longer requires Viper and all of its indirect dependencies. This means that Cobra's dependency tree has been drastically thinned! The Viper dependency was included because of the `cobra` CLI generation tool. [This tool has migrated to `spf13/cobra-cli`](https://togithub.com/spf13/cobra-cli/releases/tag/v1.3.0). It's *pretty unlikely* you were importing and using **the bootstrapping CLI tool** as part of your application (after all, it's just a tool to get going with core `cobra`). But if you were, replace occurrences of "github.com/spf13/cobra/cobra" with "github.com/spf13/cobra-cli" And in your `go.mod`, you'll want to also include this dependency: github.com/spf13/cobra-cli v1.3.0 Again, the maintainers *do not anticipate* this being a breaking change to users of the core `cobra` library, so minimal work should be required for users to integrate with this new release. Moreover, this means the dependency tree for your application using Cobra should no longer require dependencies that were inherited from Viper. Huzzah! 🥳 If you'd like to read more - issue: [https://github.com/spf13/cobra/issues/1597](https://togithub.com/spf13/cobra/issues/1597) - PR: [https://github.com/spf13/cobra/pull/1604](https://togithub.com/spf13/cobra/pull/1604) #### Documentation 📝 - Update Go Doc link and badge in README: [https://github.com/spf13/cobra/pull/1593](https://togithub.com/spf13/cobra/pull/1593) - Fix to install command, now targets `@latest`: [https://github.com/spf13/cobra/pull/1576](https://togithub.com/spf13/cobra/pull/1576) - Added MAINTAINERS file: [https://github.com/spf13/cobra/pull/1545](https://togithub.com/spf13/cobra/pull/1545) #### Other 💭 - Bumped license year to 2022 in golden files: [https://github.com/spf13/cobra/pull/1575](https://togithub.com/spf13/cobra/pull/1575) - Added Pixie to projects: [https://github.com/spf13/cobra/pull/1581](https://togithub.com/spf13/cobra/pull/1581) - Updated labeler for new labeling scheme: [https://github.com/spf13/cobra/pull/1613](https://togithub.com/spf13/cobra/pull/1613) & syntax fix: [https://github.com/spf13/cobra/pull/1624](https://togithub.com/spf13/cobra/pull/1624) Shoutout to our awesome contributors helping to make this cobra release possible!! [@​spf13](https://togithub.com/spf13) [@​marckhouzam](https://togithub.com/marckhouzam) [@​johnSchnake](https://togithub.com/johnSchnake) [@​jpmcb](https://togithub.com/jpmcb) [@​liggitt](https://togithub.com/liggitt) [@​umarcor](https://togithub.com/umarcor) [@​hiljusti](https://togithub.com/hiljusti) [@​marians](https://togithub.com/marians) [@​shyim](https://togithub.com/shyim) [@​htroisi](https://togithub.com/htroisi) ### [`v1.3.0`](https://togithub.com/spf13/cobra/releases/tag/v1.3.0) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.2.1...v1.3.0) ### v1.3.0 - The Fall 2021 release 🍁 #### Completion fixes & enhancements 💇🏼 In `v1.2.0`, we introduced a new model for completions. Thanks to everyone for trying it, giving feedback, and providing numerous fixes! Continue to work with the new model as the old one (as noted in code comments) will be deprecated in a coming release. - `DisableFlagParsing` now triggers custom completions for flag names [#​1161](https://togithub.com/spf13/cobra/issues/1161) - Fixed unbound variables in bash completions causing edge case errors [#​1321](https://togithub.com/spf13/cobra/issues/1321) - `help` completion formatting improvements & fixes [#​1444](https://togithub.com/spf13/cobra/issues/1444) - All completions now follow the `help` example: short desc are now capitalized and removes extra spacing from long description [#​1455](https://togithub.com/spf13/cobra/issues/1455) - Typo fixes in bash & zsh completions [#​1459](https://togithub.com/spf13/cobra/issues/1459) - Fixed mixed tab/spaces indentation in completion scripts. Now just 4 spaces [#​1473](https://togithub.com/spf13/cobra/issues/1473) - Support for different bash completion options. Bash completions v2 supports descriptions and requires descriptions to be removed for `menu-complete`, `menu-complete-backward` and `insert-completions`. These descriptions are now purposefully removed in support of this model. [#​1509](https://togithub.com/spf13/cobra/issues/1509) - Fix for invalid shell completions when using `~/.cobra.yaml`. Log message `Using config file: ~/.cobra.yaml` now printed to stderr [#​1510](https://togithub.com/spf13/cobra/issues/1510) - Removes unnecessary trailing spaces from completion command descriptions [#​1520](https://togithub.com/spf13/cobra/issues/1520) - Option to hide default `completion` command [#​1541](https://togithub.com/spf13/cobra/issues/1541) - Remove `__complete` command for programs without subcommands [#​1563](https://togithub.com/spf13/cobra/issues/1563) #### Generator changes ⚙️ Thanks to [@​spf13](https://togithub.com/spf13) for providing a number of changes to the Cobra generator tool, streamlining it for new users! - The Cobra generator now *won't* automatically include Viper and cleans up a number of unused imports when not using Viper. - The Cobra generator's default license is now `none` - The Cobra generator now works with Go modules - Documentation to reflect these changes #### New Features ⭐ - License can be specified by their SPDX identifiers [#​1159](https://togithub.com/spf13/cobra/issues/1159) - `MatchAll` allows combining several PositionalArgs to work in concert. This now allows for enabling composing `PositionalArgs` [#​896](https://togithub.com/spf13/cobra/issues/896) #### Bug Fixes 🐛 - Fixed multiple error message from cobra `init` boilerplates [#​1463](https://togithub.com/spf13/cobra/issues/1463) [#​1552](https://togithub.com/spf13/cobra/issues/1552) [#​1557](https://togithub.com/spf13/cobra/issues/1557) #### Testing 👀 - Now testing golang 1.16.x and 1.17.x in CI [#​1425](https://togithub.com/spf13/cobra/issues/1425) - Fix for running diff test to ignore CR for windows [#​949](https://togithub.com/spf13/cobra/issues/949) - Added helper functions and reduced code reproduction in `args_test` [#​1426](https://togithub.com/spf13/cobra/issues/1426) - Now using official `golangci-lint` github action [#​1477](https://togithub.com/spf13/cobra/issues/1477) #### Security 🔏 - Added GitHub dependabot [#​1427](https://togithub.com/spf13/cobra/issues/1427) - Now using Viper `v1.10.0` - There is a known CVE in an *indirect* dependency from `viper`: [https://github.com/spf13/cobra/issues/1538](https://togithub.com/spf13/cobra/issues/1538). This will be patched in a future release #### Documentation 📝 - Multiple projects added to the `projects_using_cobra.md` file: [#​1377](https://togithub.com/spf13/cobra/issues/1377) [#​1501](https://togithub.com/spf13/cobra/issues/1501) [#​1454](https://togithub.com/spf13/cobra/issues/1454) - Removed ToC from main readme file as it is now automagically displayed by GitHub [#​1429](https://togithub.com/spf13/cobra/issues/1429) - Documentation correct for when the `--author` flag is specified [#​1009](https://togithub.com/spf13/cobra/issues/1009) - `shell_completions.md` has an easier to use snippet for copying and pasting shell completions [#​1372](https://togithub.com/spf13/cobra/issues/1372) #### Other 💭 - Bump version of `cpuguy83/go-md2man` to v2.0.1 [#​1460](https://togithub.com/spf13/cobra/issues/1460) - Removed `lesser` typo from the GPL-2.0 license [#​880](https://togithub.com/spf13/cobra/issues/880) - Fixed spelling errors [#​1514](https://togithub.com/spf13/cobra/issues/1514) *Thank you to all our amazing contributors* ⭐🐍🚀 ### [`v1.2.1`](https://togithub.com/spf13/cobra/releases/tag/v1.2.1) [Compare Source](https://togithub.com/spf13/cobra/compare/v1.2.0...v1.2.1) ##### Bug fixes - Quickfix for [https://github.com/spf13/cobra/issues/1437](https://togithub.com/spf13/cobra/issues/1437) after v1.2.0 where parallel use of the `cmd.RegisterFlagCompletionFunc()` (and subsequent map) now works correctly and flag completions now work again ### [`v1.2.0`](https://togithub.com/spf13/cobra/releases/tag/v1.2.0): - The completions release [Compare Source](https://togithub.com/spf13/cobra/compare/v1.1.3...v1.2.0) ### 🌠 v1.2.0 - The completions release Welcome to v1.2.0 of Cobra! This release focuses on code completions, several critical bug fixes, some documentation updates, and security bumps. Upgrading should be simple but please take note of the introduction of bash completions V2 and their default use. The v1 completions library is still available, but will be *deprecated* in the future. Please open an issue with any problems! *** #### New Features - Automatically adds a `completion` command for shell completions. If a `completion` command is already provided, uses that instead. This will *automatically* provide shell completions for bash, zsh, fish, and PowerShell [https://github.com/spf13/cobra/pull/1192](https://togithub.com/spf13/cobra/pull/1192) - Users can configure the command auto creation: - disable the creation of the completion command - disable completion descriptions - disable the `--no-descriptions` flag for "always on" completion descriptions - Introduction of bash completions V2, a uniform completion approach which include completion descriptions. The V1 bash completions are still available *but will be deprecated* in a later release - [https://github.com/spf13/cobra/pull/1146](https://togithub.com/spf13/cobra/pull/1146) - Note that projects providing completion through a different command name (say a command named "complete") will continue to use v1 for their own command but will also provide cobra's implicit "completion" command which will use v2, unless of course, these projects take the time to disable the default "completion" command as noted above. - Commands now support context being passed to completions - [https://github.com/spf13/cobra/pull/1265](https://togithub.com/spf13/cobra/pull/1265) - An example can be found here: [https://github.com/spf13/cobra/pull/1265#issuecomment-734551031](https://togithub.com/spf13/cobra/pull/1265#issuecomment-734551031) - Removed dependency on`mitchellh/go-homedir` in favor of core Go `os.UserHomeDir()` - spf13/cobra@8eaca5f #### Bug Fixes - Fix trailing whitespace not being handled in powershell completion scripts [https://github.com/spf13/cobra/pull/1342](https://togithub.com/spf13/cobra/pull/1342) - Bash completion variable leak fix [https://github.com/spf13/cobra/pull/1352](https://togithub.com/spf13/cobra/pull/1352) - Fish shell completions correctly ignore trailing empty lines [https://github.com/spf13/cobra/pull/1284](https://togithub.com/spf13/cobra/pull/1284) - PowerShell completions fix for "no file comp directive" - [https://github.com/spf13/cobra/pull/1363](https://togithub.com/spf13/cobra/pull/1363) - Custom completions now correctly handle multiple shorthand flags together - [https://github.com/spf13/cobra/pull/1258](https://togithub.com/spf13/cobra/pull/1258) - zsh completions now correctly handle `ShellDirectiveCompletionNoSpace` and file completion all the time - [https://github.com/spf13/cobra/pull/1213](https://togithub.com/spf13/cobra/pull/1213) - Multiple fixes / improvements to the fish shell support - [https://github.com/spf13/cobra/pull/1249](https://togithub.com/spf13/cobra/pull/1249) - Fix home directory config not loading correctly - [https://github.com/spf13/cobra/pull/1282](https://togithub.com/spf13/cobra/pull/1282) - Fix for `RegisterFlagCompletionFunc` as a global var not working in multi-threaded programs: [https://github.com/spf13/cobra/pull/1423](https://togithub.com/spf13/cobra/pull/1423) - Custom completions correctly do not complete flags after args when interspersed is false [#​1308](https://togithub.com/spf13/cobra/issues/1308) #### Testing - Deprecated Travis CI. Now fully using Github Actions - spf13/cobra@d0f318d - Added test cases and enhancements (thank you to everyone for taking the time to add tests to your PRs!) - Shoutout to [@​marckhouzam](https://togithub.com/marckhouzam) and [@​Luap99](https://togithub.com/Luap99) for their hard work on a cobra command completions testing library. [Check out the repo here!](https://togithub.com/marckhouzam/cobra-completion-testing) #### Security - Bump viper to 1.8.1. This corrects several issues with vulnerabilities existing in the dependency tree - [https://github.com/spf13/cobra/pull/1433](https://togithub.com/spf13/cobra/pull/1433) #### Other - Add PR labeler with pull_request_target to enable tests to run from forks - [https://github.com/spf13/cobra/pull/1338](https://togithub.com/spf13/cobra/pull/1338) - CI using MSYS2 windows machines pull latest - [https://github.com/spf13/cobra/pull/1366](https://togithub.com/spf13/cobra/pull/1366) - Multiple small fixes to spelling / documentation - [https://github.com/spf13/cobra/pull/1349](https://togithub.com/spf13/cobra/pull/1349) [https://github.com/spf13/cobra/pull/1417](https://togithub.com/spf13/cobra/pull/1417) [https://github.com/spf13/cobra/pull/1434](https://togithub.com/spf13/cobra/pull/1434) **Thank you to *all* our amazing contributors 🐍🚀** </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 becomes conflicted, 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, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/PingCAP-QE/ee-apps). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44Ny4yIiwidXBkYXRlZEluVmVyIjoiMzcuODcuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refactor to remove two loops over the entire list of candidates.
Format descriptions only for completions that are actually going to be displayed, instead of for all candidates.
Format descriptions inline in completions array, removing need for a command substitution/subshell and a printf escape per displayed completion.
These changes shave off a second or so from my case at hand in #1680, it was roughly ~1.7s before, is now ~0.7s after.
The diff is largish, but the bulk of it is in
__%[1]s_format_comp_descriptionsdue to indentation changes, there aren't that many lines actually changed in it either.git show -whelps with the review.Caveat: I have not actually tested generating completions with this code. I worked on the improvements by tweaking an existing emitted completion shell file, then manually ported the changes to the template in Go code here. Hopefully I didn't introduce bugs while doing that. (The code compiles, and test suite fails just like it did before this change, no regressions noticed.)