feat: Support projectPkg template variables in config, handler, logic, main, svc template files

geekeryy · kevwan · commit 9ebb810c2503 · 2025-06-12T00:04:46.000+08:00
diff --git a/tools/goctl/api/gogen/gen.go b/tools/goctl/api/gogen/gen.go
@@ -90,23 +90,23 @@ func DoGenProject(apiFile, dir, style string, withTest bool) error {
 	}
 
 	logx.Must(pathx.MkdirIfNotExist(dir))
-	rootPkg, err := golang.GetParentPackage(dir)
+	rootPkg, projectPkg, err := golang.GetParentPackage(dir)
 	if err != nil {
 		return err
 	}
 
 	logx.Must(genEtc(dir, cfg, api))
-	logx.Must(genConfig(dir, rootPkg, cfg, api))
-	logx.Must(genMain(dir, rootPkg, cfg, api))
-	logx.Must(genServiceContext(dir, rootPkg, cfg, api))
+	logx.Must(genConfig(dir, projectPkg, cfg, api))
+	logx.Must(genMain(dir, rootPkg, projectPkg, cfg, api))
+	logx.Must(genServiceContext(dir, rootPkg, projectPkg, cfg, api))
 	logx.Must(genTypes(dir, cfg, api))
-	logx.Must(genRoutes(dir, rootPkg, cfg, api))
-	logx.Must(genHandlers(dir, rootPkg, cfg, api))
-	logx.Must(genLogic(dir, rootPkg, cfg, api))
+	logx.Must(genRoutes(dir, rootPkg, projectPkg, cfg, api))
+	logx.Must(genHandlers(dir, rootPkg, projectPkg, cfg, api))
+	logx.Must(genLogic(dir, rootPkg, projectPkg, cfg, api))
 	logx.Must(genMiddleware(dir, cfg, api))
 	if withTest {
-		logx.Must(genHandlersTest(dir, rootPkg, cfg, api))
-		logx.Must(genLogicTest(dir, rootPkg, cfg, api))
+		logx.Must(genHandlersTest(dir, rootPkg, projectPkg, cfg, api))
+		logx.Must(genLogicTest(dir, rootPkg, projectPkg, cfg, api))
 	}
 
 	if err := backupAndSweep(apiFile); err != nil {
diff --git a/tools/goctl/api/gogen/genconfig.go b/tools/goctl/api/gogen/genconfig.go
@@ -29,7 +29,7 @@ const (
 //go:embed config.tpl
 var configTemplate string
 
-func genConfig(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error {
+func genConfig(dir, projectPkg string, cfg *config.Config, api *spec.ApiSpec) error {
 	filename, err := format.FileNamingFormat(cfg.NamingFormat, configFile)
 	if err != nil {
 		return err
@@ -60,7 +60,7 @@ func genConfig(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error
 			"authImport": authImportStr,
 			"auth":       strings.Join(auths, "\n"),
 			"jwtTrans":   strings.Join(jwtTransList, "\n"),
-			"rootPkg":    rootPkg,
+			"projectPkg": projectPkg,
 		},
 	})
 }
diff --git a/tools/goctl/api/gogen/genhandlers.go b/tools/goctl/api/gogen/genhandlers.go
@@ -18,7 +18,7 @@ const defaultLogicPackage = "logic"
 //go:embed handler.tpl
 var handlerTemplate string
 
-func genHandler(dir, rootPkg string, cfg *config.Config, group spec.Group, route spec.Route) error {
+func genHandler(dir, rootPkg, projectPkg string, cfg *config.Config, group spec.Group, route spec.Route) error {
 	handler := getHandlerName(route)
 	handlerPath := getHandlerFolderPath(group, route)
 	pkgName := handlerPath[strings.LastIndex(handlerPath, "/")+1:]
@@ -52,15 +52,15 @@ func genHandler(dir, rootPkg string, cfg *config.Config, group spec.Group, route
 			"HasRequest":     len(route.RequestTypeName()) > 0,
 			"HasDoc":         len(route.JoinedDoc()) > 0,
 			"Doc":            getDoc(route.JoinedDoc()),
-			"rootPkg":        rootPkg,
+			"projectPkg":     projectPkg,
 		},
 	})
 }
 
-func genHandlers(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error {
+func genHandlers(dir, rootPkg, projectPkg string, cfg *config.Config, api *spec.ApiSpec) error {
 	for _, group := range api.Service.Groups {
 		for _, route := range group.Routes {
-			if err := genHandler(dir, rootPkg, cfg, group, route); err != nil {
+			if err := genHandler(dir, rootPkg, projectPkg, cfg, group, route); err != nil {
 				return err
 			}
 		}
diff --git a/tools/goctl/api/gogen/genhandlerstest.go b/tools/goctl/api/gogen/genhandlerstest.go
@@ -15,7 +15,7 @@ import (
 //go:embed handler_test.tpl
 var handlerTestTemplate string
 
-func genHandlerTest(dir, rootPkg string, cfg *config.Config, group spec.Group, route spec.Route) error {
+func genHandlerTest(dir, rootPkg, projectPkg string, cfg *config.Config, group spec.Group, route spec.Route) error {
 	handler := getHandlerName(route)
 	handlerPath := getHandlerFolderPath(group, route)
 	pkgName := handlerPath[strings.LastIndex(handlerPath, "/")+1:]
@@ -50,15 +50,15 @@ func genHandlerTest(dir, rootPkg string, cfg *config.Config, group spec.Group, r
 			"HasRequest":     len(route.RequestTypeName()) > 0,
 			"HasDoc":         len(route.JoinedDoc()) > 0,
 			"Doc":            getDoc(route.JoinedDoc()),
-			"rootPkg":        rootPkg,
+			"projectPkg":     projectPkg,
 		},
 	})
 }
 
-func genHandlersTest(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error {
+func genHandlersTest(dir, rootPkg, projectPkg string, cfg *config.Config, api *spec.ApiSpec) error {
 	for _, group := range api.Service.Groups {
 		for _, route := range group.Routes {
-			if err := genHandlerTest(dir, rootPkg, cfg, group, route); err != nil {
+			if err := genHandlerTest(dir, rootPkg, projectPkg, cfg, group, route); err != nil {
 				return err
 			}
 		}
diff --git a/tools/goctl/api/gogen/genlogic.go b/tools/goctl/api/gogen/genlogic.go
@@ -18,10 +18,10 @@ import (
 //go:embed logic.tpl
 var logicTemplate string
 
-func genLogic(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error {
+func genLogic(dir, rootPkg, projectPkg string, cfg *config.Config, api *spec.ApiSpec) error {
 	for _, g := range api.Service.Groups {
 		for _, r := range g.Routes {
-			err := genLogicByRoute(dir, rootPkg, cfg, g, r)
+			err := genLogicByRoute(dir, rootPkg, projectPkg, cfg, g, r)
 			if err != nil {
 				return err
 			}
@@ -30,7 +30,7 @@ func genLogic(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error
 	return nil
 }
 
-func genLogicByRoute(dir, rootPkg string, cfg *config.Config, group spec.Group, route spec.Route) error {
+func genLogicByRoute(dir, rootPkg, projectPkg string, cfg *config.Config, group spec.Group, route spec.Route) error {
 	logic := getLogicName(route)
 	goFile, err := format.FileNamingFormat(cfg.NamingFormat, logic)
 	if err != nil {
@@ -72,7 +72,7 @@ func genLogicByRoute(dir, rootPkg string, cfg *config.Config, group spec.Group,
 			"request":      requestString,
 			"hasDoc":       len(route.JoinedDoc()) > 0,
 			"doc":          getDoc(route.JoinedDoc()),
-			"rootPkg":      rootPkg,
+			"projectPkg":   projectPkg,
 		},
 	})
 }
diff --git a/tools/goctl/api/gogen/genlogictest.go b/tools/goctl/api/gogen/genlogictest.go
@@ -14,10 +14,10 @@ import (
 //go:embed logic_test.tpl
 var logicTestTemplate string
 
-func genLogicTest(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error {
+func genLogicTest(dir, rootPkg, projectPkg string, cfg *config.Config, api *spec.ApiSpec) error {
 	for _, g := range api.Service.Groups {
 		for _, r := range g.Routes {
-			err := genLogicTestByRoute(dir, rootPkg, cfg, g, r)
+			err := genLogicTestByRoute(dir, rootPkg, projectPkg, cfg, g, r)
 			if err != nil {
 				return err
 			}
@@ -26,7 +26,7 @@ func genLogicTest(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) er
 	return nil
 }
 
-func genLogicTestByRoute(dir, rootPkg string, cfg *config.Config, group spec.Group, route spec.Route) error {
+func genLogicTestByRoute(dir, rootPkg, projectPkg string, cfg *config.Config, group spec.Group, route spec.Route) error {
 	logic := getLogicName(route)
 	goFile, err := format.FileNamingFormat(cfg.NamingFormat, logic)
 	if err != nil {
@@ -73,7 +73,7 @@ func genLogicTestByRoute(dir, rootPkg string, cfg *config.Config, group spec.Gro
 			"requestType":  requestType,
 			"hasDoc":       len(route.JoinedDoc()) > 0,
 			"doc":          getDoc(route.JoinedDoc()),
-			"rootPkg":      rootPkg,
+			"projectPkg":   projectPkg,
 		},
 	})
 }
diff --git a/tools/goctl/api/gogen/genmain.go b/tools/goctl/api/gogen/genmain.go
@@ -15,7 +15,7 @@ import (
 //go:embed main.tpl
 var mainTemplate string
 
-func genMain(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error {
+func genMain(dir, rootPkg, projectPkg string, cfg *config.Config, api *spec.ApiSpec) error {
 	name := strings.ToLower(api.Service.Name)
 	filename, err := format.FileNamingFormat(cfg.NamingFormat, name)
 	if err != nil {
@@ -38,7 +38,7 @@ func genMain(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error {
 		data: map[string]string{
 			"importPackages": genMainImports(rootPkg),
 			"serviceName":    configName,
-			"rootPkg":        rootPkg,
+			"projectPkg":     projectPkg,
 		},
 	})
 }
diff --git a/tools/goctl/api/gogen/genroutes.go b/tools/goctl/api/gogen/genroutes.go
@@ -78,7 +78,7 @@ type (
 	}
 )
 
-func genRoutes(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error {
+func genRoutes(dir, rootPkg, projectPkg string, cfg *config.Config, api *spec.ApiSpec) error {
 	var builder strings.Builder
 	groups, err := getRoutes(api)
 	if err != nil {
@@ -202,6 +202,7 @@ rest.WithPrefix("%s"),`, g.prefix)
 			"importPackages":  genRouteImports(rootPkg, api),
 			"routesAdditions": strings.TrimSpace(builder.String()),
 			"version":         version.BuildVersion,
+			"projectPkg":      projectPkg,
 		},
 	})
 }
diff --git a/tools/goctl/api/gogen/gensvc.go b/tools/goctl/api/gogen/gensvc.go
@@ -17,7 +17,7 @@ const contextFilename = "service_context"
 //go:embed svc.tpl
 var contextTemplate string
 
-func genServiceContext(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error {
+func genServiceContext(dir, rootPkg, projectPkg string, cfg *config.Config, api *spec.ApiSpec) error {
 	filename, err := format.FileNamingFormat(cfg.NamingFormat, contextFilename)
 	if err != nil {
 		return err
@@ -53,7 +53,7 @@ func genServiceContext(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpe
 			"config":               "config.Config",
 			"middleware":           middlewareStr,
 			"middlewareAssignment": middlewareAssignment,
-			"rootPkg":              rootPkg,
+			"projectPkg":           projectPkg,
 		},
 	})
 }
diff --git a/tools/goctl/pkg/golang/path.go b/tools/goctl/pkg/golang/path.go
@@ -8,29 +8,29 @@ import (
 	"github.com/zeromicro/go-zero/tools/goctl/util/pathx"
 )
 
-func GetParentPackage(dir string) (string, error) {
+func GetParentPackage(dir string) (string, string, error) {
 	abs, err := filepath.Abs(dir)
 	if err != nil {
-		return "", err
+		return "", "", err
 	}
 
 	projectCtx, err := ctx.Prepare(abs)
 	if err != nil {
-		return "", err
+		return "", "", err
 	}
 
 	// fix https://github.com/zeromicro/go-zero/issues/1058
 	wd := projectCtx.WorkDir
 	d := projectCtx.Dir
 	same, err := pathx.SameFile(wd, d)
 	if err != nil {
-		return "", err
+		return "", "", err
 	}
 
 	trim := strings.TrimPrefix(projectCtx.WorkDir, projectCtx.Dir)
 	if same {
 		trim = strings.TrimPrefix(strings.ToLower(projectCtx.WorkDir), strings.ToLower(projectCtx.Dir))
 	}
 
-	return filepath.ToSlash(filepath.Join(projectCtx.Path, trim)), nil
+	return filepath.ToSlash(filepath.Join(projectCtx.Path, trim)), projectCtx.Path, nil
 }
diff --git a/tools/goctl/quickstart/mono.go b/tools/goctl/quickstart/mono.go
@@ -65,17 +65,17 @@ func (m mono) createAPIProject() {
 	configPath := filepath.Join(apiWorkDir, "internal", "config")
 	svcPath := filepath.Join(apiWorkDir, "internal", "svc")
 	typesPath := filepath.Join(apiWorkDir, "internal", "types")
-	svcPkg, err := golang.GetParentPackage(svcPath)
+	svcPkg, _, err := golang.GetParentPackage(svcPath)
 	logx.Must(err)
-	typesPkg, err := golang.GetParentPackage(typesPath)
+	typesPkg, _, err := golang.GetParentPackage(typesPath)
 	logx.Must(err)
-	configPkg, err := golang.GetParentPackage(configPath)
+	configPkg, _, err := golang.GetParentPackage(configPath)
 	logx.Must(err)
 
 	var rpcClientPkg string
 	if m.callRPC {
 		rpcClientPath := filepath.Join(rpcWorkDir, "greet")
-		rpcClientPkg, err = golang.GetParentPackage(rpcClientPath)
+		rpcClientPkg, _, err = golang.GetParentPackage(rpcClientPath)
 		logx.Must(err)
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ type (`
`78`	`78`	`}`
`79`	`79`	`)`
`80`	`80`
`81`		`-func genRoutes(dir, rootPkg string, cfg config.Config, api spec.ApiSpec) error {`
	`81`	`+func genRoutes(dir, rootPkg, projectPkg string, cfg config.Config, api spec.ApiSpec) error {`
`82`	`82`	`var builder strings.Builder`
`83`	`83`	`groups, err := getRoutes(api)`
`84`	`84`	`if err != nil {`
@@ -202,6 +202,7 @@ rest.WithPrefix("%s"),`, g.prefix)
`202`	`202`	`"importPackages": genRouteImports(rootPkg, api),`
`203`	`203`	`"routesAdditions": strings.TrimSpace(builder.String()),`
`204`	`204`	`"version": version.BuildVersion,`
	`205`	`+ "projectPkg": projectPkg,`
`205`	`206`	`},`
`206`	`207`	`})`
`207`	`208`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,29 +8,29 @@ import (`
`8`	`8`	`"github.com/zeromicro/go-zero/tools/goctl/util/pathx"`
`9`	`9`	`)`
`10`	`10`
`11`		`-func GetParentPackage(dir string) (string, error) {`
	`11`	`+func GetParentPackage(dir string) (string, string, error) {`
`12`	`12`	`abs, err := filepath.Abs(dir)`
`13`	`13`	`if err != nil {`
`14`		`- return "", err`
	`14`	`+ return "", "", err`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`projectCtx, err := ctx.Prepare(abs)`
`18`	`18`	`if err != nil {`
`19`		`- return "", err`
	`19`	`+ return "", "", err`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`// fix https://github.com/zeromicro/go-zero/issues/1058`
`23`	`23`	`wd := projectCtx.WorkDir`
`24`	`24`	`d := projectCtx.Dir`
`25`	`25`	`same, err := pathx.SameFile(wd, d)`
`26`	`26`	`if err != nil {`
`27`		`- return "", err`
	`27`	`+ return "", "", err`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`trim := strings.TrimPrefix(projectCtx.WorkDir, projectCtx.Dir)`
`31`	`31`	`if same {`
`32`	`32`	`trim = strings.TrimPrefix(strings.ToLower(projectCtx.WorkDir), strings.ToLower(projectCtx.Dir))`
`33`	`33`	`}`
`34`	`34`
`35`		`- return filepath.ToSlash(filepath.Join(projectCtx.Path, trim)), nil`
	`35`	`+ return filepath.ToSlash(filepath.Join(projectCtx.Path, trim)), projectCtx.Path, nil`
`36`	`36`	`}`