improve CLI with default values

improve doc generator for CLI

Author: marle3003

cmd/internal/gen-cli-docs/main.go

@@ -7,7 +7,7 @@ import (
 
 func main() {
 	cmd := mokapi.NewCmdMokapi()
-	err := cmd.GenMarkdown("./docs/cli")
+	err := cmd.GenMarkdown("./docs/configuration/static")
 	if err != nil {
 		fmt.Println(err.Error())
 	}

config/static/static_config.go

@@ -14,7 +14,7 @@ import (
 
 type Config struct {
 	Log              MokApiLog         `json:"log" yaml:"log"`
-	ConfigFile       string            `json:"-" yaml:"-" flag:"config-file"`
+	ConfigFile       string            `json:"-" yaml:"-" flag:"cli-input"`
 	Providers        Providers         `json:"providers" yaml:"providers"`
 	Api              Api               `json:"api" yaml:"api"`
 	RootCaCert       tls.FileOrContent `json:"rootCaCert" yaml:"rootCaCert" name:"root-ca-cert"`

pkg/cli/clitest/reader.go

@@ -0,0 +1,31 @@
+package clitest
+
+import (
+	"os"
+	"strings"
+)
+
+type TestFileReader struct {
+	Files map[string][]byte
+}
+
+func (t *TestFileReader) ReadFile(name string) ([]byte, error) {
+	if b, ok := t.Files[name]; ok {
+		return b, nil
+	}
+	// if test is executed on windows we get second path
+	name = strings.ReplaceAll(name, "\\", "/")
+	if b, ok := t.Files[name]; ok {
+		return b, nil
+	}
+	return nil, os.ErrNotExist
+}
+
+func (t *TestFileReader) FileExists(name string) bool {
+	if _, ok := t.Files[name]; ok {
+		return true
+	}
+	name = strings.ReplaceAll(name, "\\", "/")
+	_, ok := t.Files[name]
+	return ok
+}

pkg/cli/command.go

@@ -50,16 +50,6 @@ func (c *Command) Execute() error {
 		}
 	}
 
-	if !cmd.Flags().IsValidFlag("help") {
-		cmd.Flags().Bool("help", false, "Show help information and exit")
-	}
-
-	if cmd.Version != "" {
-		if !cmd.Flags().IsValidFlag("version") {
-			cmd.Flags().Bool("version", false, "Show version information and exit")
-		}
-	}
-
 	positional, err := parseFlags(args, envPrefix, cmd.Flags())
 	if err != nil {
 		return err
@@ -116,6 +106,12 @@ func (c *Command) Flags() *FlagSet {
 				c.configFile = s
 			},
 		}
+
+		c.Flags().Bool("help", false, FlagDoc{Short: "Show help information and exit"})
+
+		if c.Version != "" {
+			c.Flags().Bool("version", false, FlagDoc{Short: "Show version information and exit"})
+		}
 	}
 	return c.flags
 }

pkg/cli/command_test.go

@@ -23,7 +23,7 @@ func TestCommand(t *testing.T) {
 			name: "--foo",
 			cmd: func() *Command {
 				c := &Command{Name: "foo"}
-				c.Flags().Bool("foo", false, "")
+				c.Flags().Bool("foo", false, FlagDoc{})
 				return c
 			},
 			args: []string{"--foo"},
@@ -37,7 +37,7 @@ func TestCommand(t *testing.T) {
 			name: "-f",
 			cmd: func() *Command {
 				c := &Command{Name: "foo"}
-				c.Flags().BoolShort("foo", "f", false, "")
+				c.Flags().BoolShort("foo", "f", false, FlagDoc{})
 				return c
 			},
 			args: []string{"-f"},
@@ -51,7 +51,7 @@ func TestCommand(t *testing.T) {
 			name: "bind to config",
 			cmd: func() *Command {
 				c := &Command{Config: &config{}}
-				c.Flags().Bool("flag", false, "")
+				c.Flags().Bool("flag", false, FlagDoc{})
 				return c
 			},
 			args: []string{"--flag"},
@@ -65,7 +65,7 @@ func TestCommand(t *testing.T) {
 			name: "--count",
 			cmd: func() *Command {
 				c := &Command{Config: &config{}}
-				c.Flags().Int("count", 12, "")
+				c.Flags().Int("count", 12, FlagDoc{})
 				return c
 			},
 			args: []string{"--count", "10"},
@@ -78,7 +78,7 @@ func TestCommand(t *testing.T) {
 			name: "--count default",
 			cmd: func() *Command {
 				c := &Command{Config: &config{}}
-				c.Flags().Int("count", 12, "")
+				c.Flags().Int("count", 12, FlagDoc{})
 				return c
 			},
 			args: []string{},
@@ -91,7 +91,7 @@ func TestCommand(t *testing.T) {
 			name: "--skip-prefix",
 			cmd: func() *Command {
 				c := &Command{Config: &config{}}
-				c.Flags().StringSlice("skip-prefix", []string{"_"}, "", false)
+				c.Flags().StringSlice("skip-prefix", []string{"_"}, false, FlagDoc{})
 				return c
 			},
 			args: []string{"--skip-prefix", "_", "foo_"},
@@ -105,7 +105,7 @@ func TestCommand(t *testing.T) {
 			name: "--skip-prefix default",
 			cmd: func() *Command {
 				c := &Command{Config: &config{}}
-				c.Flags().StringSlice("skip-prefix", []string{"_"}, "", false)
+				c.Flags().StringSlice("skip-prefix", []string{"_"}, false, FlagDoc{})
 				return c
 			},
 			args: []string{},