Merge pull request #2 from AlgerDu/develop_20230408

发版前合并

Author: AlgerDu

README.md

@@ -6,4 +6,75 @@
 |:-:|:-|
 |内置命令|内置 `help` 、`version` 等命令，提供基础支持|
 |参数绑定|支持将 `flag` 参数绑定到 `struct`|
-|全局参数|通过管道模型支持添加自定义的全局参数，进行统一化处理|
+|全局参数|通过管道模型支持添加自定义的全局参数，进行统一化处理|
+## 示例
+
+### 定义命令及参数
+
+```
+type (
+	HelloCommandFlags struct {
+		Name      string
+		ClassRoom string `flag:"usage:学生的教师信息"`
+	}
+
+	HelloCommand struct {
+		*cli.BaseCommand
+	}
+)
+```
+### 创建命令实例及配置默认参数
+
+```
+var (
+	defaultHelloCommandFlags = &HelloCommandFlags{
+		Name: "ace",
+	}
+
+	helloCommand = &HelloCommand{
+		BaseCommand: &cli.BaseCommand{
+			Meta: &cli.CommandMeta{
+				Name:  "hello",
+				Usage: "say hello to someone",
+			},
+			DefaultFlags: defaultHelloCommandFlags,
+		},
+	}
+)
+```
+
+### 给 cli 应用添加命令
+
+```
+func main() {
+
+	builder := cli.NewBuilder("hello").
+		SetUsage("say hello to someone").
+		AddCommand(helloCommand)
+
+	app := builder.Build()
+	err := app.Run(os.Args)
+	if err != nil {
+		fmt.Print(err)
+	}
+}
+```
+
+## `flag` 结构体标签
+
+基本试用方式如下：
+
+```
+type HelloCommandFlags struct {
+	 	Name      string
+	 	ClassRoom string `flag:"name:class-room,usage:学生的教师信息"`
+	 }
+```
+
+支持的项：
+||示例|说明|
+|:-:|:-|:-|
+|`name`|`flag:"name:id"`|定义字段对应的命令行参数，默认是字段名称|
+|`aliases`|`flag:"aliases:id\|ID"`|定义一些别名，主要是为了简化参数的输入|
+|`require`|`flag:"require"`|是否为必填参数|
+|`usage`|`flag:"usage:help 提示信息"`|用于自动生成 help 命令时展示的提示信息|

v1/app.go

@@ -28,20 +28,11 @@ func newInnerApp() *innerApp {
 		GlobalFlags: []*GlobalFlag{},
 	}
 
-	app.pipelines = []PipelineAction{
-		app.checkGlobalFlags,
-		app.findCmdPipelineAction,
-		app.resolveFlagStruct,
-		app.runCmd,
-	}
-
 	return app
 }
 
 func (app *innerApp) Run(args []string) error {
 
-	fmt.Printf("args: %v\n", args)
-
 	context := newContext()
 	context.CommandPaths, context.UserSetFlags = app.anaylseArgs(args)
 
@@ -129,6 +120,10 @@ func (app *innerApp) findCmdPipelineAction(context *Context) error {
 
 func (app *innerApp) resolveFlagStruct(context *Context) error {
 
+	if context.toRunCmd.DefaultFlags == nil {
+		return nil
+	}
+
 	supportFlags := context.anaylseCmdSupportFlags(context.toRunCmd)
 	ctxValue := exts.Reflect_New(reflect.TypeOf(context.toRunCmd.DefaultFlags).Elem()).Interface()
 
@@ -154,7 +149,7 @@ func (app *innerApp) resolveFlagStruct(context *Context) error {
 			return fmt.Errorf("flag %s must set value", flag.Name)
 		}
 
-		if !set {
+		if !set && !flag.Multiple {
 			userSetValaues = append(userSetValaues, fmt.Sprintf("%v", flag.Default))
 		}
 

v1/builder.go

@@ -1,7 +1,8 @@
 package cli
 
 type defaultBuilder struct {
-	app *innerApp
+	app              *innerApp
+	pipelineSettings *PipelineSettings
 }
 
 func NewBuilder(name string) AppBuilder {
@@ -20,12 +21,17 @@ func (builder *defaultBuilder) SetUsage(usage string) AppBuilder {
 	return builder
 }
 
+func (builder *defaultBuilder) SetPipeline(settings *PipelineSettings) AppBuilder {
+	builder.pipelineSettings = settings
+	return builder
+}
+
 func (builder *defaultBuilder) AddCommand(command Command, opt ...AddCommandOption) AppBuilder {
 
 	innerCommand := NewInnerCommand(command)
 
 	if innerCommand.Name == "" {
-		builder.app.Action = innerCommand.Action
+		builder.app.innerCommand = innerCommand
 		innerCommand = builder.app.innerCommand
 
 		for _, option := range opt {
@@ -44,15 +50,17 @@ func (builder *defaultBuilder) Build() App {
 	builder.useHelp()
 	builder.useVersion()
 
+	builder.buildPipelines()
+
 	return builder.app
 }
 
 func (builder *defaultBuilder) useHelp() {
 
 	builder.app.GlobalFlags = append(builder.app.GlobalFlags, helpGloblaFlag)
 
-	innerHelpCmd := newHelp(builder.app)
-	builder.AddCommand(innerHelpCmd)
+	cmd := newHelp(builder.app)
+	builder.AddCommand(cmd)
 }
 
 func (builder *defaultBuilder) useVersion() {
@@ -61,6 +69,27 @@ func (builder *defaultBuilder) useVersion() {
 
 	builder.app.GlobalFlags = append(builder.app.GlobalFlags, versionGloblaFlag)
 
-	innerHelpCmd := newVersion(builder.app)
-	builder.AddCommand(innerHelpCmd)
+	cmd := newVersion(builder.app)
+	builder.AddCommand(cmd)
+}
+
+func (builder *defaultBuilder) buildPipelines() {
+	settings := builder.pipelineSettings
+	if settings == nil {
+		settings = &PipelineSettings{}
+	}
+
+	settings.checkGlobalFlags = []PipelineAction{builder.app.checkGlobalFlags}
+	settings.findCmd = builder.app.findCmdPipelineAction
+	settings.resolveFlag = builder.app.resolveFlagStruct
+	settings.runCmd = builder.app.runCmd
+
+	pipelines := []PipelineAction{}
+	pipelines = append(pipelines, settings.BeferCheckGlobalFlags...)
+	pipelines = append(pipelines, settings.checkGlobalFlags...)
+	pipelines = append(pipelines, settings.findCmd)
+	pipelines = append(pipelines, settings.resolveFlag)
+	pipelines = append(pipelines, settings.runCmd)
+
+	builder.app.pipelines = pipelines
 }

v1/cli.go

@@ -9,6 +9,16 @@ type (
 
 	PipelineAction func(*Context) error
 
+	// 管道的配置
+	PipelineSettings struct {
+		BeferCheckGlobalFlags []PipelineAction // 可以用来做一些初始化的工作
+
+		checkGlobalFlags []PipelineAction // 检查全局 flag
+		findCmd          PipelineAction   // 查找要执行的命令
+		resolveFlag      PipelineAction   // 将用户设置的 flags 解析为要执行命令的 flas 结构体，方便使用
+		runCmd           PipelineAction   // 运行命令
+	}
+
 	Command interface {
 		GetDescripton() *CommandMeta
 		GetDefaultFlags() any
@@ -28,6 +38,7 @@ type (
 	AppBuilder interface {
 		SetVersion(version string) AppBuilder
 		SetUsage(usage string) AppBuilder
+		SetPipeline(settings *PipelineSettings) AppBuilder
 		AddCommand(Command, ...AddCommandOption) AppBuilder
 		Build() App
 	}

v1/context.go

@@ -2,6 +2,7 @@ package cli
 
 import (
 	"os"
+	"strings"
 )
 
 type (
@@ -24,6 +25,7 @@ type (
 		Stdout       Stdout
 
 		Value any
+		Items map[string]any
 
 		toRunCmd *innerCommand
 	}
@@ -32,6 +34,7 @@ type (
 func newContext() *Context {
 
 	wd, _ := os.Getwd()
+	wd = strings.ReplaceAll(wd, "\\", "/")
 
 	return &Context{
 		WorkDir: wd,
@@ -40,6 +43,8 @@ func newContext() *Context {
 		UserSetFlags: map[string][]string{},
 
 		Stdout: newStdout(),
+
+		Items: map[string]any{},
 	}
 }
 

v1/flag.go

@@ -173,12 +173,23 @@ func bindFlagsToStruct(value string, flag *Flag, dst any) error {
 		}
 	}
 
-	v, err := exts.Reflect_ParseString(value, fieldValue.Kind())
-	if err != nil {
-		return err
-	}
+	if exts.Reflect_IsArray(fieldValue.Type()) {
+
+		v, err := exts.Reflect_ParseString(value, fieldValue.Type().Elem().Kind())
+		if err != nil {
+			return err
+		}
+
+		fieldValue.Set(reflect.Append(fieldValue, v))
 
-	fieldValue.Set(v)
+	} else {
+		v, err := exts.Reflect_ParseString(value, fieldValue.Kind())
+		if err != nil {
+			return err
+		}
+
+		fieldValue.Set(v)
+	}
 	return nil
 }
 

v1/help.go

@@ -57,7 +57,10 @@ func newHelp(
 
 func (cmd *HelpCommand) Action(c *Context) error {
 
-	flags := c.Value.(*helpCommandFlag)
+	flags := &helpCommandFlag{}
+	if c.Value != nil {
+		flags = c.Value.(*helpCommandFlag)
+	}
 
 	toDescriptCmd, exist := cmd.app.findCmd(flags.CmdPaths...)
 	if !exist {