add dev githook command

cmd/bee.go

@@ -21,6 +21,7 @@ import (
 	_ "github.com/beego/bee/cmd/commands/bale"
 	_ "github.com/beego/bee/cmd/commands/beefix"
 	_ "github.com/beego/bee/cmd/commands/beegopro"
+	_ "github.com/beego/bee/cmd/commands/dev"
 	_ "github.com/beego/bee/cmd/commands/dlv"
 	_ "github.com/beego/bee/cmd/commands/dockerize"
 	_ "github.com/beego/bee/cmd/commands/generate"

cmd/commands/api/apiapp.go

@@ -16,11 +16,12 @@ package apiapp
 
 import (
 	"fmt"
-	"github.com/beego/bee/logger/colors"
 	"os"
 	path "path/filepath"
 	"strings"
 
+	"github.com/beego/bee/logger/colors"
+
 	"github.com/beego/bee/cmd/commands"
 	"github.com/beego/bee/cmd/commands/version"
 	"github.com/beego/bee/generate"

cmd/commands/beegopro/beegopro.go

@@ -14,10 +14,11 @@
 package beegopro
 
 import (
+	"strings"
+
 	"github.com/beego/bee/cmd/commands"
 	"github.com/beego/bee/internal/app/module/beegopro"
 	"github.com/beego/bee/logger"
-	"strings"
 )
 
 var CmdBeegoPro = &commands.Command{

cmd/commands/dev/cmd.go

@@ -0,0 +1,56 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package dev
+
+import (
+	"github.com/beego/bee/cmd/commands"
+	beeLogger "github.com/beego/bee/logger"
+)
+
+var CmdDev = &commands.Command{
+	CustomFlags: true,
+	UsageLine:   "dev [command]",
+	Short:       "Commands which used to help to develop beego and bee",
+	Long: `
+Commands that help developer develop, build and test beego.
+- githook    Prepare githooks
+`,
+	Run: Run,
+}
+
+func init() {
+	commands.AvailableCommands = append(commands.AvailableCommands, CmdDev)
+}
+
+func Run(cmd *commands.Command, args []string) int {
+	if len(args) < 1 {
+		beeLogger.Log.Fatal("Command is missing")
+	}
+
+	if len(args) >= 2 {
+		cmd.Flag.Parse(args[1:])
+	}
+
+	gcmd := args[0]
+
+	switch gcmd {
+
+	case "githook":
+		initGitHook()
+	default:
+		beeLogger.Log.Fatal("Unknown command")
+	}
+	return 0
+}

cmd/commands/dev/githook.go

@@ -0,0 +1,47 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package dev
+
+import (
+	"os"
+
+	beeLogger "github.com/beego/bee/logger"
+)
+
+var preCommit = `
+goimports -w -format-only ./ \
+ineffassign . \
+staticcheck -show-ignored -checks "-ST1017,-U1000,-ST1005,-S1034,-S1012,-SA4006,-SA6005,-SA1019,-SA1024" ./ \
+`
+
+// for now, we simply override pre-commit file
+func initGitHook() {
+	// pcf => pre-commit file
+	pcfPath := "./.git/hooks/pre-commit"
+	pcf, err := os.OpenFile(pcfPath, os.O_RDWR|os.O_CREATE, 0777)
+	if err != nil {
+		beeLogger.Log.Errorf("try to create or open file failed: %s, cause: %s", pcfPath, err.Error())
+		return
+	}
+
+	defer pcf.Close()
+	_, err = pcf.Write(([]byte)(preCommit))
+
+	if err != nil {
+		beeLogger.Log.Errorf("could not init githooks: %s", err.Error())
+	} else {
+		beeLogger.Log.Successf("The githooks has been added, the content is:\n %s ", preCommit)
+	}
+}

cmd/commands/dlv/dlv_amd64.go

@@ -28,12 +28,12 @@ import (
 	"github.com/beego/bee/cmd/commands/version"
 	beeLogger "github.com/beego/bee/logger"
 	"github.com/beego/bee/utils"
+	"github.com/fsnotify/fsnotify"
+	"github.com/gadelkareem/delve/pkg/terminal"
 	"github.com/gadelkareem/delve/service"
 	"github.com/gadelkareem/delve/service/debugger"
 	"github.com/gadelkareem/delve/service/rpc2"
 	"github.com/gadelkareem/delve/service/rpccommon"
-	"github.com/gadelkareem/delve/pkg/terminal"
-	"github.com/fsnotify/fsnotify"
 )
 
 var cmdDlv = &commands.Command{

cmd/commands/hprose/hprose.go

@@ -2,11 +2,12 @@ package hprose
 
 import (
 	"fmt"
-	"github.com/beego/bee/logger/colors"
 	"os"
 	"path"
 	"strings"
 
+	"github.com/beego/bee/logger/colors"
+
 	"github.com/beego/bee/cmd/commands"
 	"github.com/beego/bee/cmd/commands/api"
 	"github.com/beego/bee/cmd/commands/version"

cmd/commands/update/update.go

@@ -32,7 +32,7 @@ func updateBee(cmd *commands.Command, args []string) int {
 	cmdUp.Stdout = os.Stdout
 	cmdUp.Stderr = os.Stderr
 	if err := cmdUp.Run(); err != nil {
-		beeLogger.Log.Warnf("Run cmd err:%s",err)
+		beeLogger.Log.Warnf("Run cmd err:%s", err)
 	}
 	return 0
 }