Code Summarizer

🚀 代碼總結工具

這個工具是一個命令行接口（CLI），可對指定目錄中的代碼文件進行智能摘要。它支持多種編程語言，藉助 Gemini Flash 2.0 的自然語言處理能力，生成簡潔明瞭的代碼摘要。

🚀 快速開始

本工具是一個命令行接口（CLI），能對指定目錄中的代碼文件進行智能摘要。它支持多種編程語言，通過調用 Gemini Flash 2.0 的自然語言處理能力，生成清晰簡潔的代碼摘要。

✨ 主要特性

• 支持多種編程語言。
• 藉助 Gemini Flash 2.0 生成智能代碼摘要。
• 可通過命令行參數或配置文件靈活定製。

📦 安裝指南

方式一：使用 npm 包管理器

npm install code-summarizer -g

方式二：從源碼安裝

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 許可證。