Merge pull request #4 from sliveryou/feat-go1.16

feat: upgrade go version to 1.16

Author: sliveryou

.gitignore

@@ -1,3 +1,10 @@
+# Created by https://www.toptal.com/developers/gitignore/api/go,jetbrains+all,macos,windows
+# Edit at https://www.toptal.com/developers/gitignore?templates=go,jetbrains+all,macos,windows
+
+### Go ###
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
 # Binaries for programs and plugins
 *.exe
 *.exe~
@@ -13,5 +20,159 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
-.idea/
-grom*
+
+# Go workspace file
+go.work
+
+### JetBrains+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### JetBrains+all Patch ###
+# Ignore everything but code style settings and run configurations
+# that are supposed to be shared within teams.
+
+.idea/*
+
+!.idea/codeStyles
+!.idea/runConfigurations
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/go,jetbrains+all,macos,windows
+
+### Project ###
+testdata/
+/grom*

Makefile

@@ -1,3 +1,5 @@
+.PHONY: build install pkg clean fmt proxy
+
 build:
 	@sh scripts/build.sh
 
@@ -11,17 +13,10 @@ clean:
 	@sh scripts/clean.sh
 
 fmt:
-	@find . -name '*.go' -not -path "./vendor/*" | xargs gofmt -s -w
-	@find . -name '*.go' -not -path "./vendor/*" | xargs goimports -w
-	@find . -name '*.sh' -not -path "./vendor/*" | xargs shfmt -w -s -i 4 -ci -bn
+	@find . -name '*.go' -not -path "./vendor/*" | xargs gofumpt -w -extra
+	@find . -name '*.go' -not -path "./vendor/*" | xargs -n 1 -t goimports-reviser -rm-unused -set-alias -company-prefixes "github.com/sliveryou" -project-name "github.com/sliveryou/grom"
+	@find . -name '*.sh' -not -path "./vendor/*" | xargs shfmt -w -s -i 2 -ci -bn -sr
 
 proxy:
 	@go env -w GO111MODULE="on"
 	@go env -w GOPROXY="https://goproxy.cn,direct"
-
-dep:
-	@go get github.com/golangci/golangci-lint/cmd/golangci-lint@v1.27.0
-	@go get golang.org/x/tools/cmd/goimports
-	@go get mvdan.cc/sh/v3/cmd/shfmt
-	@go get mvdan.cc/sh/v3/cmd/gosh
-	@git checkout -- go.mod go.sum

README.md

@@ -18,9 +18,15 @@ Download package by using:
 
 ```shell script
 $ go get -u github.com/sliveryou/grom
+
+# if the go version is before 1.16, use the following command to install:
+$ GO111MODULE=on go get -u github.com/sliveryou/grom@latest
+
+# if the go version is 1.16 and later, use the following command to install:
+$ GO111MODULE=on go install github.com/sliveryou/grom@latest
 ```
 
-To build from source code, you need [Go environment](https://golang.org/dl/) (1.14 or newer) and use the following commands:
+To build from source code, you need [Go environment](https://golang.org/dl/) (1.16 or newer) and use the following commands:
 
 ```shell script
 $ git clone https://github.com/sliveryou/grom.git

README_zh-CN.md

@@ -16,10 +16,14 @@ Grom 是一个可以将 mysql 的表字段转换为 golang 的模型结构的命
 使用如下命令下载并安装包：
 
 ```shell script
-$ go get -u github.com/sliveryou/grom
+# 如果 go 版本在 1.16 以前，使用如下命令安装：
+$ GO111MODULE=on go get -u github.com/sliveryou/grom@latest
+
+# 如果 go 版本在 1.16 及以后，使用如下命令安装：
+$ GO111MODULE=on go install github.com/sliveryou/grom@latest
 ```
 
-如果要从源码开始构建的话，需要有 [Go](https://golang.org/dl/) 环境（1.14 及以上版本），并使用如下命令：
+如果要从源码开始构建的话，需要有 [Go](https://golang.org/dl/) 环境（1.16 及以上版本），并使用如下命令：
 
 ```shell script
 $ git clone https://github.com/sliveryou/grom.git

cmd/convert.go

@@ -2,12 +2,11 @@ package cmd
 
 import (
 	"encoding/json"
-	"errors"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"strings"
 
+	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 
 	"github.com/sliveryou/grom/util"
@@ -47,7 +46,7 @@ var convertCmd = &cobra.Command{
 	Long:  "Convert mysql table fields to golang model structure by information_schema.columns and information_schema.statistics",
 	Example: "  grom convert -n ./grom.json\n" +
 		"  grom convert -H localhost -P 3306 -u user -p password -d database -t table -e INITIALISM,FIELD_COMMENT,JSON_TAG,GORM_V2_TAG --package PACKAGE_NAME --struct STRUCT_NAME",
-	Run: convertFunc,
+	RunE: convertFunc,
 }
 
 func init() {
@@ -66,56 +65,49 @@ func init() {
 	rootCmd.AddCommand(convertCmd)
 }
 
-func convertFunc(cmd *cobra.Command, args []string) {
+func convertFunc(_ *cobra.Command, _ []string) error {
 	config, err := getCmdConfig()
 	if err != nil {
-		return
+		return errors.WithMessage(err, "getCmdConfig err")
 	}
 
-	out, err := util.ConvertTable(config)
+	out, err := util.ConvertTable(*config)
 	if err != nil {
-		return
+		return errors.WithMessage(err, "util.ConvertTable err")
 	}
 
 	if outputFilePath != "" {
-		saveOutputToFile(out)
+		return saveOutputToFile(out)
 	} else {
 		fmt.Println(out)
 	}
+
+	return nil
 }
 
-func saveOutputToFile(out string) {
-	f, err := os.Create(outputFilePath)
+func saveOutputToFile(out string) error {
+	err := os.WriteFile(outputFilePath, []byte(out), 0o666)
 	if err != nil {
-		fmt.Println(err)
-		return
+		return errors.WithMessage(err, "os.WriteFile err")
 	}
-	defer f.Close()
 
-	_, err = f.Write([]byte(out))
-	if err != nil {
-		fmt.Println(err)
-		return
-	}
+	fmt.Println("write output in:", outputFilePath)
 
-	fmt.Println(out)
-	fmt.Println("\nwrite output in:", outputFilePath)
+	return nil
 }
 
-func getCmdConfig() (util.CMDConfig, error) {
+func getCmdConfig() (*util.CMDConfig, error) {
 	config := util.CMDConfig{}
 
 	if filePath != "" {
-		content, err := ioutil.ReadFile(filePath)
+		content, err := os.ReadFile(filePath)
 		if err != nil {
-			fmt.Println(err)
-			return util.CMDConfig{}, err
+			return nil, errors.WithMessage(err, "os.ReadFile err")
 		}
 
 		err = json.Unmarshal(content, &config)
 		if err != nil {
-			fmt.Println(err)
-			return util.CMDConfig{}, err
+			return nil, errors.WithMessage(err, "json.Unmarshal err")
 		}
 	}
 
@@ -148,9 +140,7 @@ func getCmdConfig() (util.CMDConfig, error) {
 		for _, v := range enable {
 			service := strings.ToUpper(v)
 			if _, ok := validServices[service]; !ok {
-				err := errors.New("enabled service is invalid, service: " + service)
-				fmt.Println(err)
-				return util.CMDConfig{}, err
+				return nil, errors.New("enabled service is invalid, service: " + service)
 			}
 
 			switch service {
@@ -180,5 +170,5 @@ func getCmdConfig() (util.CMDConfig, error) {
 		}
 	}
 
-	return config, nil
+	return &config, nil
 }

cmd/generate.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 
 	"github.com/sliveryou/grom/util"
@@ -20,30 +21,23 @@ var generateCmd = &cobra.Command{
 	Short:   "Generate grom configuration file",
 	Long:    fmt.Sprintf("Generate grom configuration file like this:\n%s", generateFileInfo()),
 	Example: "  grom generate -n ./grom.json",
-	Run:     generateFunc,
+	RunE:    generateFunc,
 }
 
 func init() {
 	generateCmd.Flags().StringVarP(&fileName, "name", "n", "grom.json", "the name of the generated grom configuration file")
 	rootCmd.AddCommand(generateCmd)
 }
 
-func generateFunc(cmd *cobra.Command, args []string) {
-	f, err := os.Create(fileName)
+func generateFunc(_ *cobra.Command, _ []string) error {
+	err := os.WriteFile(fileName, []byte(fileInfo), 0o666)
 	if err != nil {
-		fmt.Println(err)
-		return
+		return errors.WithMessage(err, "os.WriteFile err")
 	}
-	defer f.Close()
 
-	_, err = f.Write([]byte(fileInfo))
-	if err != nil {
-		fmt.Println(err)
-		return
-	}
+	fmt.Println("write in:", fileName)
 
-	fmt.Println(fileInfo)
-	fmt.Println("\nwrite in:", fileName)
+	return nil
 }
 
 func generateFileInfo() string {