init

Author: ArronDou

.dockerignore

@@ -0,0 +1,8 @@
+test/
+.dockerignore
+.go-version
+Dockerfile
+goctl
+Makefile
+readme.md
+readme-cn.md

.idea/.gitignore

@@ -0,0 +1,39 @@
+FROM golang:alpine AS builder
+
+LABEL stage=gobuilder
+
+ENV CGO_ENABLED=0
+ENV GOPROXY=https://goproxy.cn,direct
+
+RUN apk update --no-cache && apk add --no-cache tzdata
+RUN go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
+RUN go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
+RUN addgroup -g 1000 -S app && adduser -u 1000 -S app -G app
+
+WORKDIR /build
+
+COPY . .
+RUN go mod download
+RUN go build -ldflags="-s -w" -o /app/goctl ./goctl.go
+
+
+FROM golang:alpine
+
+RUN apk update --no-cache && apk add --no-cache protoc
+
+COPY --from=builder /etc/passwd /etc/group /etc/
+COPY --from=builder /usr/share/zoneinfo/ /usr/share/zoneinfo/
+COPY --from=builder --chown=1000:1000 /go/bin/protoc-gen-go* /app/goctl /usr/local/bin/
+ENV TZ=Asia/Shanghai
+
+WORKDIR /app
+USER app
+
+LABEL org.opencontainers.image.authors="Kevin Wan"
+LABEL org.opencontainers.image.base.name="docker.io/library/golang:alpine"
+LABEL org.opencontainers.image.description="A cloud-native Go microservices framework with cli tool for productivity."
+LABEL org.opencontainers.image.licenses="MIT"
+LABEL org.opencontainers.image.source="https://github.com/zeromicro/go-zero"
+LABEL org.opencontainers.image.title="goctl (cli)"
+
+ENTRYPOINT ["/usr/local/bin/goctl"]

Dockerfile

@@ -0,0 +1,25 @@
+build:
+	go build -ldflags="-s -w" goctl.go
+	$(if $(shell command -v upx || which upx), upx goctl)
+
+mac:
+	GOOS=darwin go build -ldflags="-s -w" -o goctl-darwin goctl.go
+	$(if $(shell command -v upx || which upx), upx goctl-darwin)
+
+win:
+	GOOS=windows go build -ldflags="-s -w" -o goctl.exe goctl.go
+	$(if $(shell command -v upx || which upx), upx goctl.exe)
+
+linux:
+	GOOS=linux go build -ldflags="-s -w" -o goctl-linux goctl.go
+	$(if $(shell command -v upx || which upx), upx goctl-linux)
+
+image:
+	docker build --rm --platform linux/amd64 -t kevinwan/goctl:$(version) .
+	docker tag kevinwan/goctl:$(version) kevinwan/goctl:latest
+	docker push kevinwan/goctl:$(version)
+	docker push kevinwan/goctl:latest
+	docker build --rm --platform linux/arm64 -t kevinwan/goctl:$(version)-arm64 .
+	docker tag kevinwan/goctl:$(version)-arm64 kevinwan/goctl:latest-arm64
+	docker push kevinwan/goctl:$(version)-arm64
+	docker push kevinwan/goctl:latest-arm64

Makefile

@@ -0,0 +1,24 @@
+syntax = "v1"
+
+info (
+	title: // TODO: add title
+	desc: // TODO: add description
+	author: "{{.gitUser}}"
+	email: "{{.gitEmail}}"
+)
+
+type request {
+	// TODO: add members here and delete this comment
+}
+
+type response {
+	// TODO: add members here and delete this comment
+}
+
+service {{.serviceName}} {
+	@handler GetUser // TODO: set handler name and delete this comment
+	get /users/id/:userId(request) returns(response)
+
+	@handler CreateUser // TODO: set handler name and delete this comment
+	post /users/create(request)
+}

api/apigen/api.tpl

@@ -0,0 +1,78 @@
+package apigen
+
+import (
+	_ "embed"
+	"errors"
+	"fmt"
+	"html/template"
+	"path/filepath"
+	"strings"
+
+	"github.com/gookit/color"
+	"github.com/spf13/cobra"
+	"github.com/zeromicro/go-zero/tools/goctl/util"
+	"github.com/zeromicro/go-zero/tools/goctl/util/pathx"
+)
+
+//go:embed api.tpl
+var apiTemplate string
+
+var (
+	// VarStringOutput describes the output.
+	VarStringOutput string
+	// VarStringHome describes the goctl home.
+	VarStringHome string
+	// VarStringRemote describes the remote git repository.
+	VarStringRemote string
+	// VarStringBranch describes the git branch.
+	VarStringBranch string
+)
+
+// CreateApiTemplate create api template file
+func CreateApiTemplate(_ *cobra.Command, _ []string) error {
+	apiFile := VarStringOutput
+	if len(apiFile) == 0 {
+		return errors.New("missing -o")
+	}
+
+	fp, err := pathx.CreateIfNotExist(apiFile)
+	if err != nil {
+		return err
+	}
+	defer fp.Close()
+
+	if len(VarStringRemote) > 0 {
+		repo, _ := util.CloneIntoGitHome(VarStringRemote, VarStringBranch)
+		if len(repo) > 0 {
+			VarStringHome = repo
+		}
+	}
+
+	if len(VarStringHome) > 0 {
+		pathx.RegisterGoctlHome(VarStringHome)
+	}
+
+	text, err := pathx.LoadTemplate(category, apiTemplateFile, apiTemplate)
+	if err != nil {
+		return err
+	}
+
+	baseName := pathx.FileNameWithoutExt(filepath.Base(apiFile))
+	if strings.HasSuffix(strings.ToLower(baseName), "-api") {
+		baseName = baseName[:len(baseName)-4]
+	} else if strings.HasSuffix(strings.ToLower(baseName), "api") {
+		baseName = baseName[:len(baseName)-3]
+	}
+
+	t := template.Must(template.New("etcTemplate").Parse(text))
+	if err := t.Execute(fp, map[string]string{
+		"gitUser":     getGitName(),
+		"gitEmail":    getGitEmail(),
+		"serviceName": baseName + "-api",
+	}); err != nil {
+		return err
+	}
+
+	fmt.Println(color.Green.Render("Done."))
+	return nil
+}

api/apigen/gen.go

@@ -0,0 +1,50 @@
+package apigen
+
+import (
+	"fmt"
+
+	"github.com/zeromicro/go-zero/tools/goctl/util/pathx"
+)
+
+const (
+	category        = "api"
+	apiTemplateFile = "template.tpl"
+)
+
+var templates = map[string]string{
+	apiTemplateFile: apiTemplate,
+}
+
+// Category returns the category of the api files.
+func Category() string {
+	return category
+}
+
+// Clean cleans the generated deployment files.
+func Clean() error {
+	return pathx.Clean(category)
+}
+
+// GenTemplates generates api template files.
+func GenTemplates() error {
+	return pathx.InitTemplates(category, templates)
+}
+
+// RevertTemplate reverts the given template file to the default value.
+func RevertTemplate(name string) error {
+	content, ok := templates[name]
+	if !ok {
+		return fmt.Errorf("%s: no such file name", name)
+	}
+	return pathx.CreateTemplate(category, name, content)
+}
+
+// Update updates the template files to the templates built in current goctl.
+func Update() error {
+	err := Clean()
+	if err != nil {
+		return err
+	}
+
+	return pathx.InitTemplates(category, templates)
+}

api/apigen/template.go

@@ -0,0 +1,26 @@
+package apigen
+
+import (
+	"os/exec"
+	"strings"
+)
+
+func getGitName() string {
+	cmd := exec.Command("git", "config", "user.name")
+	out, err := cmd.CombinedOutput()
+	if err != nil {
+		return ""
+	}
+
+	return strings.TrimSpace(string(out))
+}
+
+func getGitEmail() string {
+	cmd := exec.Command("git", "config", "user.email")
+	out, err := cmd.CombinedOutput()
+	if err != nil {
+		return ""
+	}
+
+	return strings.TrimSpace(string(out))
+}

api/apigen/util.go

@@ -0,0 +1,103 @@
+package api
+
+import (
+	"github.com/spf13/cobra"
+	"github.com/zeromicro/go-zero/tools/goctl/api/apigen"
+	"github.com/zeromicro/go-zero/tools/goctl/api/dartgen"
+	"github.com/zeromicro/go-zero/tools/goctl/api/docgen"
+	"github.com/zeromicro/go-zero/tools/goctl/api/format"
+	"github.com/zeromicro/go-zero/tools/goctl/api/gogen"
+	"github.com/zeromicro/go-zero/tools/goctl/api/javagen"
+	"github.com/zeromicro/go-zero/tools/goctl/api/ktgen"
+	"github.com/zeromicro/go-zero/tools/goctl/api/new"
+	"github.com/zeromicro/go-zero/tools/goctl/api/tsgen"
+	"github.com/zeromicro/go-zero/tools/goctl/api/validate"
+	"github.com/zeromicro/go-zero/tools/goctl/config"
+	"github.com/zeromicro/go-zero/tools/goctl/internal/cobrax"
+	"github.com/zeromicro/go-zero/tools/goctl/plugin"
+)
+
+var (
+	// Cmd describes an api command.
+	Cmd       = cobrax.NewCommand("api", cobrax.WithRunE(apigen.CreateApiTemplate))
+	dartCmd   = cobrax.NewCommand("dart", cobrax.WithRunE(dartgen.DartCommand))
+	docCmd    = cobrax.NewCommand("doc", cobrax.WithRunE(docgen.DocCommand))
+	formatCmd = cobrax.NewCommand("format", cobrax.WithRunE(format.GoFormatApi))
+	goCmd     = cobrax.NewCommand("go", cobrax.WithRunE(gogen.GoCommand))
+	newCmd    = cobrax.NewCommand("new", cobrax.WithRunE(new.CreateServiceCommand),
+		cobrax.WithArgs(cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs)))
+	validateCmd = cobrax.NewCommand("validate", cobrax.WithRunE(validate.GoValidateApi))
+	javaCmd     = cobrax.NewCommand("java", cobrax.WithRunE(javagen.JavaCommand), cobrax.WithHidden())
+	ktCmd       = cobrax.NewCommand("kt", cobrax.WithRunE(ktgen.KtCommand))
+	pluginCmd   = cobrax.NewCommand("plugin", cobrax.WithRunE(plugin.PluginCommand))
+	tsCmd       = cobrax.NewCommand("ts", cobrax.WithRunE(tsgen.TsCommand))
+)
+
+func init() {
+	var (
+		apiCmdFlags      = Cmd.Flags()
+		dartCmdFlags     = dartCmd.Flags()
+		docCmdFlags      = docCmd.Flags()
+		formatCmdFlags   = formatCmd.Flags()
+		goCmdFlags       = goCmd.Flags()
+		javaCmdFlags     = javaCmd.Flags()
+		ktCmdFlags       = ktCmd.Flags()
+		newCmdFlags      = newCmd.Flags()
+		pluginCmdFlags   = pluginCmd.Flags()
+		tsCmdFlags       = tsCmd.Flags()
+		validateCmdFlags = validateCmd.Flags()
+	)
+
+	apiCmdFlags.StringVar(&apigen.VarStringOutput, "o")
+	apiCmdFlags.StringVar(&apigen.VarStringHome, "home")
+	apiCmdFlags.StringVar(&apigen.VarStringRemote, "remote")
+	apiCmdFlags.StringVar(&apigen.VarStringBranch, "branch")
+
+	dartCmdFlags.StringVar(&dartgen.VarStringDir, "dir")
+	dartCmdFlags.StringVar(&dartgen.VarStringAPI, "api")
+	dartCmdFlags.BoolVar(&dartgen.VarStringLegacy, "legacy")
+	dartCmdFlags.StringVar(&dartgen.VarStringHostname, "hostname")
+	dartCmdFlags.StringVar(&dartgen.VarStringScheme, "scheme")
+
+	docCmdFlags.StringVar(&docgen.VarStringDir, "dir")
+	docCmdFlags.StringVar(&docgen.VarStringOutput, "o")
+
+	formatCmdFlags.StringVar(&format.VarStringDir, "dir")
+	formatCmdFlags.BoolVar(&format.VarBoolIgnore, "iu")
+	formatCmdFlags.BoolVar(&format.VarBoolUseStdin, "stdin")
+	formatCmdFlags.BoolVar(&format.VarBoolSkipCheckDeclare, "declare")
+
+	goCmdFlags.StringVar(&gogen.VarStringDir, "dir")
+	goCmdFlags.StringVar(&gogen.VarStringAPI, "api")
+	goCmdFlags.StringVar(&gogen.VarStringHome, "home")
+	goCmdFlags.StringVar(&gogen.VarStringRemote, "remote")
+	goCmdFlags.StringVar(&gogen.VarStringBranch, "branch")
+	goCmdFlags.StringVarWithDefaultValue(&gogen.VarStringStyle, "style", config.DefaultFormat)
+
+	javaCmdFlags.StringVar(&javagen.VarStringDir, "dir")
+	javaCmdFlags.StringVar(&javagen.VarStringAPI, "api")
+
+	ktCmdFlags.StringVar(&ktgen.VarStringDir, "dir")
+	ktCmdFlags.StringVar(&ktgen.VarStringAPI, "api")
+	ktCmdFlags.StringVar(&ktgen.VarStringPKG, "pkg")
+
+	newCmdFlags.StringVar(&new.VarStringHome, "home")
+	newCmdFlags.StringVar(&new.VarStringRemote, "remote")
+	newCmdFlags.StringVar(&new.VarStringBranch, "branch")
+	newCmdFlags.StringVarWithDefaultValue(&new.VarStringStyle, "style", config.DefaultFormat)
+
+	pluginCmdFlags.StringVarP(&plugin.VarStringPlugin, "plugin", "p")
+	pluginCmdFlags.StringVar(&plugin.VarStringDir, "dir")
+	pluginCmdFlags.StringVar(&plugin.VarStringAPI, "api")
+	pluginCmdFlags.StringVar(&plugin.VarStringStyle, "style")
+
+	tsCmdFlags.StringVar(&tsgen.VarStringDir, "dir")
+	tsCmdFlags.StringVar(&tsgen.VarStringAPI, "api")
+	tsCmdFlags.StringVar(&tsgen.VarStringCaller, "caller")
+	tsCmdFlags.BoolVar(&tsgen.VarBoolUnWrap, "unwrap")
+
+	validateCmdFlags.StringVar(&validate.VarStringAPI, "api")
+
+	// Add sub-commands
+	Cmd.AddCommand(dartCmd, docCmd, formatCmd, goCmd, javaCmd, ktCmd, newCmd, pluginCmd, tsCmd, validateCmd)
+}