cobrax

README

cobrax

A utility library for spf13/cobra, spf13/viper and spf13/afero.

Usage

var version, commit, date string // main.version, main.commit, main.date

cmd := cobrax.NewRoot(viper.New())
cmd.Use = "app"
cmd.Short = "description of app"
cmd.Version = cobrax.VersionFunc(version, commit, date)

cmd.AddCommand(someCmd)
cmd.AddCommand(otherCmd)

cmd.Execute()

// Open the file. When pipe is used and the filename is empty, read from stdin.
cobrax.OpenOrStdIn(viper.GetString("filename"), afero.NewOsFs()) 

// Read the config file and set the values to the viper.
cobrax.BindConfigs(v, "app")

License

This tool is licensed under the MIT License. See the LICENSE file for details.

Links

• spf13/cobra
• spf13/viper
• spf13/afero

Documentation

Index

• Variables
• func BindConfigs(v *viper.Viper, rootCmdName string, opts ...ConfigOption) error
• func DebugViper(v *viper.Viper) string
• func GetFlags(cmd *cobra.Command) map[string]any
• func KebabToSnake(f *pflag.FlagSet, name string) pflag.NormalizedName
• func NewRoot(v *viper.Viper) *cobra.Command
• func NewRootWithOption(v *viper.Viper, option RootFlagOption) *cobra.Command
• func OpenOrStdIn(filename string, fs afero.Fs, opts ...OptionFunc) (io.ReadCloser, error)
• func PrintConfig(w io.Writer, m map[string]any, format PrintConfigFormat) error
• func PrintConfigCmd(name string) *cobra.Command
• func RootPersistentPreRunE(cmd *cobra.Command, v *viper.Viper, _ afero.Fs, _ []string) error
• func SetLogger(l *slog.Logger)
• func SnakeToKebab(f *pflag.FlagSet, name string) pflag.NormalizedName
• func VerbosityLevel(v *viper.Viper, opts ...VerbosityLevelOption) slog.Level
• func VersionFunc(version, commit, date string) string
• func WithManualInputEnabled(o *Option)
• type ConfigOption
  • func WithConfigFileFlag(cmd *cobra.Command, flagName string) ConfigOption
  • func WithConfigFileName(file string) ConfigOption
  • func WithConfigFilePaths(paths ...string) ConfigOption
  • func WithMergeConfig(merge bool) ConfigOption
  • func WithOverrideBy(key string) ConfigOption
  • func WithOverrideDisabled() ConfigOption
• type ConfigOptions
• type FlagOption
• type Option
• type OptionFunc
  • func WithStdin(stdin io.Reader) OptionFunc
• type PrintConfigFormat
  • func (f *PrintConfigFormat) Set(v string) error
  • func (f *PrintConfigFormat) String() string
  • func (f *PrintConfigFormat) Type() string
• type RootFlagOption
• type VerbosityLevelOption
  • func WithQuietName(quietName string) VerbosityLevelOption
  • func WithVerbosityName(verboseName string) VerbosityLevelOption
  • func WithVerbosityStep(step int) VerbosityLevelOption
  • func WithVerbosityZeroLevel(level slog.Level) VerbosityLevelOption
• type VerbosityLevelOptions

Variables

var DefaultRootFlagOption = RootFlagOption{
	Config:  FlagOption{Name: "config", Shorthand: "", Usage: "configuration `filename`"},
	NoColor: FlagOption{Name: "no-color", Shorthand: "", Usage: "disable colorized output"},
	Verbose: FlagOption{Name: "verbose", Shorthand: "v", Usage: "More output per occurrence. (e.g. -vvv)"},
	Quiet:   FlagOption{Name: "quiet", Shorthand: "q", Usage: "Silence all output"},
}

var ErrNoFileSpecified = errors.New("no file specified")

Functions

func BindConfigs

func BindConfigs(v *viper.Viper, rootCmdName string, opts ...ConfigOption) error

func DebugViper

func DebugViper(v *viper.Viper) string

func GetFlags

func GetFlags(cmd *cobra.Command) map[string]any

func KebabToSnake

func KebabToSnake(f *pflag.FlagSet, name string) pflag.NormalizedName

KebabToSnake normalizes flag names from kebab-case to snake_case.

func NewRoot

func NewRoot(v *viper.Viper) *cobra.Command

NewRoot returns the base command used when called without any subcommands

func NewRootWithOption

func NewRootWithOption(v *viper.Viper, option RootFlagOption) *cobra.Command

NewRootWithOption returns the base command used when called without any subcommands

func OpenOrStdIn

func OpenOrStdIn(filename string, fs afero.Fs, opts ...OptionFunc) (io.ReadCloser, error)

func PrintConfig

func PrintConfig(w io.Writer, m map[string]any, format PrintConfigFormat) error

func PrintConfigCmd

func PrintConfigCmd(name string) *cobra.Command

func RootPersistentPreRunE

func RootPersistentPreRunE(cmd *cobra.Command, v *viper.Viper, _ afero.Fs, _ []string) error

func SetLogger

func SetLogger(l *slog.Logger)

func SnakeToKebab

func SnakeToKebab(f *pflag.FlagSet, name string) pflag.NormalizedName

SnakeToKebab normalizes flag names from snake_case to kebab-case.

func VerbosityLevel

func VerbosityLevel(v *viper.Viper, opts ...VerbosityLevelOption) slog.Level

func VersionFunc

func VersionFunc(version, commit, date string) string

VersionFunc returns the version string. https://goreleaser.com/cookbooks/using-main.version/

func WithManualInputEnabled

func WithManualInputEnabled(o *Option)

Types

type ConfigOption

type ConfigOption func(*ConfigOptions)

func WithConfigFileFlag

func WithConfigFileFlag(cmd *cobra.Command, flagName string) ConfigOption

func WithConfigFileName

func WithConfigFileName(file string) ConfigOption

func WithConfigFilePaths

func WithConfigFilePaths(paths ...string) ConfigOption

func WithMergeConfig

func WithMergeConfig(merge bool) ConfigOption

func WithOverrideBy

func WithOverrideBy(key string) ConfigOption

func WithOverrideDisabled

func WithOverrideDisabled() ConfigOption

type ConfigOptions

type ConfigOptions struct {
	// contains filtered or unexported fields
}

type FlagOption

type FlagOption struct {
	Name      string
	Shorthand string
	Usage     string
}

type Option

type Option struct {
	// contains filtered or unexported fields
}

type OptionFunc

type OptionFunc func(*Option)

func WithStdin

func WithStdin(stdin io.Reader) OptionFunc

type PrintConfigFormat

type PrintConfigFormat string

const (
	YAML PrintConfigFormat = "yaml"
	JSON PrintConfigFormat = "json"
	TOML PrintConfigFormat = "toml"
)

func (*PrintConfigFormat) Set

func (f *PrintConfigFormat) Set(v string) error

Set must have pointer receiver so it doesn't change the value of a copy

func (*PrintConfigFormat) String

func (f *PrintConfigFormat) String() string

String is used both by fmt.Print and by Cobra in help text

func (*PrintConfigFormat) Type

func (f *PrintConfigFormat) Type() string

Type is only used in help text

type RootFlagOption

type RootFlagOption struct {
	Config  FlagOption
	NoColor FlagOption
	Verbose FlagOption
	Quiet   FlagOption
}

type VerbosityLevelOption

type VerbosityLevelOption func(*VerbosityLevelOptions)

func WithQuietName

func WithQuietName(quietName string) VerbosityLevelOption

func WithVerbosityName

func WithVerbosityName(verboseName string) VerbosityLevelOption

func WithVerbosityStep

func WithVerbosityStep(step int) VerbosityLevelOption

func WithVerbosityZeroLevel

func WithVerbosityZeroLevel(level slog.Level) VerbosityLevelOption

type VerbosityLevelOptions

type VerbosityLevelOptions struct {
	// contains filtered or unexported fields
}