コード メトリクス分析

目次

• 概要
• 使用場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

コード品質メトリクスを測定・分析して、複雑性の問題、保守性の課題、改善すべき領域を特定します。

使用場面

• コード品質評価
• リファクタリング候補の特定
• 技術負債の監視
• コードレビュー自動化
• CI/CD品質ゲート
• チームパフォーマンス追跡
• レガシーコード分析

クイックスタート

最小限の動作例:

import * as ts from "typescript";
import * as fs from "fs";

interface ComplexityMetrics {
  cyclomaticComplexity: number;
  cognitiveComplexity: number;
  linesOfCode: number;
  functionCount: number;
  classCount: number;
  maxNestingDepth: number;
}

class CodeMetricsAnalyzer {
  analyzeFile(filePath: string): ComplexityMetrics {
    const sourceCode = fs.readFileSync(filePath, "utf-8");
    const sourceFile = ts.createSourceFile(
      filePath,
      sourceCode,
      ts.ScriptTarget.Latest,
      true,
    );

    const metrics: ComplexityMetrics = {
      cyclomaticComplexity: 0,
      cognitiveComplexity: 0,
// ... (see reference guides for full implementation)

リファレンスガイド

references/ ディレクトリの詳細な実装:

ガイド	内容
TypeScript Complexity Analyzer	TypeScript Complexity Analyzer
Python Code Metrics (using radon)	Python Code Metrics (using radon)
ESLint Plugin for Complexity	ESLint Plugin for Complexity
CI/CD Quality Gates	CI/CD Quality Gates

ベストプラクティス

✅ DO

• メトリクスを時系列で監視する
• 合理的な閾値を設定する
• 絶対値ではなくトレンドに焦点を当てる
• メトリクス収集を自動化する
• メトリクスをリファクタリングの指針に使用する
• 複数のメトリクスを組み合わせる
• コードレビューにメトリクスを含める

❌ DON'T

• メトリクスを唯一の品質指標として使用しない
• 非現実的な閾値を設定しない
• コンテキストとドメインを無視しない
• 開発者をメトリクスで罰しない
• 1つのメトリクスだけに焦点を当てない
• ドキュメント作成をスキップしない