sonar gherkin plugin

Sonarqube Cucumber Gherkin Analyzer

免責事項

このプラグインを維持し続けたくありません。あなたが引き継ぎたいならば、お気軽に私を悩ませてください。

説明

このSonarqubeプラグインは、Cucumber Gherkin機能ファイルを分析します。

• 計算メトリック：コードの行、シナリオ数など。
• さまざまなガイドラインをチェックして、潜在的なバグとコードの臭いを見つけることができます。
• 独自のチェックを書く機能を提供します

使用法

1. Sonarqubeをダウンロードしてインストールします
2. 直接ダウンロードして、キュウリガーキンプラグインをインストールします。最新バージョンは、Sonarqube 6.7+と互換性があります。
3. お気に入りのスキャナー（Sonarqube Scanner、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を提供します。詳細な説明を含むサンプルプラグインはこちらから入手できます。カスタムルールがコミュニティに利益をもたらす可能性がある場合は、キュウリガーキンアナライザーでルールを利用できるようにするために、自由にプルリクエストを作成してください。

コミュニティに利益をもたらすかもしれないが、それらを書く時間やスキルがない新しいルールを考えていますか？あなたのルールを考慮して取得するための問題を自由に作成してください。

メトリック

ステートメント

ステップ数。

関数

シナリオの数とシナリオの概要。

クラス

機能の数。

利用可能なルール

• 「FIXME」タグを処理する必要があります
• 「TODO」タグは処理する必要があります
• すべてのコメントは一貫してフォーマットする必要があります
• そして、しかし、しかし、冗長な与えられた/いつ/その後プレフィックスの代わりにプレフィックスを使用する必要があります
• バイトオーダーマーク（BOM）は、UTF-8ファイルに使用しないでください
• 一般的な指定された手順を背景に追加する必要があります
• 重複した手順を削除する必要があります
• エンドライン文字は一貫している必要があります
• 例データテーブルには、少なくとも2つのデータ行を含める必要があります
• 機能は同じ言語で記述する必要があります
• 機能には説明が必要です
• 機能には名前が必要です
• 機能には一意の名前が必要です
• 機能にはあまり多くのシナリオが含まれてはなりません
• シナリオを定義しない機能は削除する必要があります
• ファイル名は命名規則に準拠する必要があります
• ファイルは最後に空の新しい行を含める必要があります
• 機能を定義しないファイルは削除する必要があります
• 指定された手順は、正規表現に従う必要があります
• 与えられた/いつ/その後、手順を正しい順序で定義する必要があります
• ラインは、後続の空白で終わるべきではありません
• 欠落しているデータテーブル列を追加する必要があります
• 非誘惑の手順を背景から移動する必要があります
• ホワイトリストからのタグのみを使用する必要があります
• コメントの正規表現
• シナリオは、指定された各/いつ/その後ステップタイプの少なくとも1つを定義する必要があります
• シナリオには名前が必要です
• シナリオには一意の名前が必要です
• シナリオにはあまりにも多くの手順を含めるべきではありません
• ステップを定義しないシナリオは削除する必要があります
• ソースコードは適切にインデントする必要があります
• スペルミスを修正する必要があります
• 星（*）ステッププレフィックスは使用しないでください
• ステップ文は長すぎてはいけません
• 未知のタイプの手順は使用しないでください
• 集計文字を使用しないでください
• タグは適切なレベルで定義する必要があります
• タグは命名規則に準拠する必要があります
• タグを例に設定しないでください
• 次に、ステップは正規表現に従う必要があります
• シナリオごとにステップの場合、1つの単一が必要です
• 未使用の変数を削除する必要があります
• 役に立たないタグを削除する必要があります
• ステップが正規表現に従う必要がある場合
• 言葉遣いはビジネスレベルにとどまる必要があります