Code Summarizer

🚀 コード要約ツール

このツールは、指定されたディレクトリ内のコードファイルをスマートに要約するコマンドラインインターフェース（CLI）です。複数のプログラミング言語をサポートし、Gemini Flash 2.0 の自然言語処理機能を利用して、簡潔で明確なコード要約を生成します。

🚀 クイックスタート

このコード要約ツールを使えば、指定ディレクトリ内のコードファイルを簡単に要約できます。以下に、インストール方法と使用方法を説明します。

✨ 主な機能

• 複数のプログラミング言語に対応したコード要約機能。
• Gemini Flash 2.0 の自然言語処理能力を活用した高精度な要約生成。
• コマンドライン引数または設定ファイルによる柔軟なカスタマイズ。

📦 インストール

方法1：npm パッケージマネージャーを使用する

npm install code-summarizer -g

方法2：ソースコードからインストールする

1. このリポジトリをローカルにクローンします。
2. プロジェクトディレクトリに移動し、以下のコマンドを実行します。

npm install

その後、bin/code-summarizer をシステムの PATH に追加します。

💻 使用例

基本的な使用法

code-summarizer <directory> [-d|--detail] [-l|--max-length]

オプションの説明

• <directory>：必須パラメータで、スキャンするコードディレクトリを指定します。
• -d, --detail：要約の詳細度を設定します。選択肢は 'low', 'medium' または 'high' で、デフォルトは 'medium' です。
• -l, --max-length：各要約の最大長（文字数）を設定します。デフォルトは 500 です。

例

低詳細度のコード要約を生成する：

code-summarizer ./src --detail low

📚 ドキュメント

操作フロー

1. 指定されたディレクトリをスキャンし、サブフォルダを再帰的に走査します。
2. .gitignore の無視ルールに基づいて、処理対象外のファイルとフォルダを除外します。
3. ファイルタイプを識別し、サポートされている言語のコードファイルのみを処理します。
4. 各コードファイルの内容を分析し、スマートな要約を生成します。
5. すべての要約を指定された形式でターゲットファイルに出力します。

設定オプション

このツールは、コマンドライン引数または設定ファイルを使用して柔軟にカスタマイズできます。

コマンドライン引数

• --detail, -d：要約の詳細度を設定します。選択肢は 'low', 'medium' または 'high' で、デフォルトは 'medium' です。
• --max-length, -l：各要約の最大長（文字数）を設定します。デフォルトは 500 です。

設定ファイル

このツールは、プロジェクトのルートディレクトリにある config.json ファイルを使用した設定をサポートしています。以下は例です。

{
  "detailLevel": "medium",
  "maxLength": 500,
  "supportedLanguages": ["typescript", "javascript", "python"],
  "ignoredFiles": ["**/*.test.ts", "**/*.spec.ts"]
}

サポートされる言語とファイルタイプ

• TypeScript（.ts, .tsx）
• JavaScript（.js, .jsx）
• Python（.py）
• Java（.java）
• C++（.cpp）
• C（.c）
• Go（.go）
• Ruby（.rb）
• PHP（.php）
• C#（.cs）
• Swift（.swift）
• Rust（.rs）
• Kotlin（.kt）
• Scala（.scala）
• Vue（.vue）
• HTML（.html）
• CSS（.css, .scss, .less）

出力形式

生成される要約ファイルは、以下の形式になります。

相対パス/ファイル名
要約内容

次の相対パス/ファイル名
次の要約内容

プロジェクト構造

• index.ts：メインの CLI 実装ファイル
• src/：ソースコードディレクトリ
  • summarizer/：コアの要約機能モジュール
  • mcp/：MCP サーバーの実装
  • config/：設定管理モジュール
• bin/：CLI のエントリポイント
• config.json：デフォルトの設定ファイル
• tsconfig.json：TypeScript の設定ファイル
• package.json：プロジェクトの依存関係とスクリプト情報
• .env.example：環境変数の設定テンプレート
• .gitignore：Git の無視ルールファイル
• __tests__：単体テストと統合テストのディレクトリ
• __mocks__/mock-codebase：テスト用のモックコードベース

環境変数

以下の環境変数を使用して、アプリケーションを設定できます。

使用シーン

• 開発者が大規模なコードベースの機能と構造を迅速に把握したい場合。
• プロジェクトの保守担当者がドキュメントや README ファイルを作成する際に、簡潔なコード概要を取得する場合。
• 教育やトレーニングで、学習者が複雑なコードを理解するのを支援する場合。

既知の問題

• 非常に大規模なコードベースの場合、パフォーマンスが低下する可能性があります。コード構造を最適化するか、段階的に処理することをおすすめします。
• 現在のバージョンは、事前に設定された言語とファイルタイプのみをサポートしており、カスタム拡張はサポートされていません。

将来の計画

• より多くのプログラミング言語のサポートを追加する。
• より柔軟な設定オプションを提供する、例えばカスタムの無視ルールや出力形式。
• GUI バージョンを開発し、ユーザーが視覚的に操作できるようにする。

貢献ガイド

どんな貢献も歓迎します！以下の手順に従ってください。

1. このリポジトリを自分のアカウントに Fork します。
2. ローカルのコピーで変更を加えるか、機能を追加します。
3. コードの変更をコミットし、Pull Request を作成します。
4. 我々があなたの PR をレビューし、適切なタイミングでマージします。

📄 ライセンス

このプロジェクトは MIT License のライセンスの下で提供されています。