go_fmt

KO | EN

gitlite — search

#ai #typescript #llm #rust #linux #docker #nodejs #windows #awesome #cli #vue #mcp #ios #openai

(★ 108)

更好用的 go代码格式化工具

go_fmt Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[Deutsch](https://zdoc.app/de/fsgo/go_fmt) | 
[English](https://zdoc.app/en/fsgo/go_fmt) | 
[Español](https://zdoc.app/es/fsgo/go_fmt) | 
[français](https://zdoc.app/fr/fsgo/go_fmt) | 
[日本語](https://zdoc.app/ja/fsgo/go_fmt) | 
[한국어](https://zdoc.app/ko/fsgo/go_fmt) | 
[Português](https://zdoc.app/pt/fsgo/go_fmt) | 
[Русский](https://zdoc.app/ru/fsgo/go_fmt) | 
[中文](https://zdoc.app/zh/fsgo/go_fmt)

# 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` 目录。  
若需要可进入其目录里执行该命令。

<details><summary>Example 1：补齐 struct key</summary>

``` diff
- u2 := User{"hello", 12}
+ u2 := User{Name: "hello", Age: 12}
```
</details>

<details><summary>Example 2：注释格式化</summary>

```diff
- //User 注释内容
+ // User 注释内容
type User struct{
```
</details>

<details><summary>Example 3：简化、重写代码</summary>

1. 简化循环逻辑：
```diff
- s[a:len(s)]
+ s[a:]

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

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

- for {
+ for ok{
-   if !ok {
-     break
-   }
   // do something
 }
```

2. 简化判断逻辑：
```diff
- 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 == index
+ _ = index == 1

- _ = 1 < index
+ _ = index > 1

func ok() bool {
- 	if a > b {
- 		return true
- 	}else{
- 		return false
+ 	return a > b
}

func ok() bool {
- 	if a > b {
- 		return true
- 	return false
+ 	return a > b
}

- if val!=nil && len(val)!=0 {
+ if len(val)!=0 {
   // do something
}

```

3. 使用 `strings.Contains` 替换 `strings.Count` 和 `strings.Index`
```diff
- 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` 一样的规则。

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

- strings.Index(s, "a") != -1
+ strings.Contains(s, "a")
```
`bytes.Index` 具有和 `strings.Index` 一样的规则。

4. 字符串的比较：

使用 `bytes.Equal` 替换 `bytes.Compare`：
```diff
- bytes.Compare(s,a) == 0
+ bytes.Equal(s, a)

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

使用 `==` 替换 `strings.Compare`：
```diff
- strings.Compare("abc","a") == 0
+ "abc" == "a"

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

5. 递增 1、递减 1:
```diff
- i += 1
+ i++

- i -= 1
+ i--
```

6. time.Since 和 time.Until
`time.Since`  替换 `time.Now().Sub`:
```diff
- time.Now().Sub( t1 )
+ time.Since( t1 )
```

`time.Until`  替换 `t.Sub( time.Now() )`:
```diff
- t1.Sub( time.Now() )
+ time.Until( t1 )
```

7. channel:
```diff
- _ = <-chan
+ <-done
```

8. map:
```diff
- x, _ := someMap["key"]
+ x := someMap["key"]
```

9. fmt:
```diff
- fmt.Errorf("hello")
+ errors.New("hello")

- fmt.Printf("abc")
+ fmt.Print("abc")

- log.Printf("abc")
+ log.Print("abc")

- _ = errors.New(fmt.Sprintf("hello"))
+ _ = errors.New("hello")

- _ = errors.New(fmt.Sprintf("hello %s", "world"))
+ _ = fmt.Errorf("hello %s", "world")

- bf.Write([]byte(fmt.Sprintf("hello %d", 1)))
+ fmt.Fprintf(bf,"hello %d",1)

- fmt.Sprintf("%d",123)  // 性能  1
+ strconv.Atoi(123)      // 性能  3

- fmt.Sprintf("%v",123)
+ strconv.Atoi(123)

- fmt.Sprintf("%d",int32Num)
+ strconv.FormatInt(int64(int32Num), 10)

- fmt.Sprintf("%d",uint32Num)
+ strconv.FormatUint(uint64(uint32Num), 10)
```

10. raw string :
```diff
- regexp.Compile("\\A(\\w+) profile: total \\d+\\n\\z")
+ regexp.Compile(`\A(\w+) profile: total \d+\n\z`)
```

11. sort :
```diff
- sort.Sort(sort.StringSlice(x))
+ sort.Strings(x)
```

12. os.IsExist 等替换为使用 errors.Is
```diff
- os.IsExist(err)
+ errors.Is(err, fs.ErrExist)

- os.IsNotExist(err)
+ errors.Is(err, fs.ErrNotExist)

- os.IsPermission(err)
+ errors.Is(err, fs.ErrPermission)
```
添加于： 2025-09-02 v0.7.0

</details>

<details><summary>Example 4：基于表达式规则，重写代码</summary>
使用 `-rr=false` 可以使用默认内置规则不生效。

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

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

- buf, err := ioutil.ReadAll(f)
+ buf, err := io.ReadAll(f)
```
</details>

<details><summary>Example 5：移除多余的空行</summary>

1. 移除 struct 内部前后多余的空行：
```diff
type userfn91 struct{
-				
	name string
-				
}
```

2. 移除 func 内部前后多余的空行：
``` diff
fn1() {
-				
	println("hello")
-				
}

```

3. 空 func 变为一行：
```diff
- fn1() {
- }
+ fn1() {}
```
</details>

<details><summary>Example 6：补充空行</summary>
在适当的位置添加空行可以增加代码的可读性。

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

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

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

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

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

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

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

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

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

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

</details>

<details><summary>Example 7：Array / Slice 格式化</summary>

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

+	var _ = []int{
+	 1, 2,
+	 3, 4,
+	 5,
+	 }
```
</details>

## 2 安装/更新
```bash
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.23

## 3 使用

### 3.0 help
> gorgeous -help

```bash
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 groups sort rule,
    	stc: Go Standard package, Third Party package, Current package
    	sct: Go Standard package, Current package, Third Party package
    	 (default "stc")
  -local string
    	current package path, will put imports beginning with this string as 3rd-party packages.
    	by default, it will got from 'go.mod' file.
    	 (default "auto")
  -mi
    	merge imports into one section.
    	with env 'GORGEOUS_MI=false' to set default value as false (default true)
  -r value
    	rewrite rule (e.g., 'a[b:len(a)] -> a[b:]')
    	or a file path for rewrite rules (like -rr)

-rr
    	rewrite with build in rules:
    	a[b:len(a)] -> a[b:]
    	interface{} -> any                    // go1.18
    	io/#ioutil.NopCloser -> io.NopCloser  // go1.16
    	io/#ioutil.ReadAll   -> io.ReadAll    // go1.16
    	io/#ioutil.ReadFile  -> os.ReadFile   // go1.16
    	io/#ioutil.TempFile  -> os.CreateTemp // go1.16
    	io/#ioutil.TempDir   -> os.MkdirTemp  // go1.16
    	io/#ioutil.WriteFile -> os.WriteFile  // go1.16
    	io/#ioutil.Discard   -> io.Discard    // go1.16

with env 'GORGEOUS_RR=false' to set default value as false
    	 (default true)
  -s	simplify code (default true)
  -slcr
    	multiline copyright to single-line
    	with env 'GORGEOUS_SLCR=true' to set default value as true (default true)
  -trace
    	show trace messages
  -w	write result to (source) file instead of stdout (default true)
```
### 3.1 格式化 `git` 项目里有修改的`.go`文件
```bash
$ gorgeous
```

### 3.2 对当前目录所有 `.go` 文件格式化
```bash
$ gorgeous ./...
```

### 3.3 对指定 `.go` 文件格式化
```bash
$ gorgeous abc.go
```

### 3.4 从 STDIN 读取代码并输出到 STDOUT
```bash
$ cat code.go|gorgeous stdin
```

## 4 git hooks
在执行 git 命令时自动格式化或者检查是否已经完成格式化。

### 4.1 使用 bin-auto-switcher 添加全局 Hooks
[bin-auto-switcher](https://github.com/fsgo/bin-auto-switcher) 可以很方便的对任意命令添加前置和后置 Hooks。

1. 安装 git 替换命令（安装后，执行 git 命令时，实际会执行此命令，并执行配置的 Hooks）：  
    `go install github.com/fsgo/bin-auto-switcher/git@latest`
2. 编辑配置文件 `~/.config/bas/git.toml`
```toml
[[Rules]]
Cmd = "/usr/local/bin/git" # 替换为实际 git 命令的地址

[[Rules.Pre]]
Match = "^add\\s"  # 在执行 git add 命令前执行
Trace = true       # 打印日志
#Cond  = ["in_dir /home/work/goapps"]
Cond  = ["go_module"]
Cmd   = "gorgeous"

# 在 go.mod 文件所在目录下执行 gorgeous 命令
#Cmd   = "inner:find-exec"
#Args  = ["-name","go.mod","-dir_not","testdata","gorgeous"]
```

### 4.2 使用 git hooks

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

```bash
# 检查是否格式化
echo -e '\n gorgeous -d \n' >> $(git rev-parse --git-dir)/hooks/pre-commit

chmod 777 $(git rev-parse --git-dir)/hooks/pre-commit

# 或者：自动格式化
echo -e '\n gorgeous \n git add . \n' >> $(git rev-parse --git-dir)/hooks/pre-commit
```

还可以配置到全局 Hooks：
> 该方式会导致项目自身的 hooks 失效。  
> 若项目有自己的 hooks，请不要配置全局而要配置到单个项目。
```bash
mkdir -p ~/.git_config/hooks/
git config --global core.hooksPath ~/.git_config/hooks/

echo -e '\n gorgeous -d\n' >>  ~/.git_config/hooks/pre-commit
chmod 777 ~/.git_config/hooks/pre-commit
```

## 5 GitHub Actions
```yml
- name: Set up Go
  uses: actions/setup-go@v4
  with:
    go-version: 1.23

- name: gorgeous style check 
  # gorgeous 添加 “-d” 参数后，只检查代码风格，不重写文件，会在终端输出需要格式化的文件信息，退出码为非 0
  run: go install github.com/fsgo/go_fmt/cmd/gorgeous@latest && gorgeous -d ./...
```

## 6 Visual Studio Code

### 6.1 As goformat
1. Install as goformat:
```bash
go install github.com/fsgo/go_fmt/cmd/goformat@latest
```
2. 配置的 `Go: Format Tool`，设置为 "goformat"：
```
  "go.formatTool": "goformat"
```

### 6.2 Run on Save
1. 先安装插件 [Run on Save](https://marketplace.visualstudio.com/items?itemName=pucelle.run-on-save) <img src="https://github.com/pucelle/vscode-run-on-save/raw/master/images/logo.png" width="20px"/>

2. 配置插件，在保存文件的时候执行格式化命令：
```json
  "runOnSave.commands": [
    {
        "match": "\\.go$",
        "command": "cd ${fileDirname} && gorgeous -rr ${fileBasename}",
        "runIn":"terminal"
    }
 ]
```
3. 配置的 `Go: Format Tool`，设置为 "default"：
```
  "go.formatTool": "default"
```

go_fmt

go_fmt Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

go_fmt

go_fmt Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README