这是indexloc提供的服务，不要输入任何密码
Skip to content

feat(humacli): add support for 'env' struct tag #884

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+51 −24
Open

feat(humacli): add support for 'env' struct tag #884

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
47 changes: 26 additions & 21 deletions humacli/humacli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ type Hooks interface {
// OnStart sets a function to call when the service should be started. This
// is called by the default command if no command is given. The callback
// should take whatever steps are necessary to start the server, such as
// `httpServer.ListenAndServer(...)`.
// `httpServer.ListenAndServe(...)`.
OnStart(func())

// OnStop sets a function to call when the service should be stopped. This
Expand Down Expand Up @@ -77,9 +77,10 @@ func WithOptions[Options any](f func(cmd *cobra.Command, args []string, options
}

type option struct {
name string
typ reflect.Type
path []int
name string
typ reflect.Type
path []int
envName string
}

type cli[Options any] struct {
Expand Down Expand Up @@ -161,18 +162,10 @@ func getBoolValue(flags *pflag.FlagSet, flagName, envValue string, hasEnv bool)
return value
}

// getEnvName converts a flag name to the corresponding environment variable name
func getEnvName(flagName string) string {
name := strings.ReplaceAll(flagName, "-", "_")
name = strings.ReplaceAll(name, ".", "_")
return "SERVICE_" + strings.ToUpper(name)
}

// getValueFromType uses the appropriate getter based on the field type
// and returns the value respecting precedence rules.
func getValueFromType(flags *pflag.FlagSet, flagName string, fieldType reflect.Type) (any, bool) {
func getValueFromType(flags *pflag.FlagSet, flagName, envName string, fieldType reflect.Type) (any, bool) {
// Check environment variables
envName := getEnvName(flagName)
envValue, hasEnv := os.LookupEnv(envName)

// Determine the appropriate getter based on type
Expand All @@ -195,7 +188,7 @@ func getValueFromType(flags *pflag.FlagSet, flagName string, fieldType reflect.T
// CLI args take precedence over environment variables.
func getValueFromFlagOrEnv(flags *pflag.FlagSet, opt option, fieldType reflect.Type) reflect.Value {
// Get the value based on type
value, ok := getValueFromType(flags, opt.name, fieldType)
value, ok := getValueFromType(flags, opt.name, opt.envName, fieldType)
if !ok {
// This shouldn't happen if setupOptions validates types properly
panic(fmt.Sprintf("unsupported type for option %s: %s", opt.name, fieldType.String()))
Expand Down Expand Up @@ -268,11 +261,11 @@ func (c *cli[O]) OnStop(fn func()) {

// registerOption registers an option with the CLI, handling common tasks like
// parsing default values, setting up flags, and storing option metadata.
func (c *cli[O]) registerOption(flags *pflag.FlagSet, field reflect.StructField, currentPath []int, name, defaultValue string) error {
func (c *cli[O]) registerOption(flags *pflag.FlagSet, field reflect.StructField, currentPath []int, name, envName, defaultValue string) error {
fieldType := deref(field.Type)

// Store option metadata regardless of type
c.optInfo = append(c.optInfo, option{name, field.Type, currentPath})
c.optInfo = append(c.optInfo, option{name, field.Type, currentPath, envName})

// Type-specific flag setup and default parsing
switch fieldType.Kind() {
Expand Down Expand Up @@ -349,8 +342,13 @@ func (c *cli[O]) setupOptions(t reflect.Type, path []int, prefix string) error {
name = prefix + "." + name
}

// Convert dotted names to snake case with underscores for env vars
envName := "SERVICE_" + casing.Snake(strings.ReplaceAll(name, ".", "_"), strings.ToUpper)
// Determine the environment variable name. Prioritize the `env` tag.
envName := field.Tag.Get("env")
if envName == "" {
// Fallback to default behavior if `env` tag is not set.
envName = getEnvName(name)
}

defaultValue := field.Tag.Get("default")
if v, ok := os.LookupEnv(envName); ok {
// Env vars will override the default value, which is used to document
Expand All @@ -360,7 +358,7 @@ func (c *cli[O]) setupOptions(t reflect.Type, path []int, prefix string) error {

switch fieldType.Kind() {
case reflect.String, reflect.Int, reflect.Int64, reflect.Bool:
if err := c.registerOption(flags, field, currentPath, name, defaultValue); err != nil {
if err := c.registerOption(flags, field, currentPath, name, envName, defaultValue); err != nil {
return fmt.Errorf("failed to register option %q: %w", field.Name, err)
}
case reflect.Struct:
Expand Down Expand Up @@ -394,11 +392,11 @@ func (c *cli[O]) setupOptions(t reflect.Type, path []int, prefix string) error {
// type Options struct {
// Debug bool `doc:"Enable debug logging"`
// Host string `doc:"Hostname to listen on."`
// Port int `doc:"Port to listen on." short:"p" default:"8888"`
// Port int `doc:"Port to listen on." short:"p" default:"8888" env:"APP_PORT"`
// }
//
// // Then, create the CLI.
// cli := humacli.CLI(func(hooks humacli.Hooks, opts *Options) {
// cli := humacli.New(func(hooks humacli.Hooks, opts *Options) {
// fmt.Printf("Options are debug:%v host:%v port%v\n",
// opts.Debug, opts.Host, opts.Port)
//
Expand Down Expand Up @@ -463,3 +461,10 @@ func New[O any](onParsed func(Hooks, *O)) CLI {
}
return c
}

// getEnvName converts a flag name to the corresponding environment variable name
func getEnvName(flagName string) string {
name := strings.ReplaceAll(flagName, "-", "_")
name = strings.ReplaceAll(name, ".", "_")
return "SERVICE_" + strings.ToUpper(name)
}
28 changes: 25 additions & 3 deletions humacli/humacli_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,24 @@ func TestCLIEnv(t *testing.T) {
cli.Run()
}

func TestCLIEnvTag(t *testing.T) {
type Options struct {
Port int `env:"CUSTOM_PORT_VAR"`
}

t.Setenv("CUSTOM_PORT_VAR", "9999")

cli := humacli.New(func(hooks humacli.Hooks, options *Options) {
assert.Equal(t, 9999, options.Port)
hooks.OnStart(func() {
// Do nothing
})
})

cli.Root().SetArgs([]string{})
cli.Run()
}

func TestCLIAdvanced(t *testing.T) {
type DebugOption struct {
Debug bool `doc:"Enable debug mode." default:"false"`
Expand Down Expand Up @@ -296,24 +314,28 @@ func TestCLINestedOptions(t *testing.T) {

func TestCLIPriority(t *testing.T) {
type Options struct {
WithEnv int `name:"with-env"`
WithFlag int `name:"with-flag"`
WithBoth int `name:"with-both"`
WithEnv int `name:"with-env"`
WithFlag int `name:"with-flag"`
WithBoth int `name:"with-both"`
WithEnvTag int `name:"with-env-tag" env:"CUSTOM_PRIORITY"`
}

cli := humacli.New(func(hooks humacli.Hooks, options *Options) {
assert.Equal(t, 1, options.WithEnv)
assert.Equal(t, 20, options.WithFlag)
assert.Equal(t, 30, options.WithBoth)
assert.Equal(t, 40, options.WithEnvTag)
hooks.OnStart(func() {})
})

t.Setenv("SERVICE_WITH_ENV", "1")
t.Setenv("SERVICE_WITH_BOTH", "3")
t.Setenv("CUSTOM_PRIORITY", "4")

cli.Root().SetArgs([]string{
"--with-flag", "20",
"--with-both", "30",
"--with-env-tag", "40",
})
cli.Run()
}