EN JP CN

Klocwork レビューでのライブリンクの設定

Klocwork レビューでのライブリンクの設定

置換スキーマを作成すると、欠陥番号や ID などの一意の識別子がある場合に、コミットメッセージ、アクション、およびコメント内でハイパーリンクを自動的に作成できます。Code Review[設定] タブで、置換スキーマにアクセスしたり、新しい置換スキーマを作成したりすることができます。

置換スキーマはregexURL patternの、2つの部分で構成されています。regex は、レビューコメント、コミットメッセージ、またはアクション内の特定のテキストパターンを照合する正規表現です。正規表現には、URL パータン で変数として使用できるキャプチャグループが 1 つ以上含まれている必要があります。URL パターン は、リンクのターゲット URL のテンプレートです。正規表現と一致するテキストがある場合、そのテキストは、ターゲット URL が URL パターン から生成されるリンクで置換され、引数がある場合は入力されます。

デフォルトの置換スキーマ

Code Review には、以下の定義済み置換スキーマが用意されています。

置換スキーマ説明
kw\:(\d+) Code Review 内の指摘へのリンクを作成します。
line\:(\d+) 現在のファイルリビジョン内の行へのリンクを作成します。
ref\:(\d+) Code Review 内の別のリビジョンへのリンクを作成します。
([hH][tT][tT][pP][sS]?://[^\p{Space}]+) URL がある場合にリンクを作成します。

デフォルトのフォーマット要素

Code Review には、デフォルトの置換スキーマに加え、独自のカスタム置換スキーマで使用できる以下のフォーマット要素も用意されています。

フォーマット要素説明
{file_revision} Klocwork ファイルリビジョン ID。{file_revision} は含める必要のある必要のパラメーターです。含めなかった場合、テキストはリンクに変換されません。そのため、{file_revision} はコミットメッセージで使用できません。
{project} リビジョンが属するプロジェクトの名前。

置換スキーマの作成

新しい置換スキーマを作成するには、[新しいスキーマの作成] をクリックします。

[Regex] フィールドに、置換するパターンと一致する正規表現を入力します。正規表現には 1 つまたは複数のキャプチャグループを必ず含めてください。たとえば、次のようになります。

ref\:(\d+)

[URL パターン] フィールドに、キャプチャグループが挿入される置換 URL パターンを、フォーマット要素も含めて入力します。たとえば、次のようになります。

/codereview/CodeReview#revision_goto:revisionId={0}

注意:URL 置換パターンには、正規表現フィールドの各キャプチャグループに対応するフォーマット要素が含まれている必要があります。同じフォーマット要素を複数回指定することもできます。サポートされている表現のリストについては、Java クラスのドキュメンテーションを参照してください。

[作成] をクリックしてスキーマを保存します。正規表現パターンがコメント、アクション、またはコミットメッセージのテキストと一致する場合、そのテキストは指定された URL パターンで置換されます。

例 1

次の例では、ユーザーの Twitter ハンドルがそのユーザーの Twitter ページへのリンクで置換されます。

Regex:

@(\w+)

URL パターン:

https://twitter.com/{0}

例 2

次の例では、シンプルなキーワードフレーズと ID 番号がバグ追跡システム内の対応するレコードへのリンクで置換されます。

Regex:

[bB][uU][gG][\p{Space}|:]*(\d+)

URL パターン:

http://example.com/bugs?id={0}&project={project}

上記の URL パターンでは、デフォルトの{project} フォーマット要素が使用されています。