Einführung von covpeek - Sprachübergreifender Coverage-Report CLI-Parser
Haben Sie jemals Schwierigkeiten gehabt, Coverage-Reports über verschiedene Programmiersprachen hinweg zu parsen? Sind Sie es leid, benutzerdefinierte Skripte zu schreiben, um Coverage-Badges zu generieren oder Coverage-Daten zu extrahieren? Es gibt einen besseren Weg: covpeek.
covpeek ist ein sprachübergreifender Coverage-Report CLI-Parser, der in Go geschrieben ist und die Arbeit mit Coverage-Daten zum Kinderspiel macht. Mit covpeek können Sie Coverage-Reports von Rust, Go, TypeScript, JavaScript und Python mit einem einheitlichen Tool parsen. Es ist ein Werkzeug, um sie alle zu beherrschen!
Das Problem
Als ich an einem Rust-Projekt zu arbeiten begann, stieß ich auf ein frustrierendes Problem: Ich musste die Testabdeckung verstehen, aber das manuelle Parsen von LCOV-Dateien war mühsam. Dann musste ich Coverage-Badges für die README generieren, Coverage zwischen Commits vergleichen und Reports zu SonarQube hochladen. Jede Aufgabe erforderte das Schreiben von benutzerdefinierten Skripten oder die Verwendung verschiedener Tools.
Ich dachte: Es muss einen besseren Weg geben. Warum sollten wir das Rad für jedes Projekt und jede Sprache neu erfinden? Da wurde die Idee für covpeek geboren.
Die Lösung
covpeek ist eine einzelne Binärdatei, die all diese Probleme löst:
- Jedes Coverage-Format parsen: LCOV (Rust, TypeScript/JavaScript), Go-Coverage-Dateien, Python (Cobertura XML und JSON)
- Automatische Erkennung: Keine Notwendigkeit, das Format manuell anzugeben - covpeek findet es heraus
- Mehrere Ausgaben: Tabellenansicht, JSON für Automatisierung, CSV für Tabellenkalkulationen
- Interaktive TUI: Erkunden Sie Coverage-Daten mit einer schönen Terminal-Oberfläche
- Badges generieren: Erstellen Sie SVG-Badges für Ihre README
- CI/CD-Integration: Schwellenwerte prüfen, Commits vergleichen, zu SonarQube/Codecov hochladen
Warum Open Source?
Im Gegensatz zu Autoupdate habe ich mich entschieden, covpeek als freie und quelloffene Software unter der AGPL-3.0-Lizenz zu veröffentlichen. Warum?
- Community-getriebene Entwicklung: Coverage-Parsing profitiert von vielfältigen Anwendungsfällen und Beiträgen
- Transparenz: Testing-Tools sollten transparent und vertrauenswürdig sein
- Zurückgeben: Ich habe immens von Open-Source-Tools profitiert und möchte etwas zurückgeben
Unterstützte Formate
covpeek unterstützt derzeit:
- LCOV-Format: Verwendet von Rust (grcov, tarpaulin) und TypeScript/JavaScript (nyc/Istanbul)
- Go-Coverage-Format: Native Go-Coverage-Dateien, generiert von
go test -coverprofile - Python-Coverage-Formate: Sowohl Cobertura XML als auch JSON-Formate
Jedes Format wird automatisch anhand der Dateierweiterung oder des Inhalts erkannt, was covpeek unglaublich einfach zu bedienen macht.
Wie man es benutzt
Der Einstieg ist einfach:
# Mit Go installieren
go install github.com/Chapati-Systems/covpeek/cmd/covpeek@latest
# Oder vorgefertigte Binärdateien von GitHub Releases herunterladen
Eine Coverage-Datei parsen:
covpeek --file coverage.lcov
Ein Badge generieren:
covpeek badge --file coverage.lcov --output coverage-badge.svg
Die interaktive TUI starten:
covpeek --file coverage.lcov --tui
Zu SonarQube oder Codecov hochladen:
covpeek upload --to sonarqube --project-key myproject --token $SONAR_TOKEN
covpeek upload --to codecov --repo-token $CODECOV_TOKEN
Die Zukunft
Dies ist erst der Anfang. Ich habe Pläne, Unterstützung für weitere Sprachen und Formate, zusätzliche Plattformintegrationen und weitere Funktionen basierend auf Community-Feedback hinzuzufügen.
Mitmachen
covpeek ist komplett kostenlos und Open Source! Schauen Sie sich das GitHub-Repository an, um:
- Die neueste Version herunterzuladen
- Fehler zu melden oder Funktionen anzufordern
- Code oder Dokumentation beizutragen
- Das Projekt mit einem Stern zu versehen, wenn Sie es nützlich finden
Fragen?
Bitte teilen Sie Feedback wie Feature-Anfragen oder Fehlerberichte auf GitHub Issues. Beiträge sind willkommen!
Zusammenfassend lässt sich sagen: Wenn Sie mit Coverage-Reports über mehrere Sprachen hinweg arbeiten, ist covpeek das Tool, nach dem Sie gesucht haben. Mit automatischer Formaterkennung, mehreren Ausgabeformaten und leistungsstarken Funktionen wie Badge-Generierung und Plattformintegration macht covpeek die Arbeit mit Coverage-Daten einfach und effizient. Warum also warten? Probieren Sie covpeek noch heute aus und vereinfachen Sie Ihren Coverage-Workflow!