Qodana
The code quality platform for teams
Neu: Qodana, die Codequalitätsplattform für Ihr bevorzugtes CI-System
Es gehört zur Softwareentwicklung, dass manchmal auch nach dem Kompilieren oder Ausführen eines Projekts noch Probleme im Code gefunden werden. Bei kleineren Problemen – zum Beispiel Stilfehlern – ist die Korrektur nicht sehr dringend. Schwierig wird es jedoch, wenn kritische Fehler auftauchen, die Ihre Unternehmensservices beeinträchtigen oder Ihre Entwicklungsabläufe verzögern. Dies gilt insbesondere in Entwicklungsteams mit vielen aktiven Mitwirkenden. Sie müssen sich der Qualität Ihres gesamten Projekts sicher sein, bevor es zu spät ist.
Wir haben eine gute Nachricht für Sie: Ab sofort gibt es einen einfachen Weg, dies zu erreichen – mit Qodana, der Codequalitätsplattform, die Ihnen hilft, die Qualitätssicherung zu optimieren, die Integrität Ihrer Projekte zu überprüfen und die einfache Wartbarkeit Ihres Codes zu gewährleisten.
Qodana richtet Qualitätsschranken direkt in der CI/CD-Pipeline Ihrer Wahl ein, um sicherzustellen, dass in Ihren Projekten keine Codeprobleme unter dem Radar durchrutschen und Ihnen bei der späteren Entwicklung in die Quere kommen. Mit Qodana haben Sie jederzeit einen Überblick über alle Qualitätsaspekte Ihres Projekts, einschließlich der Qualitätsziele und des aktuellen Status.
Diese Aufgaben können Sie an Qodana delegieren
Qodana enthält Befehlszeilentools (Linter), mit denen Projektanalysen lokal oder in einem beliebigen CI durchgeführt werden können. Dadurch können Entwickler*innen ihre Projekte unkompliziert auf Codeprobleme überprüfen. Und nicht nur das: Ihr Team kann die Codequalität zu einem integralen Bestandteil des Entwicklungsprozesses machen. Sehen wir uns nun im Detail an, wie Qodana Sie und Ihr Team unterstützen kann:
- Codeprobleme frühzeitig beheben. Sie können Probleme lösen, bevor der Code in die Produktion geht. Probleme, die erst später entdeckt werden, sind wesentlich kostspieliger zu korrigieren.
- Auffällige Codeabschnitte erkennen. Codefragmente, die für Ihr Projekt untypisch geschrieben sind, können die Sicherheit des Projekts gefährden.
- Code-Reviews automatisieren. Durch die Automatisierung einer Vielzahl von Prüfungen – ungenutzte Importe, Duplikate, Rechtschreib- und Formatierungsprobleme usw. – können Sie die Zeit reduzieren, die Sie in der Feedbackschleife verbringen.
- Toten Code entfernen. Dadurch wird die Ausführung irrelevanter Operationen vermieden und die Laufzeit des Programms verkürzt.
- Compliance-Risiken reduzieren. Mit dem Lizenz-Audit von Qodana behalten Sie den Überblick über die Abhängigkeiten Ihres Projekts. Dies vereinfacht die Einhaltung von Lizenzregelungen.
- Codestruktur optimieren. Dadurch verbessern Sie die Lesbarkeit und Wartbarkeit Ihres Codes. Mit Qodana können Sie sicherstellen, dass Ihr Code in Bezug auf Einrückung, Namensgebung, Zeilenlängen usw. einheitlich gestaltet ist.
- Umsetzung von Best Practices in der Programmierung. Je nach Ihren Projekt- oder Geschäftsanforderungen können Sie sicherstellen, dass der Code Ihre unternehmensinternen Richtlinien genau einhält – zum Beispiel indem ein bestimmter Codestil-Leitfaden befolgt wird.
Hauptfunktionen
Echtzeit-Überblick über Ihr Projekt
Nach einer Analyse zeigt Qodana die Ergebnisse in einem Ringdiagramm an. Anklickbare Tabs ermöglichen eine unkomplizierte Aufschlüsselung von Details. Beim Anklicken eines Tabs werden die Ergebnisse unterhalb des Diagramms in Echtzeit aktualisiert. Im Rahmen Ihrer Detailanalyse können Sie die angezeigten Ergebnisse genau eingrenzen, indem Sie im Menü neben dem Ringdiagramm verschiedene Filter aktivieren. Sie haben sogar die Möglichkeit, die Tabs innerhalb des Diagramms nach Wunsch anzuordnen und bestimmte Filterkonfigurationen für die spätere Verwendung zu speichern.
Handlungsmöglichkeiten bei Codeproblemen
Der Problems-Tab unterhalb des Ringdiagramms listet alle erkannten Probleme auf, sortiert nach Schweregrad, Dateiname, Pfad, Kategorie und Typ. Wenn Sie sich ein bestimmtes Problem genauer ansehen möchten, können Sie es einfach anklicken. Dadurch wird das Codefragment erweitert und im Kontext angezeigt.
Hier haben Sie die Möglichkeit, das Problem in die Technical-Debt-Liste zu verschieben (Schaltfläche Move to Technical Debt) oder die Datei in Ihrer IDE zu öffnen.
Im Dropdown-Menü More actions stehen Ihnen verschiedene Aktionen zur Verfügung: Sie können einen bestimmten Pfad, eine Datei oder ein ganzes Verzeichnis von zukünftigen Analysen ausschließen, bestimmte Typen oder Kategorien ausblenden oder Fälle melden, bei denen Sie glauben, dass ein Codeabschnitt fälschlicherweise markiert wurde.
Wenn Sie vom Tab Problems zum Tab Files wechseln, können Sie sich dieselben Probleme in einer Datei-/Ordnerstruktur ansehen.
Integration mit IDEs von JetBrains
IntelliJ IDEA Ultimate und PhpStorm sind in Qodana integriert. Wenn Qodana auf ein Problem in Ihrem Code hinweist, können Sie die entsprechende Stelle direkt in Ihrer IDE öffnen und das Problem unkompliziert beheben. Wählen Sie dazu ein Problem aus und klicken Sie auf die Aktion Open file in. Um Qodana in andere JetBrains-IDEs zu integrieren, installieren Sie unser Plugin.
Lizenz-Audit
Strafen für rechtliche und Compliance-Verstöße durch ungültige oder unzulässig verwendete Lizenzen in Ihrem Code können extrem kostspielig sein. Mit Qodana können Sie Abhängigkeiten in Ihrem Code-Repository scannen, um die entsprechenden Lizenzen zu finden und auf mögliche Probleme zu überprüfen.
Wir machen es Ihnen leicht, Lizenzprüfungen in Ihr Projekt zu integrieren und zu einem Bestandteil Ihrer CI/CD-Pipeline zu machen. Die neue Funktionalität License audit ist für alle Linter verfügbar, einschließlich Java, Kotlin, PHP, Python und JavaScript.
Weitere Informationen zu den Funktionen von Qodana finden Sie auf unserer Website.
Integration in GitHub und andere CI/CD-Tools
Sie können die Plattform in GitHub integrieren, um Codeprobleme dort zu erkennen, zu analysieren und zu beheben. Installieren Sie die GitHub-Aktion Qodana Scan, um für Projekte, die Java, Kotlin, PHP, Python, JavaScript oder TypeScript verwenden, QA-Prüfungen in Ihren GitHub-Workflow zu integrieren. Eine kurze Übersicht über verschiedene grundlegende Anwendungsfälle finden Sie in unserer Dokumentation.
Natürlich können Sie auch andere Plattformen als GitHub verwenden! Qodana lässt sich in jede CI-Plattform integrieren. Wie in unserem Blog beschrieben ist der Ablauf zur Festlegung von Qualitätsmeilensteinen für ein Projekt bei allen CI-Tools sehr ähnlich. Seit der Veröffentlichung von Qodana haben wir Unterstützung für GitHub, GitLab CI/CD, TeamCity, Jenkins und Azure Pipelines hinzugefügt.
Sehen Sie sich Qodana in Aktion an
In diesem 7-minütigen Video erfahren Sie mehr darüber, was Qodana zu bieten hat und wie es Ihren Entwicklungsprozess unterstützen kann.
Und wenn Sie eine praktische Herangehensweise bevorzugen, stellen wir Ihnen eine Sandbox zum Experimentieren bereit. Melden Sie sich als Gast an und wählen Sie eines der vorkonfigurierten Projekte aus. Eine visuelle Demonstration finden Sie bei der 2:56-Minuten-Marke im oben verlinkten Video.
Für weitere Informationen zu Qodana und den Vorteilen, die es für Ihre CI-Pipelines bietet:
- Besuchen Sie unsere Website
- Erkunden Sie unsere Dokumentation
- Lesen Sie unser Blog
Wenn Sie Fragen oder Anregungen zu Qodana haben, hinterlassen Sie uns hier einen Kommentar, erwähnen Sie uns auf Twitter oder schreiben Sie uns unter qodana-support@jetbrains.com.
Ihr Qodana-Team
Autor des Original-Blogposts: