Skip to content

Add test that covers all flag types #19

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

Merged
dearchap merged 2 commits into from
Oct 20, 2025
Merged

Add test that covers all flag types #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
886d87c
Add test that covers all flag types
6543 Oct 20, 2025
5bbc1d6
test time set location
6543 Oct 20, 2025
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
36 changes: 36 additions & 0 deletions docs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"net/mail"
"os"
"testing"
"time"

"github.com/stretchr/testify/require"
"github.com/urfave/cli/v3"
Expand Down Expand Up @@ -37,6 +38,32 @@ func normalizeNewlines(d []byte) []byte {
)
}

func buildFlagTest(t *testing.T) *cli.Command {
return &cli.Command{
Writer: io.Discard,
Name: "main",
Flags: []cli.Flag{
&cli.BoolFlag{Name: "bool-false"},
&cli.BoolFlag{Name: "bool-true", Value: true},
&cli.StringFlag{Name: "string-empty"},
&cli.StringFlag{Name: "string-set", Value: "a string"},
&cli.StringMapFlag{Name: "string-map-empty"},
&cli.StringMapFlag{Name: "string-map-set", Value: map[string]string{"a": "b"}},
&cli.StringSliceFlag{Name: "string-slice-empty"},
&cli.StringSliceFlag{Name: "string-slice-set", Value: []string{"a", "b"}},
&cli.IntFlag{Name: "string-empty"},
&cli.IntFlag{Name: "string-set", Value: 42},
&cli.UintFlag{Name: "string-empty"},
&cli.UintFlag{Name: "string-set", Value: 21},
&cli.FloatFlag{Name: "string-empty"},
&cli.FloatFlag{Name: "string-set", Value: 88.32},
&cli.DurationFlag{Name: "string-empty"},
&cli.DurationFlag{Name: "string-set", Value: 12 * time.Minute},
&cli.TimestampFlag{Name: "string-empty"},
&cli.TimestampFlag{Name: "string-set", Value: time.Unix(1729456800, 0).UTC()},
}}
}

func buildExtendedTestCommand(t *testing.T) *cli.Command {
return &cli.Command{
Writer: io.Discard,
Expand Down Expand Up @@ -342,6 +369,15 @@ func TestToMarkdown(t *testing.T) {
require.NoError(t, err)
expectFileContent(t, "testdata/expected-doc-no-usagetext.md", res)
})

t.Run("test all flag types", func(t *testing.T) {
app := buildFlagTest(t)

res, err := ToMarkdown(app)

require.NoError(t, err)
expectFileContent(t, "testdata/expected-doc-all-flag-types.md", res)
})
}

func TestToMan(t *testing.T) {
Expand Down
73 changes: 73 additions & 0 deletions testdata/expected-doc-all-flag-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# NAME

main

# SYNOPSIS

main

```
[--bool-false]
[--bool-true]
[--string-empty]=[value]
[--string-empty]=[value]
[--string-empty]=[value]
[--string-empty]=[value]
[--string-empty]=[value]
[--string-empty]=[value]
[--string-map-empty]=[value]
[--string-map-set]=[value]
[--string-set]=[value]
[--string-set]=[value]
[--string-set]=[value]
[--string-set]=[value]
[--string-set]=[value]
[--string-set]=[value]
[--string-slice-empty]=[value]
[--string-slice-set]=[value]
```

**Usage**:

```
main [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...]
```

# GLOBAL OPTIONS

**--bool-false**: (default: false)

**--bool-true**: (default: true)

**--string-empty**="":

**--string-empty**="": (default: 0)

**--string-empty**="": (default: 0)

**--string-empty**="": (default: 0)

**--string-empty**="": (default: 0001-01-01 00:00:00 +0000 UTC)

**--string-empty**="": (default: 0s)

**--string-map-empty**="": (default: map[])

**--string-map-set**="": (default: map[a:b])

**--string-set**="": (default: 12m0s)

**--string-set**="": (default: 2024-10-20 20:40:00 +0000 UTC)

**--string-set**="": (default: 21)

**--string-set**="": (default: 42)

**--string-set**="": (default: 88.32)

**--string-set**="": (default: a string)

**--string-slice-empty**="": (default: [])

**--string-slice-set**="": (default: [a b])

Loading