go_fmt

README

Go 代码格式化

1 功能说明

• 格式化 import 部分：分3段式，依默认为 标准库、第三方库、项目自身库
• 格式化单行注释：若为 //注释内容，调整为 //{空格}注释内容
• 默认只对 git 项目库里有修改的进行格式化
• 支持将多行的 copyright 注释修改为单行格式(默认不调整)
• 简化代码
• struct 赋值表达式，自动补齐 key
• 补充空行、移除多余的空行

对于 import 部分：

1.可使用-mi参数来控制是否将多段import合并为一段（默认否）。
2.对于注释的import path,会按照其实际路径参与分组和排序。
3.对于非末行的注释的位置会和其下面紧挨的import path绑定在一起。
4.末行的注释则会放入import的头部。
5.import path 不要使用相对路径(如./ 和 ../)。

会忽略当前目录以及子目录下的 testdata 和 vendor 目录。
若需要可进入其目录里执行该命令。

Example 1：补齐 struct key

- u2 := User{"hello", 12}
+ u2 := User{Name: "hello", Age: 12}

Example 2：注释格式化

- //User 注释内容
+ // User 注释内容
type User struct{

Example 3：简化代码

1. 简化循环逻辑：

- s[a:len(s)]
+ s[a:]

- for x, _ = range v {...}
+ for x = range v {...}

- for _ = range v {...}
+ for range v {...}

1. 简化判断逻辑：

- if b == true {
+ if b { 

- if b == false {
+ if !b {

- if b != true {
+ if !b {

- if b != false {
+ if b {

- for b == true {
+ for b {

1. 使用 strings.Contains 替换 strings.Count 和 strings.Index

- strings.Count(s, "a") == 0
+ !strings.Contains(s, "a")

- strings.Count(s, "a") > 0
+ strings.Contains(s, "a")

- strings.Count(s, "a") != 0
+ strings.Contains(s, "a")

bytes.Count 具有和 strings.Count 一样的规则。

- strings.Index(s, "a") == -1
+ !strings.Contains(s, "a")

- strings.Index(s, "a") != -1
+ strings.Contains(s, "a")

bytes.Index 具有和 strings.Index 一样的规则。

1. 字符串的比较：

使用 bytes.Equal 替换 bytes.Compare：

- bytes.Compare(s,a) == 0
+ bytes.Equal(s, a)

- bytes.Compare(s,a) != 0
+ !bytes.Equal(s, a)

使用 == 替换 strings.Compare：

- strings.Compare("abc","a") == 0
+ "abc" == "a"

- strings.Compare("abc","a") != 0
+ "abc" != "a"

1. 递增 1、递减 1:

- i += 1
+ i++

- i -= 1
+ i--

1. time.Since 和 time.Until time.Since 替换 time.Now().Sub:

- time.Now().Sub( t1 )
+ time.Since( t1 )

time.Until 替换 t.Sub( time.Now() ):

- t1.Sub( time.Now() )
+ time.Until( t1 )

1. channel:

- _ = <-chan
+ <-done

1. map:

- x, _ := someMap["key"]
+ x := someMap["key"]

Example 4：基于表达式规则，重写代码

目前默认未启用，需使用 -rr 参数以使用默认内置规则生效，或者使用 -r 参数输入表达式。

1. 替换废弃的 ioutil 的函数调用：

import (
-	"io/ioutil"
+	"io
)

- buf, err := ioutil.ReadAll(f)
+ buf, err := io.ReadAll(f)

Example 5：移除多余的空行

1. 移除 struct 内部前后多余的空行：

type userfn91 struct{
-				
	name string
-				
}

1. 移除 func 内部前后多余的空行：

fn1() {
-				
	println("hello")
-				
}

1. 空 func 变为一行：

- fn1() {
- }
+ fn1() {}

Example 6：补充空行

在适当的位置添加空行可以增加代码的可读性。

1. struct 有文档的字段前后添加换行：

type User1 struct {
-				
	// on Name
	Name string
+				
	// on Age
	Age int
+				
	Grade int
	Class int

	Address string // 前面有空行，会保持
}

1. interface 有文档的方法前后添加换行：

type Group1 interface {
-				
	// Register 注册延迟函数
	Register(fn func())
+				
	Add()
+				
	// on Delete
	Delete()
+				
	Fn1()

	Fn2() // 前面有空行，会保持
-				
}

1. 多个定义之间添加空行:

type (
	User1 struct {
		name string
	}
+				
	User1 struct {
-				
		name string
	}
)

1. 全局的，不同类型定义之间添加空行：

var a="hello"
var b="world" // after b
+				
const c01="say"
+ 				
var a0 = "a0"

Example 7：Array / Slice 格式化

- var _ = []int{
-	1, 2, 
-	3, 4, 5}
// 当代码是如上这种 3 行格式的时候（这 3 行内不能有注释），会格式化为下面这样。
// 上面第一行是 2 个元素，所以按照每行 2 个元素格式化对齐。

+	var _ = []int{
+	 1, 2,
+	 3, 4,
+	 5,
+	 }

2 安装/更新

export GO111MODULE=on
go env GOPROXY=https://goproxy.cn,direct

go install github.com/fsgo/go_fmt/cmd/gorgeous@latest

升级 Go 版本后，请用最新版本 go 重新安装/更新 gorgeous 。
最低 Go 版本：go1.19

3 使用

3.0 help

gorgeous -help

usage: gorgeous [flags] [path ...]
  -d	display diffs instead of rewriting files
  -df string
    	display diffs format, support: text, json (default "text")
  -e	enable extra rules (default true)
  -ig string
    	import group sort rule,
    	stc: Go Standard pkgs, Third Party pkgs, Current ModuleByFile pkg
    	sct: Go Standard pkgs, Current ModuleByFile pkg, Third Party pkgs
    	 (default "stc")
  -local string
    	put imports beginning with this string as 3rd-party packages (default "auto")
  -mi
    	merge imports into one
  -r value
    	rewrite rule (e.g., 'a[b:len(a)] -> a[b:]')
  -rr
    	rewrite with build in rules:
    	a[b:len(a)] -> a[b:]
    	interface{} -> any
    	a == ""     -> len(a) == 0
    	a != ""     -> len(a) != 0
    	io/#ioutil.NopCloser -> io.NopCloser
    	io/#ioutil.ReadAll   -> io.ReadAll
    	io/#ioutil.ReadFile  -> os.ReadFile
    	io/#ioutil.TempFile  -> os.CreateTemp
    	io/#ioutil.TempDir   -> os.MkdirTemp
    	io/#ioutil.WriteFile -> os.WriteFile
    	io/#ioutil.Discard   -> io.Discard
  -s	simplify code (default true)
  -slcr
    	multiline copyright to single-line
  -trace
    	show trace infos
  -w	write result to (source) file instead of stdout (default true)

3.1 格式化 git 项目里有修改的.go文件

$ gorgeous

3.2 对当前目录所有 .go 文件格式化

$ gorgeous ./...

3.3 对指定 .go 文件格式化

$ gorgeous abc.go

4 git hooks

git commit 前自动格式化代码

4.1 配置项目 Hooks

编辑项目的 .git/hooks/pre-commit文件，将gorgeous命令加入。

方式1：

echo -e '\ngorgeous\n' >> $(git rev-parse --git-dir)/hooks/pre-commit
chmod 777 $(git rev-parse --git-dir)/hooks/pre-commit

方式2：

wget https://raw.githubusercontent.com/fsgo/go_fmt/master/pre-commit -O $(git rev-parse --git-dir)/hooks/pre-commit
chmod 777 $(git rev-parse --git-dir)/hooks/pre-commit

4.2 配置到全局 Hooks

该方式会导致项目自身的 hooks 失效。
若项目有自己的 hooks，请不要配置全局而要配置到单个项目。

mkdir -p ~/.git_config/hooks/
git config --global core.hooksPath ~/.git_config/hooks/

wget https://raw.githubusercontent.com/fsgo/go_fmt/master/pre-commit -O ~/.git_config/hooks/pre-commit
chmod 777 ~/.git_config/hooks/pre-commit

5 GitHub Actions

- name: Set up Go
  uses: actions/setup-go@v2
  with:
    go-version: 1.19

- name: install gorgeous
  run: go install github.com/fsgo/go_fmt/cmd/gorgeous@latest

- name: check style by gorgeous
  run: gorgeous -rr -d ./...

6 Visual Studio Code

1. 先安装插件 Run on Save
2. 配置插件，在保存文件的时候执行格式化命令：

  "runOnSave.commands": [
    {
        "match": "\\.go$",
        "command": "cd ${fileDirname} && gorgeous -rr ${fileBasename}",
        "runIn":"terminal"
    }
    ]

3.配置的 Go: Format Tool，设置为 "default"：

  "go.formatTool": "default"