Skip to content

Commit

Permalink
Do not add environment variable to help it is already present.
Browse files Browse the repository at this point in the history
Fixes #246.
  • Loading branch information
mitar authored and alecthomas committed Dec 4, 2021
1 parent 32b2f74 commit deebf0b
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 5 deletions.
1 change: 1 addition & 0 deletions build.go
Expand Up @@ -239,6 +239,7 @@ func buildField(k *Kong, node *Node, v reflect.Value, ft reflect.StructField, fv
value := &Value{
Name: name,
Help: tag.Help,
OrigHelp: tag.Help,
Default: tag.Default,
DefaultValue: reflect.New(fv.Type()).Elem(),
Mapper: mapper,
Expand Down
2 changes: 1 addition & 1 deletion help.go
Expand Up @@ -86,7 +86,7 @@ type HelpValueFormatter func(value *Value) string

// DefaultHelpValueFormatter is the default HelpValueFormatter.
func DefaultHelpValueFormatter(value *Value) string {
if value.Tag.Env == "" {
if value.Tag.Env == "" || HasInterpolatedVar(value.OrigHelp, "env") {
return value.Help
}
suffix := "($" + value.Tag.Env + ")"
Expand Down
11 changes: 11 additions & 0 deletions interpolate.go
Expand Up @@ -7,6 +7,17 @@ import (

var interpolationRegex = regexp.MustCompile(`(\$\$)|((?:\${([[:alpha:]_][[:word:]]*))(?:=([^}]+))?})|(\$)|([^$]+)`)

// HasInterpolatedVar returns true if the variable "v" is interpolated in "s".
func HasInterpolatedVar(s string, v string) bool {
matches := interpolationRegex.FindAllStringSubmatch(s, -1)
for _, match := range matches {
if name := match[3]; name == v {
return true
}
}
return false
}

// Interpolate variables from vars into s for substrings in the form ${var} or ${var=default}.
func interpolate(s string, vars Vars, updatedVars map[string]string) (string, error) {
out := ""
Expand Down
17 changes: 14 additions & 3 deletions interpolate_test.go
Expand Up @@ -8,12 +8,23 @@ import (

func TestInterpolate(t *testing.T) {
vars := map[string]string{
"age": "35",
"age": "35",
"city": "Melbourne",
}
updatedVars := map[string]string{
"height": "180",
}
actual, err := interpolate("${name=Bobby Brown} is ${age} years old and ${height} cm tall and likes $${AUD}", vars, updatedVars)
actual, err := interpolate("${name=Bobby Brown} is ${age} years old, ${height} cm tall, lives in ${city=<unknown>}, and likes $${AUD}", vars, updatedVars)
require.NoError(t, err)
require.Equal(t, `Bobby Brown is 35 years old and 180 cm tall and likes ${AUD}`, actual)
require.Equal(t, `Bobby Brown is 35 years old, 180 cm tall, lives in Melbourne, and likes ${AUD}`, actual)
}

func TestHasInterpolatedVar(t *testing.T) {
for _, tag := range []string{"name", "age", "height", "city"} {
require.True(t, HasInterpolatedVar("${name=Bobby Brown} is ${age} years old, ${height} cm tall, lives in ${city=<unknown>}, and likes $${AUD}", tag), tag)
}

for _, tag := range []string{"name", "age", "height", "AUD"} {
require.False(t, HasInterpolatedVar("$name $$age {height} $${AUD}", tag), tag)
}
}
1 change: 1 addition & 0 deletions kong.go
Expand Up @@ -223,6 +223,7 @@ func (k *Kong) extraFlags() []*Flag {
Value: &Value{
Name: "help",
Help: "Show context-sensitive help.",
OrigHelp: "Show context-sensitive help.",
Target: value,
Tag: &Tag{},
Mapper: k.registry.ForValue(value),
Expand Down
2 changes: 1 addition & 1 deletion kong_test.go
Expand Up @@ -675,7 +675,7 @@ func TestIssue244(t *testing.T) {
k := mustNew(t, &Config{}, kong.Exit(func(int) {}), kong.Writers(w, w))
_, err := k.Parse([]string{"--help"})
require.NoError(t, err)
require.Contains(t, w.String(), `Environment variable: CI_PROJECT_ID ($CI_PROJECT_ID)`)
require.Contains(t, w.String(), `Environment variable: CI_PROJECT_ID`)
}

func TestErrorMissingArgs(t *testing.T) {
Expand Down
1 change: 1 addition & 0 deletions model.go
Expand Up @@ -231,6 +231,7 @@ type Value struct {
Flag *Flag // Nil if positional argument.
Name string
Help string
OrigHelp string // Original help string, without interpolated variables.
Default string
DefaultValue reflect.Value
Enum string
Expand Down

0 comments on commit deebf0b

Please sign in to comment.