Generate boilerplates for layered architecture by your templates.
At first, we prepare layered structure and templates.
$ tree templates
templates
├── repositories
│ └── repository.tmpl
├── controllers
│ └── controller.tmpl
└── usercases
└── usecase.tmplFor instance, the usecase template is below. templates are written with text/template.
// templates/usercase/usecase.tmpl
package usecase
type {{ .Action | title}}{{ .Model | title }}Input struct{}
type {{ .Action | title}}{{ .Model | title }}Result struct{}
type {{ .Action | title}}{{ .Model | title }}Usecase interface {
Run({{ .Action | title}}{{ .Model | title }}Input) ({{ .Action | title}}{{ .Model | title }}Result, error)
}
func New{{ .Action | title}}{{ .Model | title }}Usecase() {{ .Action | title}}{{ .Model | title }}Usecase {
return &{{ .Action }}{{ .Model | title }}Usecase{
}
}
type {{ .Action }}{{ .Model | title }}Usecase struct {}
func (u *{{ .Action }}{{ .Model | title }}Usecase) Run(
in {{ .Action | title}}{{ .Model | title }}Input,
) ({{ .Action | title}}{{ .Model | title }}Result, error){
// Need to implement usercase logic
return {{ .Action | title}}{{ .Model | title }}Result{
// Need to build result
}
}Execute lgen with Action and Model strings.
$ lgen -action Get -model User -template ./testdata -dist myproductThe generated directories and files are below.
$ tree myproduct
myproduct
├── repositories
│ └── get_user_repository.go
├── controllers
│ └── get_user_controller.go
└── usercases
└── get_user_usecase.go
2 directories, 2 filesThe get_user_usercase.go is below. We are enabled to write miltiple files by a command.
package usecase
type GetUserInput struct{}
type GetUserResult struct{}
type GetUserUsecase interface {
Run(GetUserInput) (GetUserResult, error)
}
func NewGetUserUsecase() GetUserUsecase {
return &getUserUsecase{}
}
type getUserUsecase struct{}
func (u *getUserUsecase) Run(
in GetUserInput,
) (GetUserResult, error) {
// Need to implement usercase logic
return GetUserResult{
// Need to build result
}
}$ lgen -a get -m user -template /your/templates/directory -dist /your/project/root/directory
$ lgen -h
Usage of /var/folders/sy/ls4cfp216x774g54brzl67yw0000gn/T/go-build403725816/b001/exe/lgen:
-a string
action name
-action string
action name
-d string
output directory (default "./")
-dist string
output directory
-m string
model name
-model string
model name
-t string
templates directory (default "./templates")
-template string
templates directory
-v print version information and quit.
-version
print version information and quit.
$ go get github.com/budougumi0617/lgen
Built binaries are available on gihub releases. https://github.com/budougumi0617/lgen/releases
If you want to install on MacOS, you can use Homebrew.
brew install budougumi0617/tap/lgen
The template must be created according to the following rules.
- Base on
text/templatepackage. - template file extension is only
.tmpl. - Varialbes are
Action, andModelonly. Functionsare supported below:- basic functions https://golang.org/pkg/text/template/#hdr-Functions
title-strings.ToTitle
- Fork (https://github.com/budougumi0617/lgen/fork)
- Create a feature branch
- Commit your changes
- Rebase your local changes against the master branch
- Run test suite with the
go test ./...command and confirm that it passes - Run
gofmt -s - Create new Pull Request
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent