goreporter

Goreporter

Ein Golang -Tool, das statische Analyse, Unit -Tests, Code -Überprüfung und generierende Codequalitätsbericht durchführt. Dies ist ein Tool, das gleichzeitig eine ganze Reihe dieser Linter ausführt und ihre Ausgabe in einem Bericht normalisiert:

• Unterstützte Linter
• Unterstützte Vorlage
• TODO -Liste
• Installation
  • Anforderungen
• Führen Sie es aus
• QuickStart
• Beispiel
• Report-Beispiel
• Credits

Unterstützte Linter

• GOFMT - Überprüft, ob der Code ordnungsgemäß formatiert ist und nicht weiter vereinfacht werden kann.
• Govet - Berichte Variablen, die möglicherweise ungewollt beschattet wurden.
• GOLINT - Golint ist ein Schnursinter für Go -Quellcode.
• Unittest - Golang Unit -Teststatus.
• Deadcode - Findet nicht verwendeten Code.
• Gocyclo - berechnet die zyklomatische Komplexität von Funktionen.
• VARCHECK - Finden Sie ungenutzte globale Variablen und Konstanten.
• StructCheck - Finden Sie unbenutzte Strukturmfelder.
• Aligncheck - Warnen Sie vor nicht optimal ausgerichteten Strukturen.
• Errcheck - Überprüfen Sie, ob Fehlerrückgabewerte verwendet werden.
• CopyCode (Dupl) - Berichtet potenziell duplizierten Code.
• Gosimple - Vereinfachungen im Code melden.
• staticCheck - Erkennen Sie die offensichtlichen und subtilen Fehler.
• GOTEPGRAPH - GODEPGRAPH ist ein Programm zur Erzeugung eines Abhängigkeitsgraphen von Go -Paketen.
• Misspell - Richtige häufig falsch geschriebene englische Wörter ... schnell.
• CountCode - Zählen Sie Zeilen und Projektdateien.
• Interfacer - Schlagen Sie schmalere Schnittstellen vor, die verwendet werden können.
• Tiefe - Zählen Sie die maximalen Funktionen von Go -Funktionen.
• FLEN - FLEN liefert Statistiken zu Funktionen/Methodenlängen in einem Golang -Paket.

Vorlage

• HTML -Vorlagendatei, die über -t <file> geladen werden kann.

TODO -Liste

• Diese Version wird die Vorlage neu gestalten.
• Fügen Sie Interfacer und Safesql und GOFMT (-S) hinzu, Gebensabsinter.

Installation

Anforderungen

• Gehen Sie 1.6+
• Graphviz

QuickStart

Goreporter installieren (siehe oben).

go get -u github.com/360EntSecGroup-Skylar/goreporter

Führen Sie es aus:

NOTIZ

Sie müssen bestätigen, dass Ihr Projekt in Betrieb ist. Insbesondere das Problem mit dem Anbieter, wenn das Paket nicht im Standardpfad zu finden ist, wird Goreporter erneut vom möglichen Anbieterpfad schauen.

goreporter -p [projectRelativePath] -r [reportPath] -e [exceptPackagesName] -f [json/html/text]  {-t templatePathIfHtml}

• -version Version von Goreporter.
• -P muss ein gültiger Golang -Projektpfad sein.
• -R Speichern Sie den Pfad zum Bericht.
• -e außergewöhnliche Pakete (mehrere durch Kommas getrennt, zum Beispiel: "Linter/Aligncheck, Linters/Cyclo").
• -f Berichtsformat JSON, HTML oder Text.
• -T Vorlagenpfad, falls angegeben, wird die Standardvorlage verwendet.

Standardmäßig wird die Standardvorlage verwendet, um Berichte im HTML -Format zu generieren.

Beispiel

Sie können das Ergebnisdetail sehen: Online-Exampe-Report

Credits

Das Logo wurde von Ri Xu entworfen