goimport.md

概述

goimports 是 Go 语言的一个工具,用于自动修正(添加缺失的包和删除不必要的包)并格式化 Go 指定文件的代码。它类似于 gofmt,但 goimports 还额外处理了导入的部分。

安装 goimports

1
go install golang.org/x/tools/cmd/goimports@latest

确保 GOPATH/binGOBIN 在系统的 PATH 中,这样就可以从任何地方运行 goimports

使用 goimports 格式化目录下的 Go 文件

goimports 命令可以应用于单个文件或整个目录。要格式化一个目录下的所有 Go 文件(包括子目录),运行:

1
goimports -w .

这里的命令参数说明:

  • -w:写模式,告诉 goimports 直接修改文件,而不是打印到标准输出。
  • .:表示当前目录。可替换成任何指定的目录路径。

只想看到哪些文件会被修改,而不实际写入更改,可以运行:

1
goimports -d .

这里的 -d 参数让 goimports 打印出将会进行的修改的差异。

自动化 goimports

使用 Goland ,可以在设置中启用这个特性或通过扩展实现它。

在 Goland 中

  1. 确保安装了 File Watchers 语言扩展。
  2. 打开设置(File Watchers Settings)。
  3. 添加 goimports

[Media]
comment = Media
public = Yes
path = /opt/share
browseable = Yes
read only = No
guest ok = Yes
create mask = 0777
directory mask = 0777
force user = root


goimport.md
https://abrance.github.io/2024/04/30/domain/golang/goimport/
Author
xiaoy
Posted on
April 30, 2024
Licensed under