themalkolm/venom

🐍 Make viper and cobra more venomous!

venom's Issues

Add LogObject

func LogObject(in interface{}, output string, lvl logrus.Level) error {
	w := logrus.StandardLogger().WriterLevel(lvl)
        defer w.Close()

	return venom.WriteObject(in, venom.Format(output), w)
}

Something like this. A way to write object to log.

Why do we have RawFormat again?

Not sure we need this.. simply passing bytes to a function so it writes them to the writer we pass to this function as well.. weeird.

Make it possible to turn of shorthand notations -e, -l etc.

Not every tools wants to have this short flag being stolen by venom.

Invoke Flags() instead of recursive call in case of ++

type Flager interface {
    Flags() *pflag.FlagSet
}

Maybe not even only for inners structs. Maybe for any struct at all i.e. if it is available - use it instead of introspection.

Add table driven tests instead of expect scripts

Add support for custom validation

e.g.

func (c *FooConfig) Validate() (err *multierror.Error) {
	...
	return err
}

If we define this method it should be invoked during flag parsing to ensure the config is valid e.g.

var cfg FooConfig
err := venom.Validate(&cfg)

This will go and recursively run Validate for all flag-tagged struct etc.

Add map[string]string support for flags

Add gen-config command

It would be nice to automatically generate config structure for any command e.g.

var RootCmd = &cobra.Command{
	Use:          "foobar",
...
func init() {
	//
	// You need to define flags as usual.
	//
	RootCmd.PersistentFlags().String("foo", "", "Some foonees must be set")
	RootCmd.PersistentFlags().String("foo-bar", "", "Some barness must be set")
...

$ foobar gen-config -o ./config.go
...

$ cat ./config.o
type Config struct {
	Foo    string `mapstructure:"foo"`
	FooBar string `mapstructure:"foo-bar"`
}

So kind of self-updating code. The tricky part is to how to start this process. This could be done simply by having a dummy struct in the beginning to make sure code compiles.

logrus should be optional

Hide all logrus specific code behind a build tag

Add -l to --log-level

Lets add short -l for logging as it is very common to have it anyway

Rename DefineFlags => DefineFlagsOrDie

Support trivial type conversion for default values

WORKS

type Foo struct {
    bar string `flag:"bar,bananza,Barness"`
}

DOESN'T WORK

type Bar string
type Foo struct {
    bar Bar `flag:"bar,bananza,Barness"`
}

While it is still a string, it works only in the first case.

Add support for disabling --env-prefix

We can keep default one, we can change it but currently we can't clear it. Lets update code to support this option for --env-prefix flag.