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

项目截图