feat: Support projectPkg template variables in config, handler, logic, main, and svc template files #4939
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
geekeryy
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for a new projectPkg template variable across Go Zero code generators, allowing templates to reference the module path directly.
- Extended
GetParentPackageto return both the generated package path and the project’s module path. - Updated generator functions (config, main, service context, routes, handlers, logic, and their tests) to accept and pass
projectPkg. - Adjusted
DoGenProjectto captureprojectPkgand supply it to all relevant generators.
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tools/goctl/quickstart/mono.go | Adapted calls to GetParentPackage to accept the extra return value. |
| tools/goctl/pkg/golang/path.go | Changed GetParentPackage signature to return module path. |
| tools/goctl/api/gogen/gensvc.go | Added projectPkg parameter and template data entry. |
| tools/goctl/api/gogen/genroutes.go | Added projectPkg parameter and template data entry. |
| tools/goctl/api/gogen/genmain.go | Added projectPkg parameter and template data entry. |
| tools/goctl/api/gogen/genlogictest.go | Added projectPkg parameter and template data entry. |
| tools/goctl/api/gogen/genlogic.go | Added projectPkg parameter and template data entry. |
| tools/goctl/api/gogen/genhandlerstest.go | Added projectPkg parameter and template data entry. |
| tools/goctl/api/gogen/genhandlers.go | Added projectPkg parameter and template data entry. |
| tools/goctl/api/gogen/genconfig.go | Added projectPkg parameter and template data entry. |
| tools/goctl/api/gogen/gen.go | Captures projectPkg via GetParentPackage and passes it to all generators. |
Comments suppressed due to low confidence (1)
tools/goctl/api/gogen/genconfig.go:63
- New template variable
projectPkgis injected into the config generator; consider adding a unit test forconfig.tplto verify thatprojectPkgis correctly rendered in generated output.
"projectPkg": projectPkg,
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
@kevwan Can this fix be merged? |
kesonan
approved these changes
Aug 19, 2025
…ain, svc template files
…, main, svc template files
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Support projectPkg template variables in config, handler, logic, main, and svc template files to facilitate highly customized templates for your own projects