Lösung zur lokalen Verwendung von golangci-lint

Warum brauchen wir Codeinspektionen?

Im Allgemeinen ist die Codeüberprüfung aus drei Gründen wichtig:

1. Vermeiden Sie Fehler auf niedriger Ebene: Einige häufige Codeprobleme führen, wenn sie nicht rechtzeitig vor der Kompilierung oder Ausführung entdeckt werden, direkt zur Kompilierung oder Laufzeit Fehler, wirkt sich auf die Entwicklungseffizienz und die Codequalität aus.

2. Einheitliche Codierungsgewohnheiten: Um die spätere Wartung und das Lesen zu erleichtern, muss der Code, den wir schreiben, ebenfalls übereinstimmen bestimmte Formatspezifikationen;

3. Online-Codequalität sicherstellen: Bei der Versionsverwaltung müssen wir vor der Übermittlung oder Veröffentlichung automatisch einige Codeprüfungen durchführen, um sicherzustellen, dass unser Code den endgültigen Versionsanforderungen entspricht.

golangci-lint作为 golang 支持最好的代码检查工具，而且在golang开源库中，有着大量的使用，由此可以说明为了项目更好的进行开发，和后期更好的维护，我们也可以尝试着引入它。

尝试使用 goalngci-lint 的问题

我们再日常的开发过程中，习惯的行为是：code -> git add -> git commit -> git push 一条龙服务。

1. 手动执行模式：

那么这个时候需要在 git commit 之前检查我们的代码是否已经符合一定的规则，就需要手动执行 golangci-lint run ./... ，或者在 git push

🎜🎜Fragen zum Versuch, goalngci-lint zu verwenden🎜🎜In unserem täglichen Entwicklungsprozess ist unser übliches Verhalten: Code -> Git Commit -> 🎜

🎜🎜1. Manueller Ausführungsmodus: 🎜 🎜

🎜 Dann müssen Sie zu diesem Zeitpunkt git commit Bevor wir überprüfen, ob unser Code bestimmten Regeln entspricht, müssen wir ihn manuell ausführengit push für die vorherige Codeüberprüfung. Da es sich bei unserem Commit und Push um tägliche Vorgänge handelt, kommen sie wahrscheinlich häufig vor und diese manuelle Methode ist etwas umständlich. Während der Verwendung kann es aufgrund einiger Dinge passieren, dass Sie es vergessen oder es nicht direkt ausführen, weil Sie sich lästig fühlen und volles Vertrauen in Ihren eigenen Code haben. Nach der Verwendung als Ganzes ist es also immer noch sehr glatt. Sie sollten wissen, dass es nicht glatt ist. 🎜

2. Gitlab-Runner-Modus:

Der Grund, warum ich an diese Lösung gedacht habe, könnte sein, dass ich zu viele Open-Source-Bibliotheken gesehen habe, die die Servercode-Inspektion verwenden (obwohl es sich nur um PR handelt).

Erstellen Sie ein Gitlab durch docker und habe den Runner über das Tutorial konfiguriert, was mich zwei Tage gekostet hat. Allerdings musste ich die CI-Konfiguration von Gitlab, die Jobkonfiguration des Runners und die Installation einiger Tools lernen, aber die Ergebnisse sind möglicherweise nicht zufriedenstellend.

Wenn ich davon ausgehe, dass die Ergebnisse der Serverprüfung auf Gitlab liegen, geht unsere Entwicklung im Grunde (wenn wir den Code zum ersten Mal abrufen) nicht an Gitlab. Wie kann diese Fehlermeldung also an die entsprechende Person übermittelt werden? Oder wie ordnet man Fehler zu, wenn mehrere Personen eine Funktion schreiben? Es dauerte zwei Tage, bis diese Lösung mithilfe der Serverprüfung erfolgreich war.

3. Lokales Pre-Commit

Da die Serverprüfung nicht funktioniert, führe ich vor dem Absenden des Codes eine Skriptprüfung durch. Wenn Fehler vorliegen, werden diese nicht übermittelt, was Sie dazu zwingt Gehen Sie mit Ihren Fehlern um. Hahaha (der Mechanismus) wird Ihnen nicht sagen, dass Sie die Unterwerfung erzwingen können (verwenden Sie ihn mit Vorsicht).

Damit beginnt das Schreiben des lokalen Pre-Commit-Skripts. Ich habe im Internet nach Informationen gesucht und ein Pre-Commit-Skript geschrieben, das auf meinen eigenen Bedürfnissen basiert. Hauptsächlich der Codefmt和代码golangci-lint 检查。心想这次一定能成！

这时，脚本写好了，但是改怎么上传到服务器呢，由于.git 文件夹作为默认不可上传到服务器，只有写一个 init.sh 的脚本来上传服务器了，所有开发人员在第一次获取项目的时候只需要执行一下，本地的配置就好了，这就简单很多了。

试着跑了一下：

。。。结果不得行。此处文字已经不能表达我的心情了。

经过一系列的操作后，发现golangci-lint

Zu diesem Zeitpunkt ist das Skript geschrieben, aber wie kann ich es auf den Server hochladen? Da der .git-Ordner standardmäßig nicht auf den Server hochgeladen werden kann, besteht die einzige Möglichkeit darin, ein init.sh-Skript zu schreiben, um ihn auf den Server hochzuladen Alle Entwickler müssen es zum ersten Mal auf den Server hochladen. Sie müssen es nur lokal ausführen und konfigurieren, was viel einfacher ist.

Versuchen Sie Folgendes:

1. . . . Das Ergebnis funktioniert nicht. Die Worte hier können meine Gefühle nicht ausdrücken.

   Nach einer Reihe von Vorgängen habe ich Folgendes gefunden: golangci-lint unterstützt keine Überprüfung einzelner Dateien.

   🎜Das Prinzip meiner Skriptprüfung ist wie folgt: 🎜🎜🎜🎜🎜Alle im aktuellen Commit geänderten Go-Dateien filtern🎜

2. Für jede Datei einmal ausführengolangci-lint run xxx.gogolangci-lint run xxx.go

这就尴尬了；后面本来想通过脚本来过滤出所有文件所在的文件夹，只针对文件夹来跑，由于写这个脚本对于我来说有点复杂（不会这个难的）了。当然还有一个问题是 golangci-lint 的执行过程需要很长的时间，不能说每次commit都等个1分钟，这不就变相增加摸鱼时间了[/doge] 。

4. 本地 pre-commit + pre-push

经过多番折腾，终于诞生了一个相对前面方案，非常适合我们的一种方式。

通过 init.sh 修改默认git hook 位置到 我们创建的 githooks 文件夹，具体的操作可以查看脚本内容，我觉得脚本写的还是挺明确的。

通过 pre-commit 提供 fmt 和 import 的检查和自动格式化再自动添加，避免一些忘记自己格式化的操作。

通过pre-push

Das ist peinlich; später wollte ich ursprünglich ein Skript verwenden, um die Ordner herauszufiltern, in denen sich alle Dateien befinden, und es nur auf den Ordnern ausführen, da das Schreiben dieses Skripts für mich etwas kompliziert ist (nicht). so schwierig) ). Natürlich gibt es noch ein anderes Problem:

4. Lokales Pre-Commit + Pre-Push

Nach langem Hin und Her haben wir endlich eine Lösung gefunden, die für uns einigermaßen geeignet ist.

viainit.sh Ändern Sie die Standardeinstellunggithooks Ordner, spezifisch für Sie Ich kann den Inhalt des Skripts durch den Vorgang anzeigen. Ich denke, das Skript ist ziemlich klar.

viapre-commit Bietet FMT- und Importprüfung und automatische Formatierung. Hinzugefügt, um einige Vorgänge zu vermeiden wo man vergisst, sich zu formatieren.

via

Das obige ist der detaillierte Inhalt vonLösung zur lokalen Verwendung von golangci-lint. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!