gofumpt 使用教程

gofumpt 使用教程

gofumptA stricter gofmt项目地址:https://gitcode.com/gh_mirrors/go/gofumpt

1. 项目介绍

gofumpt 是一个增强版的 Go 代码格式化工具，基于 Go 官方的 gofmt 工具开发。它不仅继承了 gofmt 的所有功能，还添加了一系列更加严格的格式化规则，旨在进一步提升 Go 代码的质量和一致性。gofumpt 已经成为 gopls（Go 官方语言服务）中可选的格式化工具，并且在 golangci-lint 中也有支持。

2. 项目快速启动

安装

你可以通过以下命令安装 gofumpt：

go install mvdan.cc/gofumpt@latest

使用

gofumpt 的使用方式与 gofmt 非常类似。你可以直接在命令行中使用 gofumpt 来格式化你的 Go 代码文件或目录。

# 格式化单个文件
gofumpt -w yourfile.go

# 格式化整个目录
gofumpt -w yourdirectory/

编辑器集成

Visual Studio Code

在 VS Code 中集成 gofumpt，你需要启用 gopls 并配置 gofumpt 选项：

{
    "go.useLanguageServer": true,
    "gopls": {
        "formatting.gofumpt": true
    }
}

3. 应用案例和最佳实践

案例1：赋值运算符后不能有空行

package demo

func foo() {
    foo := "bar"
}

格式化后：

package demo

func foo() {
    foo := "bar"
}

案例2：简单的错误检查之前不能有空行

package demo

func foo() {
    foo, err := processFoo()
    if err != nil {
        return err
    }
}

格式化后：

package demo

func foo() {
    foo, err := processFoo()
    if err != nil {
        return err
    }
}

案例3：标准库的导入必须位于顶部的单独组中

package demo

import (
    "foo.com/bar"
    "io"
    "io/ioutil"
)

格式化后：

package demo

import (
    "io"
    "io/ioutil"
    "foo.com/bar"
)

4. 典型生态项目

gopls

gopls 是 Go 官方的语言服务器，支持 gofumpt 作为其格式化工具之一。通过配置 gopls，你可以在编辑器中实时应用 gofumpt 的格式化规则。

golangci-lint

golangci-lint 是一个集成了多种 Go 代码检查工具的 linter，支持 gofumpt 作为其格式化工具之一。通过 golangci-lint，你可以在 CI/CD 流程中自动应用 gofumpt 的格式化规则。

---

通过以上步骤，你可以快速上手并集成 gofumpt 到你的 Go 项目中，进一步提升代码质量和一致性。

gofumptA stricter gofmt项目地址:https://gitcode.com/gh_mirrors/go/gofumpt