Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs(flag): add UseShortOptionHandling description #1956

Merged
merged 3 commits into from
Aug 13, 2024
Merged

docs(flag): add UseShortOptionHandling description #1956

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43eafe1
docs(flag): add `UseShortOptionHandling` description
BlackHole1 Jul 18, 2024
376a256
Update docs/v2/examples/flags.md
BlackHole1 Aug 12, 2024
584e28a
Merge branch 'v2-maint' into improve-flags-docs
BlackHole1 Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/v2/examples/flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,11 @@ See full list of flags at https://pkg.go.dev/github.com/urfave/cli/v2

For bool flags you can specify the flag multiple times to get a count(e.g -v -v -v or -vvv)

> If you want to support the `-vvv` flag, you need to set `App.UseShortOptionHandling`.

<!-- {
"args": ["&#45;&#45;foo", "&#45;&#45;foo"],
"output": "count 2"
"args": ["&#45;&#45;f", "&#45;&#45;f", "&#45;fff", "&#45;f"],
"output": "count 6"
} -->
```go
package main
Expand All @@ -123,10 +125,12 @@ func main() {
var count int

app := &cli.App{
UseShortOptionHandling: true,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "foo",
Usage: "foo greeting",
Aliases: []string{"f"},
Count: &count,
},
},
Expand Down