Skip to content

Commit

Permalink
Improve default delimiter names
Browse files Browse the repository at this point in the history
  • Loading branch information
NHAS committed Nov 10, 2024
1 parent c11fb7b commit 3769226
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 15 deletions.
10 changes: 5 additions & 5 deletions cli_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
func TestCliBasicTypes(t *testing.T) {

os.Args = []string{"dummyprogramname", "-thing", "helloworld", "-b_bool", "-thonku_complex.Mff", "toaster"}
dummyConfig, err := LoadCli[testStruct](DefaultCliDelimiter)
dummyConfig, err := LoadCli[testStruct](CLIDelimiter)
if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -65,7 +65,7 @@ func TestCliComplexTypes(t *testing.T) {
"-complex_array", "text1,text2,text3", // Example for ComplexArray (implementsTextUnmarshaler)
}

dummyConfig, err := LoadCli[testCliStruct](DefaultCliDelimiter)
dummyConfig, err := LoadCli[testCliStruct](CLIDelimiter)
if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -116,7 +116,7 @@ func TestCliEmptyStringSlice(t *testing.T) {
"dummy", "-confy-help",
}

_, err := LoadCli[lotsOfArrays](DefaultCliDelimiter)
_, err := LoadCli[lotsOfArrays](CLIDelimiter)
if err == nil {
t.Fail()
}
Expand All @@ -140,7 +140,7 @@ func TestCliHelperMethod(t *testing.T) {
"Nested.NestedVal",
}

vals := GetGeneratedCliFlags[Small](DefaultCliDelimiter)
vals := GetGeneratedCliFlags[Small](CLIDelimiter)

if !reflect.DeepEqual(expectedContents, vals) {
t.Fatalf("expected %v got %v", expectedContents, vals)
Expand All @@ -159,7 +159,7 @@ func TestCliTransform(t *testing.T) {
"-COMPLEX_ARRAY", "text1,text2,text3", // Example for ComplexArray (implementsTextUnmarshaler)
}

dummyConfig, err := LoadCliWithTransform[testCliStruct](DefaultCliDelimiter, strings.ToUpper)
dummyConfig, err := LoadCliWithTransform[testCliStruct](CLIDelimiter, strings.ToUpper)
if err != nil {
t.Fatal(err)
}
Expand Down
8 changes: 4 additions & 4 deletions entry.go
Original file line number Diff line number Diff line change
Expand Up @@ -226,12 +226,12 @@ func Defaults(cliFlag, defaultPath string) OptionFunc {
errs = append(errs, err)
}

err = FromEnvs(DefaultENVDelimiter)(c)
err = FromEnvs(ENVDelimiter)(c)
if err != nil {
errs = append(errs, err)

}
err = FromCli(DefaultCliDelimiter)(c)
err = FromCli(CLIDelimiter)(c)
if err != nil {
errs = append(errs, err)

Expand All @@ -256,11 +256,11 @@ func DefaultsFromPath(path string) OptionFunc {
if err != nil {
errs = append(errs, err)
}
err = FromEnvs(DefaultENVDelimiter)(c)
err = FromEnvs(ENVDelimiter)(c)
if err != nil {
errs = append(errs, err)
}
err = FromCli(DefaultCliDelimiter)(c)
err = FromCli(CLIDelimiter)(c)
if err != nil {
errs = append(errs, err)
}
Expand Down
8 changes: 4 additions & 4 deletions env_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ func TestEnvBasicTypes(t *testing.T) {
os.Setenv("b_bool", "true")
os.Setenv("thonku_complex_Mff", "toaster")

dummyConfig, err := LoadEnv[testStruct](DefaultENVDelimiter)
dummyConfig, err := LoadEnv[testStruct](ENVDelimiter)
if err != nil {
t.Fatal(err)
}
Expand All @@ -41,7 +41,7 @@ func TestEnvComplexTypes(t *testing.T) {
os.Setenv("basic_array", "item1,item2,item3")
os.Setenv("complex_array", "text1,text2,text3")

dummyConfig, err := LoadEnv[testCliStruct](DefaultENVDelimiter)
dummyConfig, err := LoadEnv[testCliStruct](ENVDelimiter)
if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -98,7 +98,7 @@ func TestEnvHelperMethod(t *testing.T) {
"Nested_NestedVal",
}

vals := GetGeneratedEnv[Small](DefaultENVDelimiter)
vals := GetGeneratedEnv[Small](ENVDelimiter)

if !reflect.DeepEqual(expectedContents, vals) {
t.Fatalf("expected %v got %v", expectedContents, vals)
Expand All @@ -114,7 +114,7 @@ func TestEnvTransform(t *testing.T) {
os.Setenv("BASIC_ARRAY", "item1,item2,item3")
os.Setenv("COMPLEX_ARRAY", "text1,text2,text3")

dummyConfig, err := LoadEnvWithTransform[testCliStruct](DefaultENVDelimiter, strings.ToUpper)
dummyConfig, err := LoadEnvWithTransform[testCliStruct](ENVDelimiter, strings.ToUpper)
if err != nil {
t.Fatal(err)
}
Expand Down
6 changes: 4 additions & 2 deletions types.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,10 @@ const (
)

const (
DefaultENVDelimiter = "_"
DefaultCliDelimiter = "."
// The default delimiter used for environment variable search
ENVDelimiter = "_"
// the default delimiter used for cli flag construction
CLIDelimiter = "."

LoggingDisabled = math.MaxInt
)
Expand Down

0 comments on commit 3769226

Please sign in to comment.