fuck-u-code: ein Testwerkzeug zur Bewertung der Codequalität

fuck-u-codeist ein spezielles Tool zur Analyse der Codequalität, mit dem die Komplexität und Unordnung des Codes eines Projekts erkannt und mit einem intuitiven "Shit Mountain Index" bewertet werden kann. Das Tool wird lokal ausgeführt und lädt keinen Code über das Internet hoch, wodurch die Codesicherheit gewährleistet wird. Es unterstützt eine breite Palette wichtiger Programmiersprachen, darunter Go, JavaScript/TypeScript, Python, Java, C/C++ und andere.fuck-u-codeBewertet Code in sieben Kerndimensionen, wie z.B. zyklomatische Komplexität, Funktionslänge und Codewiederholungen. Eines seiner bemerkenswerten Merkmale ist die Fähigkeit, farbenfrohe Endpunktberichte zu erstellen, die die Analyseergebnisse auf humorvolle Weise präsentieren und den Code-Review-Prozess weniger langweilig machen. Darüber hinaus unterstützt das Tool auch den Export des Analyseberichts in das Markdown-Format zur einfachen Integration in KI-Tools (z. B. ChatGPT) oder zum Schreiben in Teamdokumente.

Funktionsliste

• Unterstützung mehrerer SprachenUnterstützung für die Analyse von Go, JavaScript/TypeScript, Python, Java, C/C++, Rust und vielen anderen Programmiersprachen.
• Shit Mountain Index PunktzahlQualität: Bietet ein Qualitätsbewertungssystem auf einer Skala von 0 bis 100. Je höher die Punktzahl, desto schlechter ist die Codequalität.
• Sieben Dimensionen der ErkennungBewertung der Codequalität in sieben Bereichen: zyklomatische Komplexität, Funktionslänge, Kommentarabdeckung, Fehlerbehandlung, Benennungskonventionen, Codewiederholungen und Codestruktur.
• Farbterminal-BerichtAusgabe von Analyseberichten mit Farben und Emoticons im Terminal, wodurch die Darstellung der Ergebnisse anschaulicher und intuitiver wird.
• Markdown-BerichtsausgabeStrukturierte Berichte können im Markdown-Format erstellt werden, was es Entwicklern erleichtert, die Analyseergebnisse für die KI-Tool-Verarbeitung, die Dokumentenintegration oder die Erstellung von Berichten im CI/CD-Prozess zu nutzen.
• Flexible KonfigurationsmöglichkeitenBenutzer können das Analyseverhalten über Befehlszeilenoptionen anpassen, z. B. detaillierte Berichte anzeigen, die Anzahl der anzuzeigenden Problemdateien festlegen, bestimmte Dateien oder Verzeichnisse ausschließen usw.
• lokaler BetriebDas Tool läuft vollständig in der lokalen Umgebung, benötigt keine Internetverbindung und lädt keinen Benutzercode hoch, so dass der Datenschutz und die Sicherheit des Codes gewährleistet sind.

Hilfe verwenden

fuck-u-code ist ein Befehlszeilentool, dessen Hauptaufgabe darin besteht, den Projektcode unter einem bestimmten Pfad zu analysieren und einen detaillierten Qualitätsbewertungsbericht zu erstellen.

Einbauverfahren

Sie können eine der folgenden drei Möglichkeiten zur Installation wählen.

1. direkte Installation aus dem Quellcode (empfohlen)
Wenn Ihr Computer bereits mit der Go-Sprachumgebung konfiguriert ist, ist dies der einfachste Weg, dies zu tun.

go install github.com/Done-0/fuck-u-code/cmd/fuck-u-code@latest

Nachdem Sie diesen Befehl ausgeführt haben, stellen Sie sicher, dass Go'sbinVerzeichnis wurde dem System hinzugefügt.PATHin den Umgebungsvariablen. Wenn die Laufzeit auffordertcommand not foundSie können den folgenden Befehl ausführen, um diebinwird dem VerzeichnisPATHein (z. B. Linux/Mac):

export PATH="$PATH:$(go env GOPATH)/bin"

Um diese Einstellung dauerhaft zu machen, empfiehlt es sich, die obige Zeile in die Konfigurationsdatei Ihres Terminals einzufügen, zum Beispiel.bash_profilevielleicht.zshrc.

2. aus dem Quellcode bauen
Wenn Sie ihn selbst kompilieren wollen, können Sie den Code zunächst lokal klonen.

# 克隆仓库
git clone https://github.com/Done-0/fuck-u-code.git
# 进入项目目录
cd fuck-u-code
# 编译生成可执行文件
go build -o fuck-u-code ./cmd/fuck-u-code

Wenn die Kompilierung abgeschlossen ist, wird eine Datei im aktuellen Verzeichnis mit dem Namenfuck-u-codeder ausführbaren Datei.

3. mit Docker bauen
Wenn Sie mit Docker vertraut sind, können Sie auch ein Image erstellen, das dieses Tool über Dockerfile enthält.

docker build -t fuck-u-code .

Verwendung

grundlegende Analyse
fuck-u-codeDer Kernbefehl desanalyze. Sie können einen Projektpfad angeben und das Tool wird mit der Analyse beginnen.

# 分析指定路径的项目
fuck-u-code analyze /path/to/your/project

Sie können den Pfad auch weglassen, wenn Sie sich in einem Projektordner befinden, dann analysiert das Tool standardmäßig das aktuelle Verzeichnis.

# 分析当前目录
fuck-u-code analyze

Wenn Sie mit einem Docker-Image arbeiten, müssen Sie Ihr lokales Projektverzeichnis in den Container einbinden.

# 使用Docker运行分析
docker run --rm -v "/path/to/your/project:/build" fuck-u-code analyze

Kommandozeilen-Optionen
Sie können das Verhalten der Analyse und der Ausgabe steuern, indem Sie verschiedene Optionen hinzufügen.

Anwendungsbeispiel
Hier sind einige gängige Anwendungsszenarien.

1. Durchführung einer detaillierten Analyse

   fuck-u-code analyze --verbose
   

2. Konzentrieren Sie sich nur auf die schlimmsten 3 Dateien

   fuck-u-code analyze --top 3
   

3. Erzeugen eines Markdown-Berichts in Englisch und Speichern in einer Datei
   Diese Funktion ist ideal für die Zusammenarbeit im Team und die Dokumentation.

   fuck-u-code analyze --markdown --lang en-US > report.md
   

4. Schnelle Überprüfung der Codequalität in der kontinuierlichen Integration (CI)
   Ein Blick auf die Zusammenfassung reicht aus, um festzustellen, ob die Qualität des Codes den Anforderungen entspricht.

   fuck-u-code analyze --summary
   

5. Testdateien und abhängige Bibliotheken von der Analyse ausschließen

   fuck-u-code analyze --exclude "**/test/**" --exclude "**/vendor/**"
   

Erweiterte Nutzung: kombiniert mit AI-Tools

--markdownDie Optionen sindfuck-u-codeEine sehr nützliche Funktion. Der erzeugte Markdown-Bericht ist klar strukturiert und enthält eine Gesamtbewertung, Tabellen für jeden Indikator, eine Liste problematischer Dokumente und Verbesserungsvorschläge.

Sie können den Inhalt dieses Berichts direkt in ein KI-Tool (z.B. ChatGPT, Claude, etc.) kopieren und ihm z.B. Fragen stellen:

• "Bitte helfen Sie mir bei der Analyse dieses Codequalitätsberichts."
• "Geben Sie konkrete Vorschläge zur Überarbeitung des Codes für die im Bericht genannten Probleme."
• "Fassen Sie bitte auf der Grundlage dieses Berichts die drei wichtigsten Codequalitätsprobleme zusammen, die für mein Team Priorität haben müssen."

Dies kann Ihnen dabei helfen, Fehler in Ihrem Code schneller zu erkennen und sie zu beheben.

Anwendungsszenario

1. Einzelprojekt Selbststudium
   Nach der Fertigstellung eines Funktionsmoduls oder eines persönlichen Projekts können Entwickler mit diesem Tool einen umfassenden "Checkup" ihres Codes durchführen. Ein Blick auf den "Shit Mountain Index" und die Liste der spezifischen Probleme hilft den Entwicklern, ihren Code zu überarbeiten und zu optimieren, bevor er beschädigt wird, und gute Programmiergewohnheiten zu entwickeln.
2. Team Code Review (Codeüberprüfung)
   Die Codeüberprüfung ist ein wichtiger Bestandteil der Teamarbeit.fuck-u-codeEs kann als Automatisierungstool vor der Überprüfung verwendet werden. Teammitglieder nutzen es zur Selbstüberprüfung, bevor sie den Code einreichen, oder fügen den Markdown-Bericht an eine Zusammenführungsanfrage (Pull Request) an. Dies verbessert nicht nur die Effizienz der Überprüfung, sondern macht auch die Diskussion über die Codequalität objektiver und datengesteuert, wodurch subjektive Streitigkeiten vermieden werden.
3. Bewertung der Instandhaltungskosten für alte Projekte (Shit Hill)
   Wenn es an der Zeit ist, ein altes, unbekanntes Projekt zu übernehmen, können Sie diefuck-u-codeSie können schnell ein Mapping der Codequalität durchführen. Der erstellte Bericht gibt einen Überblick über den Grad der technischen Verschuldung des Projekts und ermöglicht eine genauere Einschätzung des Zeit- und Arbeitsaufwands für die anschließende Wartung und Überarbeitung.
4. Integration in den CI/CD-Prozess
   Es ist möglich, Folgendes zu kombinierenfuck-u-codeIntegration in die kontinuierliche Integrationspipeline (CI). So wird beispielsweise vor dem Zusammenführen von Code in den Master-Zweig automatisch eine Analyse der Codequalität durchgeführt. Fällt der Wert unter einen festgelegten Schwellenwert, wird die Zusammenführung blockiert. Auf diese Weise wird eine automatisierte Verteidigungslinie für die Qualität geschaffen, die sicherstellt, dass das Team ein hohes Maß an Codequalität beibehält.

QA

1. Wird dieses Tool meinen Code hochladen? Ist es sicher?
   Dieses Tool ist absolut sicher. Es läuft auf Ihrem lokalen Computer und der gesamte Analyseprozess erfordert keine Internetverbindung, geschweige denn den Zugriff auf oder das Hochladen Ihres Codes in irgendeiner Form.
2. Wie wird die Punktzahl des "Shit Mountain Index" berechnet? Ist eine höhere Punktzahl besser?
   Im Gegenteil, je höher die Punktzahl, desto schlechter ist die Codequalität und desto wahrscheinlicher ist es, dass es sich um einen "Berg von Scheiße" handelt. Die Punktzahl wird auf der Grundlage von sieben Dimensionen (z. B. Funktionslänge, Codewiederholungen, Kommentarrate usw.) berechnet, wobei eine Punktzahl von 0 für eine sehr hohe Codequalität und eine Punktzahl von 100 für eine sehr schlechte Codequalität steht.
3. Warum erhalte ich nach der Installation unter Linux oder Mac eine Aufforderung?command not found?
   Das liegt normalerweise daran, dass die Go-SprachumgebungbinVerzeichnis wurde nicht zum SystemverzeichnisPATHin der Umgebungsvariablen. Sie müssen sie manuell hinzufügen. Sie können dieexport PATH="$PATH:$(go env GOPATH)/bin"und fügen Sie diese Zeile in die Konfigurationsdatei Ihres Terminals ein (z. B..zshrcvielleicht.bash_profile), um sie dauerhaft zu machen.
4. Welche Programmiersprachen unterstützt das Tool?
   Es unterstützt derzeit eine breite Palette von Mainstream-Sprachen, darunter Go, JavaScript/TypeScript, Python, Java, C/C++ und Rust.
5. Bei der Analyse von Front-End-Projekten ist dienode_modulesZählen Sie die darin enthaltenen Dateien?
   Das wird es nicht. Das Tool schließt bereits standardmäßig einige gängige Front-End-Projektabhängigkeiten und Build-Produktverzeichnisse aus, wie z. B. dasnode_modulesunddistundbuildsowie einige komprimierte JS-Dateien (z. B..min.js), um die Genauigkeit der Analyseergebnisse zu gewährleisten.