creedengo rules specifications下載 - creedengo rules specifications源代碼下載

creedengo rules specifications

其他類別

Release 1.4.4

下載

Creedengo是一個集體項目，旨在在代碼級別減少軟件的環境足跡。該項目的目的是提供靜態代碼分析儀的列表，以突出可能產生負面影響的代碼結構：能源和資源過度消費，“脂肪軟件”，縮短終端的壽命，等等。

Creedengo基於各種技術的不斷發展的良好實踐目錄。然後，Sonarqube插件將這些目錄作為掃描項目的規則。

警告：這仍然是一個非常早期的項目。任何反饋或貢獻都將不勝感激。請參閱貢獻部分。

？ Sonarqube插件

現在，Creedengo支持7個技術：

“標準”插件：
- Java插件
- JavaScript插件
- PHP插件
- Python插件
- C＃插件
移動插件：
- Android插件
- iOS插件

螢幕截圖

生態設計的聲納基插件

Ekko徽標

有兩種插件：

一個用於Web / Backoffice（PHP，Python，Java，JavaScript），使用2015年9月出版的第二版中描述的氣味。您可以在此處找到所有規則（法語）。當前的存儲庫是用於Web / backoffice
一個用於移動（Android），使用OlivierLeGoaër為Android的一組氣味。您可以在此處的存儲庫中找到此插件

Sonarqube插件的工作方式

代碼被解析為轉換為AST。 AST將允許您訪問代碼的一個或多個節點。例如，您將能夠訪問所有for ，探索內容等。

為了更好地了解AST結構，您可以使用AST Explorer。

Creedengo規則規範存儲庫

該項目包含所有語言的所有Creedengo規則的規格。

結構

規則是根據文件夾中的ID通過文件夾組織的。這些文件夾中的每一個都包含一個帶有規則元數據的文件，並通過語言描述。

元數據文件使用Sonarsource Analyzers Commons庫支持的格式。要找出可以將哪些值放在那裡，我們建議您使用官方的Sonarqube文檔，並依靠已經存在的文件。

這是一個示例：

 src/main/rules
├── EC104
│   ├── java
│   │   ├── EC104.asciidoc
│   │   ├── EC104.json
│   ├── php
│   │   ├── EC104.asciidoc
│   ├── python
│   │   ├── EC104.asciidoc
│   └── EC104.json
├── ...

要為給定語言指定元數據（例如，僅對單個語言刪除規則），可以在語言文件夾中創建JSON文件，並且在構建過程中將與公共文件合併。特定文件中的鍵具有優先級，並且可以添加新的鍵，但不要將其從全局刪除。

描述語言

規則的描述使用ASCIIDOC格式（具有Markdown兼容性），以允許包含其他頁面（此功能在標準中不可用Markdown提供）。

看：

Asciidoc語法快速參考
比較Asciidoc和Markdown

入門

您可以快速使用Docker的Creedengo插件。 PLASE查看每個插件的“入門”部分：

Java插件
PHP插件
Python插件
C＃插件

？分配

獲取Creedengo插件的主要方法是從您的Sonarqube Marketplace下載它們（可在管理部分中找到）。但是，如果願意，也可以從GitHub版本下載它們。

我們將插件存儲庫creedengo分配給2023年12月的每個插件的一個存儲庫。因此，根據您想要的版本，可以在2個存儲庫上使用插件版本：

Java插件：
- 從0.x到1.4.3：Creedengo存儲庫
- 自1.5.0以來：Creedengo-Java存儲庫
PHP插件：
- 從0.x到1.3.1：Creedengo存儲庫
- 自1.4.0以來：Creedengo-PHP存儲庫
Python插件：
- 從0.x到1.3.1：Creedengo存儲庫
- 自1.4.0以來：Creedengo-Python存儲庫
JavaScript插件：
- 從0.x到1.3.0：Creedengo存儲庫
- 自1.4.0以來：Creedengo-JavaScript存儲庫
C＃插件：
- 自0.x以來：Creedengo存儲庫
Android插件：Creedengo-Android存儲庫
iOS插件：Creedengo-ios存儲庫

？插件版本兼容性

插件版本	Sonarqube版本
1.4。 +	Sonarqube 9.4。 + lts至10.1
1.3。 +	Sonarqube 9.4。 + lts至10.0
1.2。 +	Sonarqube 9.4。 + lts至10.0
1.1。 +	Sonarqube 9.4。 + LTS至9.9
1.0。 +	Sonarqube 9.4。 + LTS至9.9
0.2。 +	Sonarqube 9.4。 + LTS至9.9
0.1。 +	Sonarqube 8.9。 + LTS至9.3