spf13 / viper

Go configuration with fangs
MIT License
26.48k stars 2.01k forks source link

StringToSliceHookFunc adds TrimSpace to handle the problem of spaces before and after array strings #1665

Open whybangbang opened 9 months ago

whybangbang commented 9 months ago

Preflight Checklist

Problem Description

  1. For example add this hook StringToSliceHookFunc(",") to viper, only handle this array string "a,b,c,d", can't handle "a, b, c, d", but in the same service, a viper will handle these two different formats
  2. https://github.com/urfave/cli have resolve this problem, refer to https://github.com/urfave/cli/blob/e8abd76fa3ee5f1bacb52eab9b71dedbeab41991/flag_slice_base.go#L61

Proposed Solution

Use TrimSpace trim items in string array, and also can trim other space defined by Unicode.

func StringToSliceHookFunc(sep string) mapstructure.DecodeHookFunc {
    return func(
        f reflect.Kind,
        t reflect.Kind,
        data interface{}) (interface{}, error) {
        if f != reflect.String || t != reflect.Slice {
            return data, nil
        }

        raw := data.(string)
        if raw == "" {
            return []string{}, nil
        }

        var strs []string
        for _, s := range strings.Split(raw, sep) {
            s = strings.TrimSpace(s)
            strs = append(strs, s)
        }

        return strs, nil
    }
}

Alternatives Considered

No response

Additional Information

No response

github-actions[bot] commented 9 months ago

👋 Thanks for reporting!

A maintainer will take a look at your issue shortly. 👀

In the meantime: We are working on Viper v2 and we would love to hear your thoughts about what you like or don't like about Viper, so we can improve or fix those issues.

⏰ If you have a couple minutes, please take some time and share your thoughts: https://forms.gle/R6faU74qPRPAzchZ9

📣 If you've already given us your feedback, you can still help by spreading the news, either by sharing the above link or telling people about this on Twitter:

https://twitter.com/sagikazarmark/status/1306904078967074816

Thank you! ❤️