From 6f217e968672cac62cfb06be35b10c5edfa3212b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lubo=C5=A1=20Pokorn=C3=BD?= Date: Sun, 10 Dec 2023 14:48:13 +0100 Subject: [PATCH] =?UTF-8?q?refactor:=20=E2=99=BB=EF=B8=8F=20address=20seve?= =?UTF-8?q?ral=20minor=20potential=20lint=20errors=20(#48)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * refactor: ♻️ address several minor potential lit errors * disable MD013 for code --- README.md | 20 +++++++++----------- example_test.go | 18 +++++++----------- options_example_test.go | 15 ++++++++++----- parser_test.go | 2 +- parser_types_test.go | 4 ++-- value/bool.go | 2 +- value/bool_test.go | 2 +- 7 files changed, 31 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 990eccf..063a720 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ ## Example - + ```go type config struct { @@ -47,22 +47,20 @@ _ = os.Setenv("MY_DURATION_VALUE", "1h") err := y.Parse(args) if err != nil { - os.Exit(2) + fmt.Printf("Error: %v\n", err) + return } -fmt.Printf("config.Str: %v\n", cfg.Str) -fmt.Printf("config.Int: %v\n", cfg.Int) -fmt.Printf("config.Bool %v\n", cfg.Bool) -fmt.Printf("config.Duration: %v\n", cfg.Duration) +fmt.Printf("config.Str: %v, ", cfg.Str) +fmt.Printf("config.Int: %v, ", cfg.Int) +fmt.Printf("config.Bool: %v, ", cfg.Bool) +fmt.Printf("config.Duration: %v", cfg.Duration) // Output: -// config.Str: str flag value -// config.Int: 4 -// config.Bool: false -// config.Duration: 1h0m0s +// config.Str: str flag value, config.Int: 4, config.Bool: false, config.Duration: 1h0m0s ``` - + ## Supported types diff --git a/example_test.go b/example_test.go index 44bf4c1..accb1c5 100644 --- a/example_test.go +++ b/example_test.go @@ -35,19 +35,15 @@ func Example() { err := y.Parse(args) if err != nil { - os.Exit(2) + fmt.Printf("Error: %v\n", err) + return } - fmt.Printf("config.Str: %v\n", cfg.Str) - fmt.Printf("config.Int: %v\n", cfg.Int) - fmt.Printf("config.Bool %v\n", cfg.Bool) - fmt.Printf("config.Duration: %v\n", cfg.Duration) + fmt.Printf("config.Str: %v, ", cfg.Str) + fmt.Printf("config.Int: %v, ", cfg.Int) + fmt.Printf("config.Bool: %v, ", cfg.Bool) + fmt.Printf("config.Duration: %v", cfg.Duration) // Output: - // config.Str: str flag value - // config.Int: 4 - // config.Bool: false - // config.Duration: 1h0m0s - - // + // config.Str: str flag value, config.Int: 4, config.Bool: false, config.Duration: 1h0m0s } diff --git a/options_example_test.go b/options_example_test.go index 6518759..ef68611 100644 --- a/options_example_test.go +++ b/options_example_test.go @@ -24,7 +24,8 @@ func ExampleWithEnvPrefix() { err := y.Parse([]string{}) if err != nil { - os.Exit(2) + fmt.Printf("Error: %v\n", err) + return } fmt.Printf(cfg.Foo) @@ -49,7 +50,8 @@ func ExampleFromEnv() { err := y.Parse([]string{}) if err != nil { - os.Exit(2) + fmt.Printf("Error: %v\n", err) + return } fmt.Printf(cfg.Foo) @@ -90,7 +92,8 @@ func ExampleRequired_flagOk() { err := y.Parse([]string{"-foo=foo_value"}) if err != nil { - os.Exit(2) + fmt.Printf("Error: %v\n", err) + return } fmt.Print(cfg.Foo) @@ -114,7 +117,8 @@ func ExampleRequired_envOnlyOk() { err := y.Parse([]string{}) if err != nil { - os.Exit(2) + fmt.Printf("Error: %v\n", err) + return } fmt.Print(cfg.Foo) @@ -158,7 +162,8 @@ func ExampleNoEnv() { _ = os.Setenv("FOO", "Foo from the environment variable ") err := y.Parse([]string{}) if err != nil { - os.Exit(2) + fmt.Printf("Error: %v\n", err) + return } fmt.Printf(cfg.Foo) diff --git a/parser_test.go b/parser_test.go index bd0e116..e44d214 100644 --- a/parser_test.go +++ b/parser_test.go @@ -7,7 +7,7 @@ import ( "github.com/zoido/yag-config" ) -func TestNew_Ok(t *testing.T) { +func TestNew_Ok(_ *testing.T) { // When yag.New() diff --git a/parser_types_test.go b/parser_types_test.go index b3a7408..d99ce9f 100644 --- a/parser_types_test.go +++ b/parser_types_test.go @@ -267,12 +267,12 @@ type testFlagValue struct { called bool } -func (tfv *testFlagValue) Set(val string) error { +func (tfv *testFlagValue) Set(_ string) error { tfv.called = true return nil } -func (tfv *testFlagValue) String() string { +func (*testFlagValue) String() string { return "test_flag_value" } diff --git a/value/bool.go b/value/bool.go index 8556d2a..3832ba2 100644 --- a/value/bool.go +++ b/value/bool.go @@ -13,7 +13,7 @@ func Bool(dest *bool) flag.Value { // IsBoolFlag returns true if the flag.Value implementation has an IsBoolFlag() bool // method returning true. // This is used by the flag package commandline-parser for flags that can be supplied -// without "=value" text +// without "=value" text. func IsBoolFlag(v flag.Value) bool { type boolFlag interface { flag.Value diff --git a/value/bool_test.go b/value/bool_test.go index b104056..65f429e 100644 --- a/value/bool_test.go +++ b/value/bool_test.go @@ -74,7 +74,7 @@ func TestIsBooleanFlag_BoolFlagTrue(t *testing.T) { type normalFlagValue struct{} -func (*normalFlagValue) Set(v string) error { +func (*normalFlagValue) Set(_ string) error { return nil }