Repository tools imports formatter README_CN

imports-formatter

主仓库文档快照；main 的说明不自动适用于所有已发布版本。 来源：原文 · 提交 832124aaacf0 · 返回目录

imports-formatter

English | 中文

imports-formatter 会按照 dubbo-go 使用的分组风格重写 Go import 块。

它会扫描 Go module，跳过包含 Code generated by 的生成文件，并将 import 分为：

• Go 标准库 import
• 第三方 import
• 当前 module 内部 import

安装

go install dubbo.apache.org/dubbo-go/v3/tools/imports-formatter@latest

请确保 $(go env GOPATH)/bin 已加入 PATH。

也可以通过 dubbogo-cli 安装：

dubbogo-cli install formatter

使用

格式化当前 module：

imports-formatter

格式化指定 module 路径：

imports-formatter --path /path/to/module

当目标目录不包含 go.mod 时，可以显式传入 module path：

imports-formatter --path /path/to/module/subdir --module dubbo.apache.org/dubbo-go/v3

关闭第三方 import 分组之间的空行：

imports-formatter --bl=false

参数

参数	默认值	说明
--path	当前目录	递归扫描的目录。
--module	从 go.mod 读取	用于识别内部 import 的 Go module path。
--bl	true	是否在第三方 import 分组之间插入空行。

注意事项

imports-formatter 会原地修改文件。提交前请检查 diff。