SCAST

🚀 🔱 靜態代碼分析與可視化（SCAST）

SCAST 是一款強大的編程工具，它能夠將代碼轉換為 UML 圖和流程圖，極大地提升了代碼的可讀性和可理解性，幫助開發者更高效地分析和理解代碼結構。

2024/9/27 由 DKZ 創建

English/中文

🔱SCAST 是一個將代碼轉換為 UML 圖和流程圖的編程工具。

📽️ 視頻演示
📽️ 教程
📽️ MCP

🚀 快速開始

SCAST 的使用非常便捷，你可以通過以下兩種方式開始使用：

• 你可以直接在在線版本嘗試。
• 或者下載此倉庫後在瀏覽器中打開 SCAST.html。對於開發者，還可以使用 npm run server 部署到服務器，也可作為 MCP 服務器集成到你的 AI 客戶端。

✨ 主要特性

支持多語言

SCAST 支持多種編程語言，具體計劃如下：

• JavaScript（使用 acorn）
• TypeScript（目前使用 typescript，後續改用 estree）
• C#（目前使用自定義解析器，未來不再支持）
• Python（計劃改用 filbert）
• Vue（後續支持）

可視化原理

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

📦 安裝指南

MCP 功能安裝步驟

1. 下載源碼：

   git clone https://github.com/yourusername/scast.git
   cd scast
   

2. 安裝依賴：

   npm install
   

3. 配置 MCP 服務器：
   • 創建 config.json 文件。
   • 添加以下內容到 config.json：

     {
       "port": 3000,
       "host": "localhost",
       "debug": true
     }
     

💻 使用示例

工具功能使用

scast_analysis

• 功能：執行代碼分析並生成可視化結果。
• 描述：支持多種語言的語法分析和依賴關係圖生成。

scast_retriever

• 功能：提取代碼中的特定信息。
• 描述：用於數據檢索和模式匹配。

Ollama AI 集成

• 安裝步驟：

  pip install oliviaai
  

• 在 ai.js 中配置：

  const ai = new OliviaAI({
    apiKey: 'your_api_key',
    model: 'gpt-4'
  });
  

📚 詳細文檔

ESTree 兼容性

• 詳細文檔請參考 ESTree。

D3 圖表類型

• 力導引圖
• 樹狀圖
• 層次結構圖
• 網絡圖
• 時間線圖

更多詳細內容請參考相關圖片鏈接：