feat(hz): add plugin flag (#315)

cmd/hz/go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/cloudwego/thriftgo v0.1.7
 	github.com/hashicorp/go-version v1.5.0
 	github.com/jhump/protoreflect v1.12.0
-	github.com/urfave/cli/v2 v2.20.2
+	github.com/urfave/cli/v2 v2.23.0
 	google.golang.org/protobuf v1.28.0
 	gopkg.in/yaml.v2 v2.4.0
 )

cmd/hz/go.sum

@@ -55,8 +55,8 @@ github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
-github.com/urfave/cli/v2 v2.20.2 h1:dKA0LUjznZpwmmbrc0pOgcLTEilnHeM8Av9Yng77gHM=
-github.com/urfave/cli/v2 v2.20.2/go.mod h1:1CNUng3PtjQMtRzJO4FMXBQvkGtuYRxxiR9xMa7jMwI=
+github.com/urfave/cli/v2 v2.23.0 h1:pkly7gKIeYv3olPAeNajNpLjeJrmTPYCoZWaV+2VfvE=
+github.com/urfave/cli/v2 v2.23.0/go.mod h1:1CNUng3PtjQMtRzJO4FMXBQvkGtuYRxxiR9xMa7jMwI=
 github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU=
 github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=

cmd/hz/internal/app/app.go

@@ -113,6 +113,8 @@ func Init() *cli.App {
 	excludeFilesFlag := cli.StringSliceFlag{Name: "exclude_file", Aliases: []string{"E"}, Usage: "Specify the files that do not need to be updated."}
 	thriftOptionsFlag := cli.StringSliceFlag{Name: "thriftgo", Aliases: []string{"t"}, Usage: "Specify arguments for the thriftgo. ({flag}={value})"}
 	protoOptionsFlag := cli.StringSliceFlag{Name: "protoc", Aliases: []string{"p"}, Usage: "Specify arguments for the protoc. ({flag}={value})"}
+	thriftPluginsFlag := cli.StringSliceFlag{Name: "thrift-plugins", Usage: "Specify plugins for the thriftgo. ({plugin_name}:{options})"}
+	protoPluginsFlag := cli.StringSliceFlag{Name: "protoc-plugins", Usage: "Specify plugins for the protoc. ({plugin_name}:{options}:{out_dir})"}
 	noRecurseFlag := cli.BoolFlag{Name: "no_recurse", Usage: "Generate master model only.", Destination: &globalArgs.NoRecurse}
 
 	jsonEnumStrFlag := cli.BoolFlag{Name: "json_enumstr", Usage: "Use string instead of num for json enums when idl is thrift.", Destination: &globalArgs.JSONEnumStr}
@@ -126,6 +128,8 @@ func Init() *cli.App {
 	app.Name = "hz"
 	app.Usage = "A idl parser and code generator for Hertz projects"
 	app.Version = meta.Version
+	// The default separator for multiple parameters is modified to ";"
+	app.SliceFlagSeparator = ";"
 
 	// global flags
 	app.Flags = []cli.Flag{
@@ -158,6 +162,8 @@ func Init() *cli.App {
 				&excludeFilesFlag,
 				&customLayout,
 				&customPackage,
+				&protoPluginsFlag,
+				&thriftPluginsFlag,
 			},
 			Action: New,
 		},
@@ -182,6 +188,8 @@ func Init() *cli.App {
 				&snakeNameFlag,
 				&excludeFilesFlag,
 				&customPackage,
+				&protoPluginsFlag,
+				&thriftPluginsFlag,
 			},
 			Action: Update,
 		},

cmd/hz/internal/config/argument.go

@@ -51,13 +51,15 @@ type Argument struct {
 	Gopkg       string // $GOPATH/src/{{gopkg}}
 	ServiceName string // service name
 
-	JSONEnumStr    bool
-	UnsetOmitempty bool
-	ProtocOptions  []string // options to pass through to protoc
-	ThriftOptions  []string // options to pass through to thriftgo
-	SnakeName      bool
-	Excludes       []string
-	NoRecurse      bool
+	JSONEnumStr     bool
+	UnsetOmitempty  bool
+	ProtocOptions   []string // options to pass through to protoc
+	ThriftOptions   []string // options to pass through to thriftgo for go flag
+	ProtobufPlugins []string
+	ThriftPlugins   []string
+	SnakeName       bool
+	Excludes        []string
+	NoRecurse       bool
 
 	CustomizeLayout  string
 	CustomizePackage string
@@ -106,6 +108,8 @@ func (arg *Argument) parseStringSlice(c *cli.Context) {
 	arg.RawOptPkg = c.StringSlice("option_package")
 	arg.ThriftOptions = c.StringSlice("thriftgo")
 	arg.ProtocOptions = c.StringSlice("protoc")
+	arg.ThriftPlugins = c.StringSlice("thrift-plugins")
+	arg.ProtobufPlugins = c.StringSlice("protoc-plugins")
 }
 
 // checkPath sets the project path and verifies that the model、handler、router and client path is compliant

cmd/hz/internal/config/cmd.go

@@ -169,6 +169,9 @@ func BuildPluginCmd(args *Argument) (*exec.Cmd, error) {
 			"-g", thriftOpt,
 			"-p", "hertz:"+kas,
 		)
+		for _, p := range args.ThriftPlugins {
+			cmd.Args = append(cmd.Args, "-p", p)
+		}
 		if !args.NoRecurse {
 			cmd.Args = append(cmd.Args, "-r")
 		}
@@ -185,6 +188,19 @@ func BuildPluginCmd(args *Argument) (*exec.Cmd, error) {
 			"--hertz_out="+args.OutDir,
 			"--hertz_opt="+kas,
 		)
+		for _, p := range args.ProtobufPlugins {
+			pluginParams := strings.Split(p, ":")
+			if len(pluginParams) != 3 {
+				logs.Warnf("Failed to get the correct protoc plugin parameters for %. "+
+					"Please specify the protoc plugin in the form of \"plugin_name:options:out_dir\"", p)
+				os.Exit(1)
+			}
+			// pluginParams[0] -> plugin name, pluginParams[1] -> plugin options, pluginParams[2] -> out_dir
+			cmd.Args = append(cmd.Args,
+				fmt.Sprintf("--%s_out=%s", pluginParams[0], pluginParams[2]),
+				fmt.Sprintf("--%s_opt=%s", pluginParams[0], pluginParams[1]),
+			)
+		}
 		for _, kv := range args.ProtocOptions {
 			cmd.Args = append(cmd.Args, "--"+kv)
 		}