feat(jzero): refactor home/style flag and update docs

chore(deps): bump google.golang.org/protobuf from 1.36.10 to 1.36.11 (#345)

Bumps google.golang.org/protobuf from 1.36.10 to 1.36.11.

---
updated-dependencies:
- dependency-name: google.golang.org/protobuf
  dependency-version: 1.36.11
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

feat(docs): update

feat(docs): update

feat(template): update template.api.tpl

fix(jzero): fix gen with style

fix(jzero): fix new

fix(jzero): fix new

feat(jzero): refactor home/style flag and update docs

Author: jaronnie

README.md

@@ -42,6 +42,8 @@ jzero check
 # 一键创建项目
 jzero new your_project
 cd your_project
+# 下载依赖
+go mod tidy
 # 启动服务端程序
 go run main.go server
 # 访问 swagger ui
@@ -54,6 +56,8 @@ http://localhost:8001/swagger
 # 一键创建项目
 docker run --rm -v ${PWD}:/app ghcr.io/jzero-io/jzero:latest new your_project
 cd your_project 
+# 下载依赖
+go mod tidy
 # 启动服务端程序
 go run main.go server
 # 访问 swagger ui

cmd/jzero/.template/api/template.api.tpl

@@ -9,7 +9,7 @@ type CreateRequest {}
 type CreateResponse {}
 
 @server (
-    prefix: /api
+    prefix: /api/{{ .Group }}
     group:  {{ .Group }}
 )
 service {{ .Service }} {

cmd/jzero/.template/frame/api/app/.jzero.yaml.tpl

@@ -1,6 +1,6 @@
-gen:
+{{ if ne .Style "gozero" }}style: {{.Style}}
+
+{{ end }}gen:
     hooks:
         after:
-            - jzero gen swagger
-
-    style: {{.Style}}
+            - jzero gen swagger

cmd/jzero/.template/frame/gateway/app/.jzero.yaml.tpl

@@ -1,6 +1,6 @@
-gen:
+{{ if ne .Style "gozero" }}style: {{.Style}}
+
+{{ end }}gen:
     hooks:
         after:
-            - jzero gen swagger
-
-    style: {{.Style}}
+            - jzero gen swagger

cmd/jzero/.template/frame/rpc/app/.jzero.yaml.tpl

@@ -1,2 +1,3 @@
-gen:
-    style: {{.Style}}
+{{ if ne .Style "gozero" }}style: {{.Style}}
+
+{{ end }}

cmd/jzero/internal/command/gen/gen.go

@@ -70,8 +70,6 @@ var genSwaggerCmd = &cobra.Command{
 
 func GetCommand() *cobra.Command {
 	{
-		genCmd.PersistentFlags().StringP("style", "", "gozero", "The file naming format, see [https://github.com/zeromicro/go-zero/blob/master/tools/goctl/config/readme.md]")
-		genCmd.PersistentFlags().StringP("home", "", ".template", "set template home")
 		genCmd.PersistentFlags().StringSliceP("desc", "", []string{}, "set desc path")
 		genCmd.PersistentFlags().StringSliceP("desc-ignore", "", []string{}, "set desc ignore path")
 

cmd/jzero/internal/command/gen/gen/gen.go

@@ -26,11 +26,16 @@ import (
 
 func Run() error {
 	home, _ := os.UserHomeDir()
-	config.C.Gen.Home, _ = homedir.Expand(config.C.Gen.Home)
-	if !pathx.FileExists(config.C.Gen.Home) {
-		config.C.Gen.Home = filepath.Join(home, ".jzero", "templates", version.Version)
+	config.C.Home, _ = homedir.Expand(config.C.Home)
+	if !pathx.FileExists(config.C.Home) {
+		config.C.Home = filepath.Join(home, ".jzero", "templates", version.Version)
+	}
+	embeded.Home = config.C.Home
+
+	// 兼容之前的 gen style
+	if config.C.Gen.Style != "" && config.C.Gen.Style != "gozero" {
+		config.C.Style = config.C.Gen.Style
 	}
-	embeded.Home = config.C.Gen.Home
 
 	fmt.Printf("%s working dir %s\n", console.Green("Enter"), config.C.Wd())
 
@@ -50,7 +55,7 @@ func Run() error {
 	}
 
 	defer func() {
-		RemoveExtraFiles(config.C.Wd(), config.C.Gen.Style)
+		RemoveExtraFiles(config.C.Wd(), config.C.Style)
 	}()
 
 	jzeroModel := genmodel.JzeroModel{

cmd/jzero/internal/command/gen/genapi/genapi.go

@@ -193,7 +193,7 @@ func (ja *JzeroApi) generateApiCode() error {
 	}
 
 	// 如果用户自定义了模板，则复制覆盖
-	customTemplatePath := filepath.Join(config.C.Gen.Home, "go-zero", "api")
+	customTemplatePath := filepath.Join(config.C.Home, "go-zero", "api")
 	if pathx.FileExists(customTemplatePath) {
 		err = filex.CopyDir(customTemplatePath, filepath.Join(tempDir, "api"))
 		if err != nil {
@@ -253,7 +253,7 @@ func (ja *JzeroApi) generateApiCode() error {
 				return errors.Wrapf(err, "format api file: %s", v)
 			}
 
-			command := fmt.Sprintf("goctl api go --api %s --dir %s --home %s --style %s", v, dir, goctlHome, config.C.Gen.Style)
+			command := fmt.Sprintf("goctl api go --api %s --dir %s --home %s --style %s", v, dir, goctlHome, config.C.Style)
 			logx.Debugf("command: %s", command)
 			if _, err := execx.Run(command, config.C.Wd()); err != nil {
 				return errors.Wrapf(err, "api file: %s", v)

cmd/jzero/internal/command/gen/genapi/handler.go

@@ -42,7 +42,7 @@ func (ja *JzeroApi) getAllHandlerFiles(apiFilepath string, apiSpec *spec.ApiSpec
 	for _, group := range apiSpec.Service.Groups {
 		for _, route := range group.Routes {
 			formatContent := strings.TrimSuffix(route.Handler, "Handler") + "Handler"
-			namingFormat, err := format.FileNamingFormat(config.C.Gen.Style, formatContent)
+			namingFormat, err := format.FileNamingFormat(config.C.Style, formatContent)
 			if err != nil {
 				return nil, err
 			}
@@ -170,7 +170,7 @@ func (ja *JzeroApi) removeHandlerSuffix(f *ast.File) error {
 }
 
 func (ja *JzeroApi) compactHandler(f *dst.File, fset *token.FileSet, file HandlerFile) error {
-	namingFormat, err := format.FileNamingFormat(config.C.Gen.Style, filepath.Base(file.Group))
+	namingFormat, err := format.FileNamingFormat(config.C.Style, filepath.Base(file.Group))
 	if err != nil {
 		return err
 	}

cmd/jzero/internal/command/gen/genapi/logic.go

@@ -38,7 +38,7 @@ func (ja *JzeroApi) getAllLogicFiles(apiFilepath string, apiSpec *spec.ApiSpec)
 	var logicFiles []LogicFile
 	for _, group := range apiSpec.Service.Groups {
 		for _, route := range group.Routes {
-			namingFormat, err := format.FileNamingFormat(config.C.Gen.Style, strings.TrimSuffix(route.Handler, "Handler")+"Logic")
+			namingFormat, err := format.FileNamingFormat(config.C.Style, strings.TrimSuffix(route.Handler, "Handler")+"Logic")
 			if err != nil {
 				return nil, err
 			}