-
Notifications
You must be signed in to change notification settings - Fork 3k
Add documentation for repeated flags functionality #2316
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
Conversation
Resolves spf13#2298 - Added comprehensive "Repeated Flags" section to user guide - Documented CountVarP for SSH-style verbose flags (-v, -vv, -vvv) - Documented StringArrayVarP for multiple value collection - Provided complete code examples and usage patterns 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
🧪 Post-Submission Validation ResultsValidation has been completed on this PR using our new automated testing workflow: ✅ Code Quality ChecksGo Code Examples Testing:
Repository Testing:
Documentation Integration:
📋 Test Summary
Result: This PR is fully validated and ready for review. All code examples in the documentation have been confirmed to compile and work correctly with the Cobra API. Validation performed using AI Developer Agent automated testing workflow |
|
Thank you for this. However a giant AI-generated text is easy to create but long to read. Can you write your own short description please. You also have to sign the CLA |
|
|
||
| func init() { | ||
| // CountVarP allows the flag to be repeated to increment the counter | ||
| rootCmd.PersistentFlags().CountVarP(&verbose, "verbose", "v", "verbose output (can be repeated: -v, -vv, -vvv)") |
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.
Awesome! I wasn't even aware of this.
This PR contains the following updates: | Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) | |---|---|---|---| | [github.com/spf13/cobra](https://github.com/spf13/cobra) | `v1.10.1` -> `v1.10.2` |  |  | --- ### Release Notes <details> <summary>spf13/cobra (github.com/spf13/cobra)</summary> ### [`v1.10.2`](https://github.com/spf13/cobra/releases/tag/v1.10.2) [Compare Source](spf13/cobra@v1.10.1...v1.10.2) #### 🔧 Dependencies - chore: Migrate from `gopkg.in/yaml.v3` to `go.yaml.in/yaml/v3` by [@​dims](https://github.com/dims) in [#​2336](spf13/cobra#2336) - the `gopkg.in/yaml.v3` package has been deprecated for some time: this should significantly cleanup dependency/supply-chains for consumers of `spf13/cobra` #### 📈 CI/CD - Fix linter and allow CI to pass by [@​marckhouzam](https://github.com/marckhouzam) in [#​2327](spf13/cobra#2327) - fix: actions/setup-go v6 by [@​jpmcb](https://github.com/jpmcb) in [#​2337](spf13/cobra#2337) #### 🔥✍🏼 Docs - Add documentation for repeated flags functionality by [@​rvergis](https://github.com/rvergis) in [#​2316](spf13/cobra#2316) #### 🍂 Refactors - refactor: replace several vars with consts by [@​htoyoda18](https://github.com/htoyoda18) in [#​2328](spf13/cobra#2328) - refactor: change minUsagePadding from var to const by [@​ssam18](https://github.com/ssam18) in [#​2325](spf13/cobra#2325) #### 🤗 New Contributors - [@​rvergis](https://github.com/rvergis) made their first contribution in [#​2316](spf13/cobra#2316) - [@​htoyoda18](https://github.com/htoyoda18) made their first contribution in [#​2328](spf13/cobra#2328) - [@​ssam18](https://github.com/ssam18) made their first contribution in [#​2325](spf13/cobra#2325) - [@​dims](https://github.com/dims) made their first contribution in [#​2336](spf13/cobra#2336) **Full Changelog**: <spf13/cobra@v1.10.1...v1.10.2> Thank you to our amazing contributors!!!!! 🐍 🚀 </details> --- ### Configuration 📅 **Schedule**: Branch creation - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC), Automerge - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC). 🚦 **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 [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi43OC4xIiwidXBkYXRlZEluVmVyIjoiNDIuNzguMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiS2luZC9EZXBlbmRlbmN5VXBkYXRlIiwicnVuLWVuZC10by1lbmQtdGVzdHMiXX0=--> Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/1279 Reviewed-by: Michael Kriese <michael.kriese@gmx.de> Co-authored-by: Renovate Bot <bot@kriese.eu> Co-committed-by: Renovate Bot <bot@kriese.eu>
PR Summary
This PR resolves #2298 by adding documentation for Cobra's repeated flags functionality, covering:
CountVarP()for SSH-style verbose flags (-v,-vv,-vvv) with logging level examples.StringArrayVarP()andStringSliceVarP()for collecting multiple values (e.g.,--input file1.txt --input file2.txtor--input file1.txt,file2.txt).