Autodocument

🚀 代碼管理工具

本工具是一款強大的代碼管理工具，能夠為代碼庫生成全面文檔、自動生成測試計劃和進行代碼審查，有效提升開發效率和代碼質量。

🚀 快速開始

本工具具備生成文檔、自動生成測試計劃和自動代碼審查等核心功能，能為開發者提供全面的代碼管理支持。

✨ 主要特性

• 生成文檔：為代碼庫生成全面的技術文檔。
• 自動生成測試計劃：為代碼中的函數和組件生成詳細的測試方案。
• 自動代碼審查：提供資深開發人員級別的代碼審查反饋。

📦 安裝指南

安裝步驟

請按照以下步驟進行安裝：

1. 克隆本倉庫到本地機器。
2. 使用npm或yarn進行依賴項安裝。
3. 配置環境變量，特別是OPENROUTER_API_KEY。

環境變量

以下是需要設置的關鍵環境變量：

💻 使用示例

生成文檔

該工具可以生成全面的代碼庫技術文檔：

{
  "path": "/路徑/到/你的/項目",
  "openRouterApiKey": "你的-api-密鑰", // 可選參數
  "model": "anthropic/claude-3-7-sonnet", // 可選參數
  "updateExisting": true // 可選，缺省為true
}

自動生成測試計劃

該工具能夠生成詳細的測試方案：

{
  "path": "/路徑/到/你的/項目",
  "openRouterApiKey": "你的-api-密鑰", // 可選參數
  "model": "anthropic/claude-3-7-sonnet", // 可選參數
  "updateExisting": true // 可選，缺省為true
}

自動代碼審查

該工具提供專業級的代碼審查反饋：

{
  "path": "/路徑/到/你的/項目",
  "openRouterApiKey": "你的-api-密鑰", // 可選參數
  "model": "anthropic/claude-3-7-sonnet", // 可選參數
  "updateExisting": true // 可選，缺省為true
}

📚 詳細文檔

輸出文件說明

文檔輸出

生成的主要文檔類型包括：

• documentation.md：包含代碼庫的全面技術文檔，內容涵蓋代碼的目的和作用、關鍵函數和類的詳細說明、文件之間的關係描述、整合子組件的信息。
• testplan.md：包含詳細的測試方案，內容包括各函數適合的測試類型（單元測試、集成測試、端到端測試）、常見邊界情況分析、依賴項 mocking 要求、集成測試策略建議。
• review.md：提供資深開發人員級別的審查反饋，內容涵蓋安全隱患和潛在漏洞、編碼規範中的違規點、可能存在的bug或架構問題、改進機會和重構建議、實用的改進建議（避免風格上的微調）。

備用文件

當目錄超過大小或文件數量限制時，生成以下備用文件：

• undocumented.md：用於文檔生成過程中的未處理內容，包含忽略處理的原因說明、已分析但排除在外的文件列表、如何解決問題的指導（如增加限制或手動創建內容）。

問題排查

API密鑰相關問題

若出現無效API密鑰錯誤，請執行以下檢查：

1. 確保已設置OPENROUTER_API_KEY環境變量。
2. 驗證OpenRouter賬戶處於活躍狀態。
3. 確認擁有足夠的API調用額度。

大小限制問題

如果遇到因目錄過大或文件數量過多導致的處理失敗，請執行以下操作：

1. 調整MAX_FILE_SIZE_KB和MAX_FILES_PER_DIR環境變量以增加限制。
2. 考慮對非常大的目錄進行手動文檔編寫。

模型選擇問題

如果對生成結果的質量不滿意，可以嘗試更換模型：

• 設置OPENROUTER_MODEL環境變量為所需的其他模型名稱。

📄 許可證

本項目採用CC0-1.0許可證，作品版權歸屬於公共領域，由美國能源部擁有。

貢獻指南

歡迎各位開發者積極參與項目貢獻！請隨意提交Pull Request。

添加新功能模塊

為了方便添加新的自動化工具，請遵循以下步驟：

1. 在src/tools目錄下創建新的工具類文件。
2. 實現相應的業務邏輯和接口適配。
3. 更新主程序以支持新功能的調用。