sonar gherkin plugin

Sonarqube黃瓜小黃瓜分析儀

免責聲明

我不想繼續維護此插件。如果您想接管我，請隨時使用我。

描述

此Sonarqube插件分析了黃瓜小黃瓜功能文件和：

• 計算指標：代碼行，方案數量等。
• 檢查各種指南，以通過40多次檢查發現潛在的錯誤和代碼氣味
• 提供了寫自己的支票的能力

用法

1. 下載並安裝Sonarqube
2. 通過直接下載安裝黃瓜小黃瓜插件。最新版本與Sonarqube 6.7+兼容。
3. 安裝您最喜歡的掃描儀（Sonarqube掃描儀，Maven，Ant等）
4. 分析您的代碼

小牛

您的功能文件可能不是位於源代碼目錄中，而是在測試目錄中。默認情況下，Sonarqube沒有分析這些測試目錄。因此，您必須明確告訴Sonarqube還分析包含您功能文件的測試目錄。

假設您項目的結構是：

 pom.xml
src
  |-- main
        |-- java
        |-- resources
  |-- test
        |-- java
        |-- resources
              |-- features
                    |-- my-feature.feature
                    |-- my-other-feature.feature
                                   
                

在您的POM文件中，您需要添加：

 <properties>
  <sonar.sources>pom.xml,src/main/java,src/main/resources,src/test/resources/features</sonar.sources>
</properties>  

自定義檢查

您正在考慮新的有價值的規則嗎？ 1.0版或更高版本提供了一個API來編寫您自己的自定義檢查。這裡提供了帶有詳細說明的示例插件。如果您的自定義規則可能使社區受益，請隨時創建一個拉動請求，以便使Cucumber Gherkin Analyzer中的規則可用。

您正在考慮可能使社區受益但沒有時間或寫作技巧的新規則？請隨時創建一個問題，以考慮您的規則。

指標

語句

步驟數。

功能

場景和方案概述的數量。

課程

功能數量。

可用規則

• 應該處理“ FixMe”標籤
• 應該處理“ todo”標籤
• 所有評論應始終格式化
• 並且應使用前綴，而不是冗餘給定/何時/然後使用前綴
• 字節訂單標記（BOM）不應用於UTF-8文件
• 常見的給定步驟應添加到背景中
• 重複的步驟應刪除
• 端線字符應保持一致
• 示例數據表應包含數據至少兩個數據行
• 功能應以相同的語言編寫
• 功能應具有描述
• 功能應該有名字
• 功能應該具有獨特的名稱
• 功能不應包含太多場景
• 不定義任何方案的功能應刪除
• 文件名應該符合命名約定
• 文件應在結尾包含一個空的新線路
• 不定義任何功能的文件應刪除
• 給定的步驟應遵循正則表達式
• 給定/何時/隨時應按正確的順序定義步驟
• 線不應以尾隨空間結束
• 缺少數據表列應添加
• 非傳遞步驟應移出背景
• 僅使用白名單的標籤
• 正則評論
• 方案應定義至少每個給定/時/何時/然後進行步驟類型
• 方案應該有名字
• 方案應該具有獨特的名稱
• 方案不應包含太多步驟
• 不定定義任何步驟的方案應刪除
• 源代碼應適當縮進
• 拼寫錯誤應解決
• 星（*）步驟前綴不應使用
• 階梯句子不應該太長
• 未知類型的步驟不應使用
• 製表字符不應使用
• 標籤應在正確的級別定義
• 標籤應遵守命名約定
• 標籤不應設置在示例上
• 然後步驟應遵循正則表達式
• 每個情況時應該有一個單一
• 未使用的變量應刪除
• 無用的標籤應刪除
• 何時應遵循正則表達式
• 措辭應保持業務層面