Skip to content

Improve type naming when using pflag #41

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
merged 1 commit into from
Jun 12, 2025
Merged

Improve type naming when using pflag #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 8 additions & 0 deletions flagset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,6 +667,10 @@ func (s *strSliceVar) Set(val string) error {
return nil
}

func (s *strSliceVar) Type() string {
return getTypeName(reflect.TypeOf(s.ref))
}

func parseStringSlice(val string, valueSplitPattern string) []string {
if valueSplitPattern == "" {
return []string{val}
Expand Down Expand Up @@ -718,6 +722,10 @@ func (s strToStrMapVar) Set(val string) error {
return nil
}

func (s strToStrMapVar) Type() string {
return getTypeName(reflect.TypeOf(s.val))
}

func parseStringToStringMap(val string) map[string]string {
result := make(map[string]string)

Expand Down
75 changes: 59 additions & 16 deletions flagset_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"bytes"
"flag"
"fmt"
"io"
"os"
"reflect"
"strconv"
Expand All @@ -12,6 +13,7 @@ import (

"github.com/iancoleman/strcase"
"github.com/itzg/go-flagsfiller"
"github.com/spf13/pflag"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down Expand Up @@ -148,7 +150,7 @@ func TestUsage(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-multi-word-name string
Expand Down Expand Up @@ -377,7 +379,7 @@ func TestNumbers(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-val-float-64 float
Expand Down Expand Up @@ -421,7 +423,7 @@ func TestDefaultsViaLiteral(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, "un-exported", config.Nested.unExported)

Expand Down Expand Up @@ -452,7 +454,7 @@ func TestDefaultsViaTag(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-enabled
Expand Down Expand Up @@ -482,7 +484,7 @@ func TestSimpleTypeDefaultsViaTag(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-count value
Expand Down Expand Up @@ -571,7 +573,7 @@ func TestStringSlice(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-instance-default value
Expand Down Expand Up @@ -639,7 +641,7 @@ func TestStringToStringMap(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

// using regexp assertion since -tag-default's map entries can be either order
assert.Regexp(t, `
Expand Down Expand Up @@ -675,7 +677,7 @@ func TestUsagePlaceholders(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-some-url URL
Expand Down Expand Up @@ -722,7 +724,7 @@ func TestIgnoreNonExportedFields(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-host string
Expand All @@ -745,7 +747,7 @@ func TestIgnoreNonExportedStructFields(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-host string
Expand All @@ -770,7 +772,7 @@ func TestWithEnv(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-host string
Expand Down Expand Up @@ -799,7 +801,7 @@ func TestWithEnvOverride(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-host string
Expand All @@ -820,7 +822,7 @@ func TestWithEnvOverrideDisable(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-host string
Expand All @@ -846,7 +848,7 @@ func TestNoSetFromEnv(t *testing.T) {
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Empty(t, config.Host)

Expand All @@ -869,7 +871,7 @@ func TestFlagNameOverride(t *testing.T) {
var flagset flag.FlagSet
err := filler.Fill(&flagset, &config)
require.NoError(t, err)
buf := grabUsage(flagset)
buf := grabUsage(&flagset)

assert.Equal(t, `
-server_address string
Expand All @@ -878,7 +880,12 @@ func TestFlagNameOverride(t *testing.T) {

}

func grabUsage(flagset flag.FlagSet) *bytes.Buffer {
type flagSet interface {
SetOutput(io.Writer)
PrintDefaults()
}

func grabUsage(flagset flagSet) *bytes.Buffer {
var buf bytes.Buffer
buf.Write([]byte{'\n'})
// start with newline to make expected string nicer below
Expand Down Expand Up @@ -909,3 +916,39 @@ func ExampleWithEnv() {
// Output:
// from env
}

func TestTypeNamesWithPFlag(t *testing.T) {
type Config struct {
Enabled bool
Timeout time.Duration
Count int16
Hosts []string
Map map[string]string
}

flagsfiller.RegisterSimpleType(func(s string, tag reflect.StructTag) (int16, error) {
i, err := strconv.ParseInt(s, 10, 16)
return int16(i), err
})

var config Config

filler := flagsfiller.New()

var flagset flag.FlagSet
err := filler.Fill(&flagset, &config)
require.NoError(t, err)

var pflagSet pflag.FlagSet
pflagSet.AddGoFlagSet(&flagset)

buf := grabUsage(&pflagSet)

assert.Equal(t, `
--count int16
--enabled
--hosts []string
--map map[string]string
--timeout duration (default 0s)
`, buf.String())
}
1 change: 1 addition & 0 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ require (
require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/spf13/pflag v1.0.6 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
2 changes: 2 additions & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ github.com/iancoleman/strcase v0.3.0 h1:nTXanmYxhfFAMjZL34Ov6gkzEsSJZ5DbhxWjvSAS
github.com/iancoleman/strcase v0.3.0/go.mod h1:iwCmte+B7n89clKwxIoIXy/HfoL7AsD47ZCWhYzw7ho=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
Expand Down
4 changes: 4 additions & 0 deletions simple.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ func (v *simpleType[T]) Set(s string) error {
return nil
}

func (v *simpleType[T]) Type() string {
return getTypeName(reflect.TypeOf(*new(T)))
}

func (v *simpleType[T]) SetRef(t *T) {
v.val = t
}
Expand Down