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 图表类型

• 力导引图
• 树状图
• 层次结构图
• 网络图
• 时间线图

更多详细内容请参考相关图片链接：