creedengo rules specifications
Release 1.4.4
Creedengo ist ein kollektives Projekt, das darauf abzielt, den ökologischen Fußabdruck der Software auf Codeebene zu verringern. Ziel des Projekts ist es, eine Liste statischer Codeanalysatoren bereitzustellen, um Codestrukturen hervorzuheben, die sich negative ökologische Auswirkungen haben können: Energie und Ressourcenüberkonsum, "Fettware", die Lebensdauer der Terminals von der Verknüpfung von Straftaten usw.
Creedengo basiert auf den sich entwickelnden Katalogen guter Praktiken für verschiedene Technologien. Ein Sonarqube -Plugin implementiert diese Kataloge dann als Regeln für das Scannen Ihrer Projekte.
Warnung : Dies ist immer noch ein sehr frühes Stadium -Projekt. Jegliches Feedback oder Beitrag wird sehr geschätzt. Weitere Informationen finden Sie im Abschnitt Beitrag.
7 Technologien werden derzeit von Creedengo unterstützt:
Es gibt zwei Arten von Plugins:
Der Code wird analysiert, um als AST transformiert zu werden. Mit AST können Sie auf einen oder mehrere Knoten Ihres Codes zugreifen. Beispielsweise können Sie auf alle Ihre for Schleife zugreifen, um Inhalte usw. zu erkunden.
Um die AST -Struktur besser zu verstehen, können Sie den AST -Explorer verwenden.
Dieses Projekt enthält die Spezifikationen aller Creedenengo -Regeln für alle Sprachen.
Regeln werden nach Ordner basierend auf ihrer ID im Ordner Root Rules organisiert. Jede dieser Ordner enthält eine Datei mit den Metadaten der Regel und Beschreibung nach Sprache.
Die Metadatendatei verwendet das von der SonarSource Analyzer Commons Library unterstützte Format. Um herauszufinden, welche Werte dort eingestellt werden können, empfehlen wir Ihnen, die offizielle Sonarqube -Dokumentation zu verwenden und sich auf bereits vorhandene Dateien zu verlassen.
Hier ist ein Beispiel:
src/main/rules
├── EC104
│ ├── java
│ │ ├── EC104.asciidoc
│ │ ├── EC104.json
│ ├── php
│ │ ├── EC104.asciidoc
│ ├── python
│ │ ├── EC104.asciidoc
│ └── EC104.json
├── ...
Um Metadaten für eine bestimmte Sprache anzugeben (z. B. eine Regel nur für eine einzelne Sprache), ist es möglich, eine JSON -Datei im Sprachordner zu erstellen, und dies wird während des Erbaus mit der gemeinsamen Datei zusammengeführt. Die Schlüssel in der bestimmten Datei haben Priorität und es ist möglich, neue hinzuzufügen, sie jedoch nicht vom globalen Löschen zu löschen.
Die Beschreibung der Regeln verwendet das ASCIIDOC -Format (mit Markdown -Kompatibilität), um die Aufnahme anderer Seiten zu ermöglichen (diese Funktion ist nicht in Standard mit Markdown verfügbar).
Sehen:
Mit Docker können Sie schnell Creedengo -Plugins ansehen. Plase schauen Sie sich den Abschnitt "Erste Schritte" jedes Plugins an:
Die Hauptmethode, um Creedengo -Plugins zu erhalten, besteht darin, sie von Ihrem Sonarqube -Marktplatz (verfügbar in der Verwaltung) herunterzuladen. Wenn Sie jedoch möchten, können Sie sie auch von Github -Veröffentlichungen herunterladen.
Wir hatten unser Plugins -Repository creedengo für jedes Plugin im Dezember 2023 auf ein Repository aufgeteilt. Daher sind Plugin -Versionen in 2 Repositories erhältlich, abhängig von der gewünschten Version:
| Plugins -Version | Sonarqube -Version |
|---|---|
| 1.4.+ | Sonarqube 9.4.+ LTS bis 10.1 |
| 1.3.+ | Sonarqube 9.4.+ LTS bis 10.0 |
| 1.2.+ | Sonarqube 9.4.+ LTS bis 10.0 |
| 1.1.+ | Sonarqube 9.4.+ LTS bis 9.9 |
| 1.0.+ | Sonarqube 9.4.+ LTS bis 9.9 |
| 0,2.+ | Sonarqube 9.4.+ LTS bis 9.9 |
| 0,1.+ | Sonarqube 8.9.+ LTS bis 9,3 |
| Plugins -Version | Java -Version |
|---|---|
| 1.4.+ | 11/17 |
| 1.3.+ | 11/17 |
| 1.2.+ | 11/17 |
| 1.1.+ | 11/17 |
| 1.0.+ | 11/17 |
| 0,2.+ | 11/17 |
| 0,1.+ | 11/17 |
Sie sind technischer Experte, Designer, Projektmanager, CSR -Experte, Ecodesign -Experte ...
Sie möchten die Hilfe Ihres Unternehmens anbieten und uns helfen, uns zu organisieren und über das Projekt zu kommunizieren?
Sie haben Ideen, die wir uns unterwerfen können?
Wir hören Ihnen zu, dass Sie das Projekt gemeinsam und vielleicht mit Ihnen vorantreiben!
Wir brauchen dich!
Hier das Starterpack
Irgendeine Frage? Wir sind für Sie da! Erstellen Sie zunächst bitte ein Problem. Dann, wenn keine Antwort, wenden Sie sich an ...
Hier ehren wir einige nicht länger aktive Kernteam-Mitglieder, die in der Vergangenheit wertvolle Beiträge geleistet haben.
Sie haben zum Erfolg von Creedengo beigetragen:
Sie unterstützten das Projekt:
