adjust print font color

Author: zhufuyi

cmd/sponge/commands/generate/cache.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 
 	"github.com/zhufuyi/sponge/pkg/replacer"
@@ -28,7 +29,7 @@ func CacheCommand(parentName string) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "cache",
 		Short: "Generate cache code",
-		Long: fmt.Sprintf(`generate cache code.
+		Long: color.HiBlackString(fmt.Sprintf(`generate cache code.
 
 Examples:
   # generate kv cache code
@@ -38,7 +39,7 @@ Examples:
   sponge %s cache --module-name=yourModuleName --cache-name=token --prefix-key=user:token: --key-name=id --key-type=uint64 --value-name=token --value-type=string --out=./yourServerDir
 
   # if you want the generated code to suited to mono-repo, you need to specify the parameter --suited-mono-repo=true --serverName=yourServerName
-`, parentName, parentName),
+`, parentName, parentName)),
 		SilenceErrors: true,
 		SilenceUsage:  true,
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -101,8 +102,7 @@ using help:
 	_ = cmd.MarkFlagRequired("value-type")
 	cmd.Flags().StringVarP(&serverName, "server-name", "s", "", "server name")
 	cmd.Flags().BoolVarP(&suitedMonoRepo, "suited-mono-repo", "l", false, "whether the generated code is suitable for mono-repo")
-	cmd.Flags().StringVarP(&outPath, "out", "o", "", "output directory, default is ./cache_<time>,"+
-		" if you specify the directory where the web or microservice generated by sponge, the module-name flag can be ignored")
+	cmd.Flags().StringVarP(&outPath, "out", "o", "", "output directory, default is ./cache_<time>, "+flagTip("module-name"))
 
 	return cmd
 }

cmd/sponge/commands/generate/common.go

@@ -20,7 +20,7 @@ import (
 )
 
 const (
-	defaultGoModVersion = "go 1.19"
+	defaultGoModVersion = "go 1.20"
 
 	// TplNameSponge name of the template
 	TplNameSponge = "sponge"
@@ -54,6 +54,12 @@ const (
 	codeNameGRPCHTTP    = "grpc-http-pb"
 	codeNameGRPCConn    = "grpc-conn"
 	codeNameProtobuf    = "protobuf"
+
+	wellPrefix    = "## "
+	mgoSuffix     = ".mgo"
+	pkgPathSuffix = "/pkg"
+	expSuffix     = ".exp"
+	apiDocsSuffix = " api docs"
 )
 
 var (
@@ -713,3 +719,14 @@ func getLocalGoVersion() string {
 
 	return localGoVersion
 }
+
+func dbDriverErr(driver string) error {
+	return errors.New("unsupported db driver: " + driver)
+}
+
+func flagTip(name ...string) string {
+	if len(name) == 2 {
+		return fmt.Sprintf("if you specify the directory where the web or microservice generated by sponge, the %s and %s flag can be ignored", name[0], name[1])
+	}
+	return fmt.Sprintf("if you specify the directory where the web or microservice generated by sponge, the %s flag can be ignored", name[0])
+}

cmd/sponge/commands/generate/config.go

@@ -8,6 +8,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 
 	"github.com/zhufuyi/sponge/pkg/gofile"
@@ -29,15 +30,15 @@ func ConfigCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "config",
 		Short: "Generate go config code from yaml file",
-		Long: `generate go config code from yaml file.
+		Long: color.HiBlackString(`generate go config code from yaml file.
 
 Examples:
   # generate config code in server directory, the yaml configuration file must be in <yourServerDir>/configs directory.
   sponge config --server-dir=/yourServerDir
 
   # generate config code from yaml file.
   sponge config --yaml-file=yourConfig.yml
-`,
+`),
 		SilenceErrors: true,
 		SilenceUsage:  true,
 		RunE: func(cmd *cobra.Command, args []string) error {

cmd/sponge/commands/generate/configmap.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/fatih/color"
 	"github.com/huandu/xstrings"
 	"github.com/spf13/cobra"
 
@@ -22,15 +23,15 @@ func ConfigmapCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "configmap",
 		Short: "Generate k8s configmap",
-		Long: `generate k8s configmap.
+		Long: color.HiBlackString(`generate k8s configmap.
 
 Examples:
   # generate k8s configmap
   sponge configmap --server-name=yourServerName --project-name=yourProjectName --config-file=yourConfigFile.yml
 
   # generate grpc connection code and specify the server directory, Note: code generation will be canceled when the latest generated file already exists.
   sponge configmap --server-name=yourServerName --project-name=yourProjectName --config-file=yourConfigFile.yml --out=./yourServerDir
-`,
+`),
 		SilenceErrors: true,
 		SilenceUsage:  true,
 		RunE: func(cmd *cobra.Command, args []string) error {

cmd/sponge/commands/generate/dao.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 
 	"github.com/zhufuyi/sponge/pkg/replacer"
@@ -33,7 +34,7 @@ func DaoCommand(parentName string) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "dao",
 		Short: "Generate dao code based on sql",
-		Long: fmt.Sprintf(`generate dao code based on sql.
+		Long: color.HiBlackString(fmt.Sprintf(`generate dao code based on sql.
 
 Examples:
   # generate dao code.
@@ -49,7 +50,7 @@ Examples:
   sponge %s dao --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --out=./yourServerDir
 
   # if you want the generated code to suited to mono-repo, you need to specify the parameter --suited-mono-repo=true --serverName=yourServerName
-`, parentName, parentName, parentName, parentName),
+`, parentName, parentName, parentName, parentName)),
 		SilenceErrors: true,
 		SilenceUsage:  true,
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -130,8 +131,7 @@ using help:
 	cmd.Flags().StringVarP(&serverName, "server-name", "s", "", "server name")
 	cmd.Flags().BoolVarP(&suitedMonoRepo, "suited-mono-repo", "l", false, "whether the generated code is suitable for mono-repo")
 	cmd.Flags().IntVarP(&sqlArgs.JSONNamedType, "json-name-type", "j", 1, "json tags name type, 0:snake case, 1:camel case")
-	cmd.Flags().StringVarP(&outPath, "out", "o", "", "output directory, default is ./dao_<time>, "+
-		"if you specify the directory where the web or microservice generated by sponge, the module-name flag can be ignored")
+	cmd.Flags().StringVarP(&outPath, "out", "o", "", "output directory, default is ./dao_<time>, "+flagTip("module-name"))
 	cmd.Flags().BoolVarP(&isIncludeInitDB, "include-init-db", "i", false, "if true, includes mysql and redis initialization code")
 
 	return cmd
@@ -201,7 +201,7 @@ func (g *daoGenerator) generateCode() (string, error) {
 		}
 
 	default:
-		return "", errors.New("unsupported db driver: " + g.dbDriver)
+		return "", dbDriverErr(g.dbDriver)
 	}
 
 	subFiles = append(subFiles, getSubFiles(selectFiles, replaceFiles)...)
@@ -243,7 +243,7 @@ func (g *daoGenerator) addFields(r replacer.Replacer) []replacer.Field {
 			New: g.moduleName,
 		},
 		{
-			Old: g.moduleName + "/pkg",
+			Old: g.moduleName + pkgPathSuffix,
 			New: "github.com/zhufuyi/sponge/pkg",
 		},
 		{
@@ -277,8 +277,8 @@ func daoExtendedAPI(r replacer.Replacer) (map[string][]string, []replacer.Field)
 	}
 	var fields []replacer.Field
 
-	fields = append(fields, deleteFieldsMark(r, daoFile+".exp", startMark, endMark)...)
-	fields = append(fields, deleteFieldsMark(r, daoTestFile+".exp", startMark, endMark)...)
+	fields = append(fields, deleteFieldsMark(r, daoFile+expSuffix, startMark, endMark)...)
+	fields = append(fields, deleteFieldsMark(r, daoTestFile+expSuffix, startMark, endMark)...)
 
 	fields = append(fields, []replacer.Field{
 		{
@@ -306,7 +306,7 @@ func daoMongoDBExtendedAPI(r replacer.Replacer) (map[string][]string, []replacer
 
 	var fields []replacer.Field
 
-	fields = append(fields, deleteFieldsMark(r, daoMgoFile+".exp", startMark, endMark)...)
+	fields = append(fields, deleteFieldsMark(r, daoMgoFile+expSuffix, startMark, endMark)...)
 
 	fields = append(fields, []replacer.Field{
 		{

cmd/sponge/commands/generate/grpc-http-pb.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/fatih/color"
 	"github.com/huandu/xstrings"
 	"github.com/spf13/cobra"
 
@@ -26,7 +27,7 @@ func GRPCAndHTTPPbCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "grpc-http-pb",
 		Short: "Generate grpc+http service code based on protobuf file",
-		Long: `generate grpc+http service code based on protobuf file.
+		Long: color.HiBlackString(`generate grpc+http service code based on protobuf file.
 
 Examples:
   # generate grpc service code.
@@ -39,7 +40,7 @@ Examples:
   sponge micro grpc-http-pb --module-name=yourModuleName --server-name=yourServerName --project-name=yourProjectName --repo-addr=192.168.3.37:9443/user-name --protobuf-file=./demo.proto
 
   # if you want the generated code to suited to mono-repo, you need to specify the parameter --suited-mono-repo=true
-`,
+`),
 		SilenceErrors: true,
 		SilenceUsage:  true,
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -196,7 +197,7 @@ func (g *httpAndGRPCPbGenerator) addFields(r replacer.Replacer) []replacer.Field
 	fields = append(fields, deleteAllFieldsMark(r, protoShellFile, wellStartMark, wellEndMark)...)
 	fields = append(fields, deleteAllFieldsMark(r, appConfigFile, wellStartMark, wellEndMark)...)
 	//fields = append(fields, deleteFieldsMark(r, deploymentConfigFile, wellStartMark, wellEndMark)...)
-	fields = append(fields, replaceFileContentMark(r, readmeFile, "## "+g.serverName)...)
+	fields = append(fields, replaceFileContentMark(r, readmeFile, wellPrefix+g.serverName)...)
 	fields = append(fields, []replacer.Field{
 		{ // replace the configuration of the *.yml file
 			Old: appConfigFileMark,
@@ -255,7 +256,7 @@ func (g *httpAndGRPCPbGenerator) addFields(r replacer.Replacer) []replacer.Field
 			New: g.moduleName,
 		},
 		{
-			Old: g.moduleName + "/pkg",
+			Old: g.moduleName + pkgPathSuffix,
 			New: "github.com/zhufuyi/sponge/pkg",
 		},
 		{ // replace the sponge version of the go.mod file
@@ -264,7 +265,7 @@ func (g *httpAndGRPCPbGenerator) addFields(r replacer.Replacer) []replacer.Field
 		},
 		{
 			Old: "sponge api docs",
-			New: g.serverName + " api docs",
+			New: g.serverName + apiDocsSuffix,
 		},
 		{
 			Old: defaultGoModVersion,

cmd/sponge/commands/generate/handler-pb.go

@@ -6,6 +6,7 @@ import (
 	"math/rand"
 	"strings"
 
+	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 
 	"github.com/zhufuyi/sponge/pkg/gofile"
@@ -35,7 +36,7 @@ func HandlerPbCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "handler-pb",
 		Short: "Generate handler and protobuf CRUD code based on sql",
-		Long: `generate handler and protobuf CRUD code based on sql.
+		Long: color.HiBlackString(`generate handler and protobuf CRUD code based on sql.
 
 Examples:
   # generate handler and protobuf code.
@@ -49,7 +50,7 @@ Examples:
 
   # generate handler and protobuf code and specify the server directory, Note: code generation will be canceled when the latest generated file already exists.
   sponge web handler-pb --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --out=./yourServerDir
-`,
+`),
 		SilenceErrors: true,
 		SilenceUsage:  true,
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -128,8 +129,7 @@ using help:
 	cmd.Flags().BoolVarP(&sqlArgs.IsExtendedAPI, "extended-api", "a", false, "whether to generate extended crud api, additional includes: DeleteByIDs, GetByCondition, ListByIDs, ListByLatestID")
 	cmd.Flags().BoolVarP(&suitedMonoRepo, "suited-mono-repo", "l", false, "whether the generated code is suitable for mono-repo")
 	cmd.Flags().IntVarP(&sqlArgs.JSONNamedType, "json-name-type", "j", 1, "json tags name type, 0:snake case, 1:camel case")
-	cmd.Flags().StringVarP(&outPath, "out", "o", "", "output directory, default is ./handler-pb_<time>,"+
-		" if you specify the directory where the web or microservice generated by sponge, the module-name and server-name flag can be ignored")
+	cmd.Flags().StringVarP(&outPath, "out", "o", "", "output directory, default is ./handler-pb_<time>, "+flagTip("module-name", "server-name"))
 
 	return cmd
 }
@@ -209,11 +209,11 @@ func (g *handlerPbGenerator) generateCode() (string, error) {
 					"userExample_logic.go.mgo",
 				},
 			}
-			g.fields = append(g.fields, deleteFieldsMark(r, handlerLogicFile+".mgo", startMark, endMark)...)
+			g.fields = append(g.fields, deleteFieldsMark(r, handlerLogicFile+mgoSuffix, startMark, endMark)...)
 		}
 
 	default:
-		return "", errors.New("unsupported db driver: " + g.dbDriver)
+		return "", dbDriverErr(g.dbDriver)
 	}
 
 	subFiles = append(subFiles, getSubFiles(selectFiles, replaceFiles)...)
@@ -283,7 +283,7 @@ func (g *handlerPbGenerator) addFields(r replacer.Replacer) []replacer.Field {
 			New: fmt.Sprintf("userExampleNO = %d", rand.Intn(99)+1),
 		},
 		{
-			Old: g.moduleName + "/pkg",
+			Old: g.moduleName + pkgPathSuffix,
 			New: "github.com/zhufuyi/sponge/pkg",
 		},
 		{
@@ -341,9 +341,9 @@ func handlerPbExtendedAPI(r replacer.Replacer) (map[string][]string, []replacer.
 
 	var fields []replacer.Field
 
-	fields = append(fields, deleteFieldsMark(r, daoFile+".exp", startMark, endMark)...)
-	fields = append(fields, deleteFieldsMark(r, daoTestFile+".exp", startMark, endMark)...)
-	fields = append(fields, deleteFieldsMark(r, handlerLogicFile+".exp", startMark, endMark)...)
+	fields = append(fields, deleteFieldsMark(r, daoFile+expSuffix, startMark, endMark)...)
+	fields = append(fields, deleteFieldsMark(r, daoTestFile+expSuffix, startMark, endMark)...)
+	fields = append(fields, deleteFieldsMark(r, handlerLogicFile+expSuffix, startMark, endMark)...)
 
 	fields = append(fields, []replacer.Field{
 		{
@@ -389,7 +389,7 @@ func handlerPbMongoDBExtendedAPI(r replacer.Replacer) (map[string][]string, []re
 
 	var fields []replacer.Field
 
-	fields = append(fields, deleteFieldsMark(r, daoMgoFile+".exp", startMark, endMark)...)
+	fields = append(fields, deleteFieldsMark(r, daoMgoFile+expSuffix, startMark, endMark)...)
 	fields = append(fields, deleteFieldsMark(r, handlerLogicFile+".mgo.exp", startMark, endMark)...)
 
 	fields = append(fields, []replacer.Field{