Alle Beiträge

SonarCloud am 50k-Limit: Warum ich meine Codeprüfung vor den Commit verlegt habe

7 Min. Lesezeit

Aufgeräumter Holzschreibtisch mit Laptop, Tastatur, einer Wasserwaage, einem Notizblock mit Balkendiagramm und einer Kaffeetasse im Morgenlicht

Anfang September stand in meinem Projekt-Dashboard eine Zahl, die mir mehr Sorgen machte als jeder Fehlerbericht: 48.802. So viele Codezeilen zählte SonarCloud in meiner Website zu diesem Zeitpunkt. Die kostenlose Stufe des Dienstes endet bei 50.000. Bei rund 355 neuen Zeilen pro Tag war absehbar, wann die Analyse wieder das tun würde, was sie im Sommer schon einmal sechs Wochen lang getan hatte: rote Läufe ohne jede Aussage.

Ich hätte auf den kostenpflichtigen Plan wechseln können. Stattdessen habe ich mir eine andere Frage gestellt: Was von dem, was SonarCloud für mich prüft, brauche ich im Alltag wirklich? Die Antwort war überraschend kurz. Daraus ist ein kleines Werkzeug entstanden, das ich jetzt als Open Source veröffentlicht habe: code-thresholds.

Warum Codequalität überhaupt gemessen wird

Für alle, die nicht selbst programmieren, kurz zur Einordnung. Software wird selten auf einmal schlecht. Sie wird es in kleinen Schritten: Eine Funktion bekommt noch einen Sonderfall, eine Klasse noch eine Methode, ein Aufruf noch einen Parameter. Jeder einzelne Schritt ist harmlos. In der Summe entsteht Code, den niemand mehr gern anfasst, und genau das macht spätere Änderungen teuer. Über diese schleichenden Kosten habe ich im Beitrag zu technischen Schulden ausführlicher geschrieben.

Werkzeuge wie SonarCloud setzen deshalb Grenzen: höchstens so viele Methoden pro Klasse, höchstens so viele Parameter pro Funktion, höchstens so tief verschachtelte Bedingungen. Wer eine Grenze überschreitet, bekommt eine Meldung. Das ist kein Selbstzweck, sondern eine Art Frühwarnsystem.

Was ich davon wirklich genutzt habe

SonarCloud kann viel: Sicherheitshinweise, eine Historie über Monate, Duplikaterkennung, eine Kennzahl namens Cognitive Complexity und Dutzende weiterer Regeln. Als ich durchgesehen habe, welche Meldungen in meinem Projekt tatsächlich zu Änderungen geführt hatten, blieben zwei Gruppen übrig:

  • Größen- und Komplexitätsgrenzen, also Methoden pro Klasse, Parameter, Rückgabestellen, Funktionslänge und Verschachtelungstiefe, dazu zwei echte Fehlerquellen: unbenutzte Variablen und Schleifenzähler, die im Schleifenkörper überschrieben werden.
  • Kopierte Codeblöcke, die an mehreren Stellen gepflegt werden müssen.

Dazu kam eine Beobachtung, die mich mehr gestört hat als das Zeilenlimit: Die Meldungen kamen zu spät. SonarCloud analysiert nach dem Hochladen des Codes. Die Korrektur wurde damit jedes Mal zu einer zusätzlichen Runde, obwohl sich fast alle dieser Grenzen schon beim Schreiben aus einer einzelnen Datei ablesen lassen.

Die Entscheidung: lokal prüfen, nur was sich geändert hat

Daraus ergab sich die Lösung fast von selbst. Die beiden Gruppen bekommen jeweils ein eigenes, spezialisiertes Werkzeug:

  • Für kopierte Codeblöcke nutze ich jscpd, ein etabliertes Open-Source-Tool. Es läuft in der Pipeline jedes Pull Requests und erlaubt höchstens ein Prozent Duplikate im ganzen Projekt sowie keinen einzigen neuen Klon gegenüber dem Hauptzweig. Beim Umstieg lag der Wert bei 0,62 Prozent.
  • Für die Größen- und Komplexitätsgrenzen habe ich code-thresholds geschrieben.

Der entscheidende Unterschied zu einer gehosteten Analyse: code-thresholds prüft nur die Dateien, die sich gerade geändert haben. Im Pre-Commit-Hook sind das die Dateien, die ich committen will, im Pull Request die Dateien, die sich gegenüber dem Zielzweig unterscheiden. Damit ist das Werkzeug schnell genug für jeden einzelnen Commit, und Altlasten an anderer Stelle blockieren keine neue Arbeit. In meinem Projekt gibt es sechs ältere Verstöße, die ich bewusst einzeln abbaue. Würde das Werkzeug immer das ganze Projekt prüfen, wäre jeder Lauf rot und damit wertlos.

Der Umstieg hat noch einen Nebeneffekt, der für Einzelentwickler und kleine Teams interessant ist: Die Kosten wachsen nicht mehr mit dem Projekt. Preise pro Codezeile bestrafen genau das, was man eigentlich will, nämlich ein gepflegtes, wachsendes Produkt.

Was das Werkzeug bewusst nicht prüft

Der interessanteste Teil der Arbeit war nicht das, was code-thresholds kann, sondern das, was ich weggelassen habe. Mein Grundsatz dabei: Ein Check, der falsch meldet, ist schlechter als gar kein Check. Er blockiert Commits, er kostet Zeit, und spätestens beim dritten Fehlalarm wird er abgeschaltet. Dann ist auch das weg, was er richtig gemacht hätte.

Drei Prüfungen fehlen deshalb absichtlich:

Cognitive Complexity. Diese Kennzahl soll messen, wie schwer ein Stück Code für Menschen zu verstehen ist. Ich habe eine eigene Berechnung gebaut und mit den Werten verglichen, die SonarCloud für dieselben Dateien angezeigt hatte. Bei einer Methode lag mein Wert zu hoch, bei einer anderen zu niedrig. Zu hoch wäre ärgerlich gewesen. Zu niedrig ist gefährlich, weil es falsche Sicherheit gibt: Das Werkzeug meldet „alles in Ordnung", obwohl es das nicht ist. Diese Beurteilung bleibt deshalb beim Menschen im Code-Review.

Doppelte Texte im Code. Ein Zähler für mehrfach verwendete Zeichenketten klingt nützlich. In der Praxis markiert er vor allem gewöhnliche Schlüssel wie 'id' oder 'value', die in jedem Projekt hundertfach vorkommen und völlig in Ordnung sind. Rauschen statt Signal.

Copy-Paste-Erkennung. Kopierte Blöcke zuverlässig zu finden, braucht ein Werkzeug, das genau dafür gebaut ist. Eine schnelle Nachahmung übersieht entweder Duplikate oder schlägt Alarm, wo keine sind. Dafür gibt es jscpd.

Zählen statt raten: warum keine regulären Ausdrücke

Eine technische Entscheidung möchte ich herausgreifen, weil sie zeigt, wie leicht ein Prüfwerkzeug selbst zur Fehlerquelle wird.

Die erste Version zählte Zeichenketten mit regulären Ausdrücken, also mit Suchmustern über den Quelltext. Das ging so lange gut, bis das Werkzeug in einer harmlosen Zeile wie ['a' => 0, 'b' => 1] eine Zeichenkette meldete, die es gar nicht gibt: ' => 0, '. Das Suchmuster hatte das Stück zwischen zwei Schlüsseln für einen eigenen Text gehalten, weil es von einem Anführungszeichen bis zum nächsten las.

Seitdem misst code-thresholds ausschließlich auf Basis des PHP-eigenen Tokenizers. Das ist dieselbe Zerlegung in Bausteine, die PHP selbst beim Ausführen verwendet. Eine Zeichenkette ist dann eine Zeichenkette, ein Kommentar ein Kommentar, und ein Komma in einem Standardwert zählt nicht als Trenner zwischen Parametern. Auf genau diesen Fall gibt es inzwischen auch einen eigenen Test: Ein abschließendes Komma in einer mehrzeiligen Funktionssignatur hatte einmal aus sieben Parametern acht gemacht.

So binden Sie es ein

Für Entwicklerinnen und Entwickler, die es ausprobieren möchten: Das Paket hat keine Abhängigkeiten außer der PHP-Erweiterung tokenizer und läuft ab PHP 8.3.

composer require --dev stejac/code-thresholds
vendor/bin/code-thresholds

Ohne Argumente prüft es die für den nächsten Commit vorgemerkten Dateien. Damit passt es direkt in einen Pre-Commit-Hook, der im Kern aus einer einzigen Zeile besteht. Im Pull Request prüft es mit --base alle Dateien, die sich gegenüber dem Zielzweig geändert haben, in GitHub Actions etwa so:

vendor/bin/code-thresholds --base=origin/main

Die Grenzwerte stehen in einer kleinen PHP-Datei im Projekt. Jede Regel lässt sich anpassen oder abschalten, und Ausnahmen wie Datenbank-Entities oder Testklassen sind bereits vorbelegt. Konstruktoren sind vom Parameter-Limit ausgenommen, denn acht übergebene Abhängigkeiten sind ein anderes Thema als ein Funktionsaufruf mit acht Argumenten. Die Ausgabe ist bewusst schlicht: Datei, Zeile, Regel, Ist-Wert und Grenze.

Vorlagen für den Hook, die GitHub-Action und eine vollständig kommentierte Konfiguration liegen im Repository auf GitHub, das Paket selbst auf Packagist. Es steht unter der MIT-Lizenz und prüft sein eigenes Quellverzeichnis übrigens mit sich selbst.

Was das für Ihr Projekt bedeutet

Auch wenn Sie selbst nie eine Zeile Code schreiben, steckt in dieser Geschichte eine Frage, die Sie Ihrem Dienstleister oder Ihrem Team stellen können: Woran merken wir, dass unsere Software schlechter wird, bevor es teuer wird?

Eine gute Antwort muss kein großes Analyseprodukt sein. Sie sollte aber drei Dinge erfüllen: Die Prüfung läuft automatisch, sie meldet sich, bevor der Code im Hauptzweig landet, und sie meldet nur, was das Team auch wirklich durchsetzt. Eine Liste mit 400 Warnungen, die niemand liest, ist keine Qualitätssicherung.

Fazit

Das Zeilenlimit von SonarCloud war der Anlass, aber nicht der Grund für den Umstieg. Der eigentliche Gewinn liegt woanders: Die Prüfungen laufen jetzt dort, wo Fehler am günstigsten zu beheben sind, nämlich vor dem Commit. Und jede Meldung bedeutet etwas, weil ich alles weggelassen habe, was ich nicht zuverlässig messen kann.

Wenn Sie wissen möchten, wie es um die Wartbarkeit Ihrer eigenen Software steht oder wie sich solche Prüfungen in Ihre Abläufe einbauen lassen, sprechen Sie mich gern an. Das erste Gespräch kostet nichts.

Teilen: LinkedIn X