Validate での保存メトリックの管理

大規模なプロジェクトで必要なビルドのロード時間とディスク容量を減らすには、Validate に保存されるメトリックを指定する保存メトリック構成 (SMC) ファイルを使用します。除外されたメトリックは、データベースのロード中にフィルタリングされます。 含めることができるメトリックの全リストについては、「メトリックリファレンス」を参照してください。

SMC ファイルは、YAML または JSON で記述する必要があり、メトリックプロパティをメトリックのリスト (文字列または数値のいずれか) と共に含みます。

Validate では、プロジェクトの [構成] タブにある CONFIGURATION FILES で SMC ファイルを管理することができます。SMC ファイルをクリックして編集してから、[保存] を押して変更を保存します。

プロジェクトごとに 1 つの SMC ファイルを使用することができます。関心があるメトリックを指定できるレポートを使用する場合は、それらのメトリックを SMC ファイルに含めることをお勧めします。

デフォルトで、以下のような、いくつかの SMC ファイルを使用することができます。

• all_metrics.smc には、すべてのメトリックが含まれます。
• Stored_metrics.smc には、デフォルトで、変更量レポートと複雑度レポートが機能するために必要なメトリックが含まれます。デフォルトの SMC ファイルとして使用されます。
  
• reports_metrics.smc には、変更量レポートと複雑度レポートが機能するために必要なメトリックが含まれます。
• required_metrics.smc には、コンプライアンスレポートが機能するために必要なメトリックが含まれます。
• performant_metrics.smc には、重要なファイルとクラスレベルのメトリックが含まれ、機能メトリックは含まれません。

すべてのメトリックを Validate にロードするには、以下のようないくつかの選択肢があります。

• all_metrics.smc ファイルを使用します。
• 現在の SMC ファイルを削除します。
• 現在の SMC ファイルからすべてのメトリックを削除します (空のSMC ファイルを使用)。

デフォルトの SMC ファイルを変更するには、そのファイルをワークスペースにロードします。以降に作成されるすべてのプロジェクトで、その SMC ファイルが使用されます。

デフォルトで、stored_metrics.smc ファイルが使用されます。install ディレクトリ内の SMC ファイルの名前を stored_metrics.smc に変更してから、新しい projects_root を作成するか、または projects_root を移行すると、名前が変更されたファイルがすべての新しいプロジェクトで使用されるようになります。 新しいプロジェクトごとに SMC ファイルを手動で更新しなくても済むようにするには、projects_root を作成または移行する前に、stored_metrics.smc ファイルを更新して必要なメトリックを含めます。

Validate で新しい SMC ファイルをアップロードするか、または SMC ファイルを編集すると、そのファイルが評価され、不正な場合は Validate によって通知されます。 コンプライアンスレポートで使用されるメトリックがファイルに含まれていない場合は、Validate によって警告が発行されます。

新規または既存のプロジェクトに SMC ファイルをインポートする方法については、「単一のプロジェクトまたは projects_root 全体の構成」を参照してください。