为lint做准备

安装配置 golangci-lint、gofumpt、goimports

golangci-lint

amd64 机器上安装

适用于 amd64 linux 和 macOS。

dapr提供了 make lint target 来执行 golangci-lint，如果没有安装 golangci-lint 则会报错：

$ cd dapr
$ make lint       
golangci-lint run --timeout=20m
make: golangci-lint: No such file or directory
make: *** [Makefile:341: lint] Error 127

之前 dapr 用的是 v1.31 老版本，在2022年5月之后， dapr CI 中采用的是最新版本，具体是 golangci-lint v1.51.2。

TIPs: 如何知道 dapr 目前采用的是哪个版本的 golangci-lint？

请查看 dapr 仓库下的 Makefile 文件，找到下述内容：

Please use golangci-lint version v1.51.2 , otherwise you might encounter errors.

查看 .github/workflows/dapr.yml 文件，找到下述内容：

GOLANGCILINT_VER: “v1.51.2”

安装方式参考 https://golangci-lint.run/usage/install/ 。在release页面找到对应版本，主要不要直接安装最新版本：

https://github.com/golangci/golangci-lint/releases/tag/v1.51.2

linux下执行如下命令：

$ curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.51.2 # 特别注意这里一定要指定正确的版本
golangci/golangci-lint info checking GitHub for tag 'v1.51.2'
golangci/golangci-lint info installed /home/sky/work/soft/gopath/bin/golangci-lint


$ golangci-lint --version
golangci-lint has version 1.51.2 built from 3e8facb4 on 2023-02-19T21:43:54Z

切记

golangci-lint 一定要安装对应的版本！

m1 macbook上安装

在 m1 macbook 上， dapr之前使用的 1.31 版本发布较早，没有提供对 m1 （也就是darwin-arm64）的支持，但最新的dapr改用 1.45.2 版本之后就支持 arm64 了，所以可以用同样的方式安装：

$ curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.52.1
golangci/golangci-lint info checking GitHub for tag 'v1.52.1'
golangci/golangci-lint info found version: 1.52.1 for v1.52.1/linux/amd64
golangci/golangci-lint info installed /home/sky/work/soft/gopath/bin/golangci-lint
 
$ golangci-lint --version
golangci-lint has version 1.52.1 built with go1.20.2 from d92b38cc on 2023-03-21T19:48:38Z

注意：golangci-lint 新版本似对 go 有版本要求，如果遇到报错，如我在 golang 1.17 版本下运行会报错：

$ golangci-lint --version

panic: load embedded ruleguard rules: rules/rules.go:13: can't load fmt

goroutine 1 [running]:
github.com/go-critic/go-critic/checkers.init.22()
	github.com/go-critic/go-critic@v0.6.2/checkers/embedded_rules.go:46 +0x494

$ go version  
go version go1.17.8 darwin/arm64

升级 golang 到新版本如 1.18 就正常了。

gofumpt

运行 lint 之后如果发现 File is not gofumpt-ed ：

$ make lint
golangci-lint run --timeout=20m

tests/perf/utils/grpc_helpers.go:4               gofumpt    File is not `gofumpt`-ed
tests/perf/utils/grpc_helpers.go:9               gofumpt    File is not `gofumpt`-ed

则需要安装 gofumpt 进行文件格式，参考 https://github.com/mvdan/gofumpt ：

$ go install mvdan.cc/gofumpt@latest
go: downloading golang.org/x/sync v0.0.0-20220819030929-7fc1605a5dde
go: downloading golang.org/x/sys v0.0.0-20220829200755-d48e67d00261

然后对有问题的文件执行 gofumpt :

gofumpt -w tests/perf/utils/grpc_helpers.go

goimports

运行 lint 之后如果发现 File is not goimports-ed ：

$ make lint
golangci-lint run --timeout=20m

tests/perf/utils/grpc_helpers.go:5               goimports  File is not `goimports`-ed with -local github.com/dapr/

则需要安装 goimports 对import内容进行文件格式：

go get golang.org/x/tools/cmd/goimports

手工执行

$ goimports -e -d -local github.com/dapr/ tests/perf/utils/grpc_helpers.go
diff -u tests/perf/utils/grpc_helpers.go.orig 
tests/perf/utils/grpc_helpers.go
--- tests/perf/utils/grpc_helpers.go.orig       2022-04-08 22:47:08.199473748 +0800
+++ tests/perf/utils/grpc_helpers.go    2022-04-08 22:47:08.199473748 +0800
@@ -4,10 +4,11 @@
        "context"
        "time"
 
-       v1 "github.com/dapr/dapr/pkg/proto/common/v1"
-       runtimev1pb "github.com/dapr/dapr/pkg/proto/runtime/v1"
        "google.golang.org/grpc"
        "google.golang.org/protobuf/types/known/anypb"
+
+       v1 "github.com/dapr/dapr/pkg/proto/common/v1"
+       runtimev1pb "github.com/dapr/dapr/pkg/proto/runtime/v1"
 )
 
 $ goimports -w tests/perf/utils/grpc_helpers.go

配置 goland 自动执行

参考下面文章的建议：

Running ‘goimports’ on save in GoLand

需要修改的地方有几个，打开 goland 的 settings：

“Action on Save” 中，勾选 “reformat code” 和 “Optimize imports”
“Code Style” -> “Go” -> “Import” 中，“sorting by” 下拉框默认是 “gofmt”，修改为 “goimports”，然后勾选相关的选项
“Code Style” -> “Go” -> “other” 中, 勾选 “add a leading space to comments”，这会在注释内容前加一个空格