Inspection d'automatisation du code que Gopher doit connaître

Cet article explique comment utiliser les git hooks pour implémenter la révision automatisée du code du git commit du langage Go via les deux principaux frameworks golangci-lint et pre-commit . L'inspection statique du code est un problème courant qui peut garantir dans une large mesure la qualité du code. La propre suite du langage Go nous fournit l'outil d'analyse de code statique vet, qui peut être utilisé pour vérifier le code du projet go qui peut être compilé mais peut encore contenir des erreurs. Les lecteurs qui ne le comprennent pas peuvent vérifier l'introduction dans le précédent . article

. Sauf aller chez le vétérinaire , de nombreux Gophers peuvent aussi le savoir goimports outil de formatage du code gofmt, et le outil. Les outils mentionnés ci-dessus peuvent être appelés linter . Ici, nous devons d’abord savoir ce qu’est la charpie. Dans Wikipédia, les peluches sont définies comme suit : En informatique, lint est le nom d'un programme outil utilisé pour marquer certains passages suspects et non structurés (pouvant provoquer des bugs) dans le code source. Il s'agit d'un outil d'analyse de programme statique, d'abord adapté au langage C et développé sur la plateforme UNIX. Il est ensuite devenu un terme général pouvant être utilisé pour décrire un outil utilisé dans n'importe quel langage de programmation informatique pour marquer les passages douteux du code source.

Dans le domaine du langage Go, golangci-lint est un framework linter complet. Il intègre de nombreux linters, dont plusieurs mentionnés ci-dessus. Une utilisation appropriée peut nous aider à analyser et à inspecter le code Go de manière plus complète. Les éléments linter pris en charge par golangci-lint peuvent être consultés sur la page https://golangci-lint.run/usage/linters/#golint

Utiliser golangci-lint

Télécharger 1go get github.com/golangci/golangci-lint/cmd/golangci-lint@latest Vérifiez que l'installation est réussie 1$ golangci-lint version 2golangci-lint has version v1.41.1 built from (unknown, mod sum: "h1:KH28pTSqRu6DTXIAANl1sPXNCmqg4VEH21z6G9Wj4SM=") on (unknown) Voir le document d'aide 1$ golangci-lint help linters lin en vigueur par défaut ters

Les linters ne sont pas efficaces par défaut

linters 的分类

可以看出，golangci-lint 框架支持的 linter 非常全面，它包括了 bugs、error、format、unused、module 等常见类别的分析 linter。

实例 下面来展示使用示例，现有以下项目结构代码

1. 2├── go.mod 3├── main.go 4└── typecheck 5 └── typecheckDemo.go 其中 main.go 中的代码如下

1package main 2 3import ( 4 "fmt" 5) 6 7func main() { 8 s1 := "this is a string" 9 fmt.Printf("inappropriate formate %s\n", &s1) 10 11 i := 1 12 fmt.Println(i != 0 || i != 1) 13 14 arr := []int{1, 2, 3} 15 for _, i := range arr { 16 go func() { 17 fmt.Println(i) 18 }() 19 } 20} typecheckDemo.go 中的代码

1package typecheck 2 3import "fmt" 4 5func check() { 6 t := unexistType{} 7 fmt.Println(t) 8} 9 10func unused() { 11 i := 1 12} 这两个源码文件中的代码都是存在一些问题的。此时，我们通过 golangci-lint 工具来对源码文件进行检查

可以看到，我们在程序根目录中执行 golangci-lint run 命令，它等效于 golangci-lint run ./... 。此时，它将 main.go 和 typecheckDemo.go 中存在的潜在问题都检测到了，并标记了是何种 linter 检测（这里是 typecheck 和 govet 两种）到的。

当然，也可以通过命令 golangci-lint run dir1 dir2/... dir3/file1.go 对某特定的文件或文件夹进行分析。

灵活运用命令选项 golangci-lint 可以通过 -E/--enable 去开启指定 linter，或者 -D/--disable 禁止指定 linter。

1golangci-lint run --disable-all -E errcheck 如上命令代表的就是除了 errcheck 的 linter，禁止其他所有的 linter 生效。

golangci-lint 还可以通过 -p/--preset 指定一系列 linter 开启。

1golangci-lint run -p bugs -p error 如上命令代表的就是所有属于 bugs 和 error 分类的 linter 生效。

更多命令选项，可以通过 golangci-lint run -h 查看

配置文件 当然，如果我们要为项目配置 golangci-lint，最好的方式还是配置文件。golangci-lint 在当前工作目录按如下顺序搜索配置文件。

.golangci.yml

.golangci.yaml

.golangci.toml

.golangci.json

在 golangci-lint 官方文档 https://golangci-lint.run/usage/configuration/#config-file 中，提供了一个示例配置文件，非常地详细，在这其中包含了所有支持的选项、描述和默认值。

在这里给出一个比较不错的配置示例文档

1linters-settings: 2 errcheck: 3 check-type-assertions: true 4 goconst: 5 min-len: 2 6 min-occurrences: 3 7 gocritic: 8 enabled-tags: 9 - diagnostic 10 - experimental 11 - opinionated 12 - performance 13 - style 14 govet: 15 check-shadowing: true 16 nolintlint: 17 require-explanation: true 18 require-specific: true 19 20linters: 21 disable-all: true 22 enable: 23 - bodyclose 24 - deadcode 25 - depguard 26 - dogsled 27 - dupl 28 - errcheck 29 - exportloopref 30 - exhaustive 31 - goconst 32 - gocritic 33 - gofmt 34 - goimports 35 - gomnd 36 - gocyclo 37 - gosec 38 - gosimple 39 - govet 40 - ineffassign 41 - misspell 42 - nolintlint 43 - nakedret 44 - prealloc 45 - predeclared 46 - revive 47 - staticcheck 48 - structcheck 49 - stylecheck 50 - thelper 51 - tparallel 52 - typecheck 53 - unconvert 54 - unparam 55 - varcheck 56 - whitespace 57 - wsl 58 59run: 60 issues-exit-code: 1 使用 pre-commit hook

在项目开发中，我们都会使用到 git，因此我们可以将代码静态检查放在一个 git 触发点上，而不用每次写完代码手动去执行 golangci-lint run 命令。这里，我们就需要用到 git hooks。

git hooks Git hooks est un mécanisme de hook de git qui permet aux utilisateurs d'exécuter une logique personnalisée à différentes étapes des opérations git. git hooks .git/hooks 下面配置，配置文件的名称是固定的，实质上就是一个个 shell 脚本。根据 git 执行体，钩子被分为客户端钩子和服务端钩子两类。

客户端钩子包括： pre-commit 、 prepare-commit-msg 、 commit-msg 、 post-commit 等，主要用于控制客户端git的提交工作流。服务端钩子： pre-receive 、 post-receive 、 update .git/hooks La configuration suivante, le nom de la configuration Le fichier est corrigé, qui sont essentiellement des scripts shell. Selon le corps d'exécution de Git, les hooks sont divisés en deux catégories : les hooks client et les hooks serveur.

Les crochets côté client incluent :

pre-commit

, 🎜 🎜prepare-commit-msg🎜 🎜, 🎜 🎜commit-msg🎜 🎜, 🎜 🎜post-commit🎜 🎜, etc. , principalement utilisé Pour contrôler le flux de travail de soumission du client git. Hook du serveur : 🎜 🎜pré-réception🎜 🎜, 🎜 🎜post-réception🎜 🎜, 🎜 🎜update🎜 code >🎜, principalement appelé lorsque le serveur reçoit l'objet soumis et avant de le pousser vers le serveur. 🎜🎜🎜🎜Notez que les noms de fichiers se terminant par .sample sont des exemples officiels. Ces exemples de scripts ne seront pas exécutés et ne prendront effet qu'après avoir été renommés (en supprimant le suffixe .sample). 🎜🎜🎜🎜🎜 而 pre-commit 正如其名一样，它在 git add 提交之后，运行 git commit 时执行，脚本执行没报错就继续提交，反之就驳回提交的操作。

pre-commit 试想，如果我们同时开发多个项目，也许项目的所采用的的编程语言并不一样，那么它们所需要的 git hooks 将不一致，此时我们是否要手动给每个项目都配置一个单独的 pre-commit 脚本呢，或者我们是否要去手动下载每一个钩子脚本呢。

实际上，并不需要这么麻烦。这里就引出了 pre-commit 框架，它是一个与语言无关的用于管理 git hooks 钩子脚本的工具（虽然采用 Python 开发，但不止于 Python ）。

安装

1$ pip install pre-commit 2或者 3$ curl https://pre-commit.com/install-local.py | python - 4或者 5$ brew install pre-commit 安装成功

1$ pre-commit --version 2pre-commit 1.20.0 编写配置文件

首先我们在项目根目录下新建一个 .pre-commit-config.yaml 文件，这个文件我们可以通过 pre-commit sample-config 得到最基本的配置模板，通过 pre-commit 支持的 hooks 列表 https://pre-commit.com/hooks.html 中，我们找到了 golangci-lint。

因此，使用 golangci-lint 的 .pre-commit-config.yaml 配置内容如下

1repos: 2- repo: https://github.com/golangci/golangci-lint 3 rev: v1.41.1 # the current latest version 4 hooks: 5 - id: golangci-lint 安装 git hook 脚本

运行 pre-commit install 命令根据配置文件安装

1$ pre-commit install 2pre-commit installed at .git/hooks/pre-commit 此时，生成了新的 Python 语言编写的 .git/hooks/pre-commit 钩子文件。

git commit 触发 golangci-lint 检查

首次运行时，由于 pre-commit 没有 golangci-lint 的环境，会初始化下载安装相关依赖。在下一次 git-commit 的时候，就不会有前三行信息了。

如上图所示，报错内容和我们手动执行 golangci-lint run 命令输出的一样，只有当我们将代码更改正确，才能顺利通过检查，从而 commit 成功。

总结

La qualité du code est un problème auquel chaque développeur doit prêter attention. La série de plug-ins linter fournis par golangci-lint peut aider Gopher à découvrir et à résoudre les bogues potentiels en temps opportun. dans une large mesure. Dans le même temps, golangci-lint peut également standardiser efficacement le style de code au sein de l'équipe de projet et réduire la charge mentale de la révision du code. J'espère que les Gophers pourront l'utiliser efficacement.

L'outil git-commit génère ce dont les hooks git ont besoin via le fichier de configuration pre-commit pre-commit Script Hook, qui peut convertir le travail d'inspection de code statique via golangci-lint d'actions manuelles en un processus automatisé. L'introduction ci-dessus à git-commit est relativement simple. Les lecteurs qui souhaitent explorer plus en détail peuvent accéder directement au site officiel https://pre-commit.com/index.html pour apprendre. En fait, nous pouvons étendre ce processus automatisé plus largement. Par exemple, nous pouvons utiliser les règles golangci-lint pour empêcher l'extraction de code non standard du projet vers la base de code locale. Cela peut être ajouté au processus d'intégration continue CI pour y parvenir. automatisation. Pour des raisons d'espace, l'utilisation de la partie CI est laissée au lecteur pour l'explorer par lui-même.

🎜