SCAST

开发官方认证 JavaScript

🚀 🔱 静态代码分析与可视化（SCAST）

SCAST 是一款强大的编程工具，它能够将代码转换为 UML 图和流程图，极大地提升了代码的可读性和可理解性，帮助开发者更高效地进行代码审查和项目规划。

2024/9/27 由 DKZ 开发

English/中文

🔱SCAST 是一个将代码转换为 UML 图和流程图的编程工具。

📽️ 视频演示
 📽️ 教程
 📽️ MCP

🚀 快速开始

SCAST 支持多种编程语言，计划支持的语言如下：

JavaScript（使用 acorn）
TypeScript（目前使用 typescript，后续改用 estree）
C#（目前使用自定义解析器，未来不再支持）
Python（计划改用 filbert）
Vue（后续支持）

其基本原理是通过解析器将代码解析为抽象语法树（AST），然后进行静态分析，最后利用 Mermaid 和 D3 进行可视化。

你可以通过以下两种方式体验 SCAST：

在线体验：访问在线版本。
本地体验：下载此仓库后在浏览器中打开 SCAST.html。对于开发者，还可以使用 npm run server 部署到服务器，或作为 MCP 服务器集成到你的 AI 客户端。

✨ 主要特性

多语言支持：支持多种主流编程语言，满足不同项目的需求。
可视化展示：将代码转换为 UML 图和流程图，直观呈现代码结构和逻辑。
代码分析：执行代码分析并生成可视化结果，支持多种语言的语法分析和依赖关系图生成。
信息提取：提取代码中的特定信息，用于数据检索和模式匹配。
AI 集成：可与 Ollama AI 集成，提升开发效率。

📦 安装指南

MCP 功能安装

下载源码：

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

安装依赖：
```
npm install
```
配置 MCP 服务器：
- 创建 config.json 文件。
- 添加以下内容到 config.json：
```
{
"port": 3000,
"host": "localhost",
"debug": true
}
```

Ollama AI 集成安装

安装步骤：
```
pip install oliviaai
```

在 ai.js 中配置：

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

💻 使用示例

scast_analysis

功能：执行代码分析并生成可视化结果。
描述：支持多种语言的语法分析和依赖关系图生成。

scast_retriever

功能：提取代码中的特定信息。
描述：用于数据检索和模式匹配。

📚 详细文档

ESTree 兼容性

详细文档请参考 ESTree。

D3 图表类型

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

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

🔧 技术细节

SCAST 的核心技术在于通过解析器将代码解析为抽象语法树（AST），然后进行静态分析，最后利用 Mermaid 和 D3 进行可视化。这种技术架构使得 SCAST 能够高效地处理多种编程语言，并生成直观的可视化结果。

📄 许可证

文档中未提及许可证信息。

0 条评论
分类：开发