Scast

🚀 🔱SCAST

🔱SCAST 是一個程序化工具，能將代碼轉換為 UML 圖表和流程圖，實現靜態代碼分析與可視化，助力開發者更好地理解代碼結構。

🚀 快速開始

您可以通過以下兩種方式使用 SCAST：

• 在線嘗試：訪問在線地址直接體驗。
• 本地部署：下載此倉庫並在瀏覽器中打開 SCAST.html。對於開發者，還能使用 npm run server 部署到服務器上，或作為 MCP 服務集成到您的 AI 客戶端中。

✨ 主要特性

• 多語言支持：支持多種編程語言，包括 javascript（使用 acorn）、typescript（目前使用 typescript，後續改用 estree）、csharp（使用自定義解析器，未來不再支持），計劃支持 python（使用 filbert）和 vue（後續實現）。
• 可視化展示：利用解析器將代碼解析為抽象語法樹（AST），進行靜態分析後，藉助 Mermaid 和 D3 實現可視化，生成如 UML 圖、AST 樹圖表和 Mermaid 流程圖等。
• 多種使用方式：既可以在線體驗，也能本地部署，還能集成到 AI 客戶端中。

📦 安裝指南

MCP 安裝步驟

1. 使用命令 git clone https://github.com/davidkingzyb/SCAST.git 下載源代碼。
2. 執行 npm install 安裝依賴。
3. 在客戶端進行如下配置：

{
  "mcpServers": {
    "scast":{
      "command":"node",
      "args":[
        "/YOUR_INSTALL_DIR/SCAST/mcp/index.js",
        "/YOUR_WORKSPACE/",
        "C:\\Users\\DKZ\\OTHER_ALLOWED_DIR\\",
      ]
    }
  }
}

💻 使用示例

基礎用法

SCAST 提供了兩個實用工具：

scast_analysis

SCAST 可幫助用戶通過可視化分析和總結代碼。只需提供代碼所在的文件夾路徑，它就能對代碼進行靜態分析，生成 AST 樹以幫助用戶理解代碼結構並解釋其功能。同時，它會生成各種圖表，如 UML 圖、AST 樹圖表和 Mermaid 流程圖。最後返回一個包含所有類和方法名稱及其功能說明的關鍵詞列表，並提供鏈接讓用戶可以在瀏覽器中查看圖表詳細信息。

scast_retriever

SCAST 能幫助用戶分析和總結代碼並提供可視化。您需要提供源代碼文件夾的文件路徑，它將對文件夾中的源代碼進行靜態分析，生成 AST 樹以幫助用戶理解代碼結構並解釋其功能。在分析完代碼目錄後使用 SCAT，您可以使用 AST 樹中的關鍵詞進行搜索，更好地利用 RAG 方法回答用戶問題。此關鍵字可以是類名、方法名或字段名，SCAST 將找到其定義位置的源代碼。

📚 詳細文檔

Ollama AI

首先安裝 ollama，查看 ai.js 瞭解更多細節。

ESTree

SCAST 使用符合 ESTree 規範的 AST 解析器。

Force Directed Graph

🔧 技術細節

SCAST 的基本原理是利用解析器將代碼解析為抽象語法樹（AST），然後進行靜態分析，最後藉助 Mermaid 和 D3 進行可視化。

📄 許可證

文檔未提及許可證相關信息。

相關鏈接

• 觀看視頻
• 教程
• MCP

項目信息

• 實現時間：2024/9/27
• 實現者：DKZ

項目截圖