🔱SCAST

Static Code Analysis and Visualization

2024/9/27 by DKZ

English/中文

🔱SCAST is a programmatic tool that converts code into UML diagrams and flowcharts.

📽️watch video
📽️Tutorial
📽️MCP

support plan

• javascript (use acorn)
• typescript (use typescript for now estree later)
• csharp (use a custom parser no longer supported in future)
• python (ues a custom parser use filbert later)
• vue (later)

The underlying principle involves leveraging a parser to parse the code into an Abstract Syntax Tree (AST), followed by static analysis, and finally utilizing Mermaid and D3 for visualization.

You can try it online or just download this repo and open SCAST.html with browser.
For Developers it can be deployed on servers using npm run server. Or use it as MCP server integrate it into your AI client.

Update

MCP

1. git clone https://github.com/davidkingzyb/SCAST.git download the source code.
2. npm install
3. config at your client

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

Tools

scast_analysis:

SCAST is a tool designed to assist users in analyzing and summarizing code through visualization. By simply providing the folder path where the code is located, SCAST can perform static analysis on the code, generating an AST tree to helping users understand the code structure and explain its functionality. Generate various visual charts such as UML diagrams, AST tree diagrams and Mermaid flowcharts. Finally return a keyword list containing all class and method names along with their functionality explanations, and include a link to allow users to view the chart details in their browser.

scast_retriever

SCAST is a tool that helps users analyze and summarize code and provides visualizations. You need to provide the file path of the source code folder. SCAST will perform static analysis on the source codes in the folder, generating an AST tree to help users understand the code structure and explain its functionality. After analyzing the code directory with SCAST, you can use keywords in the AST tree for searching, better answering user questions using a RAG method. This keyword can be a class name, method name, or field name. SCAST will find the source code at its definition and return it.

Ollama AI

install ollama first see ai.js for more details

ESTree

Compliant with ESTree specification AST parser

Force Directed Graph

More D3 Graph

• Indented tree
• Tidy tree
• Cluster tree
• Tadial tidy tree
• Radial cluster tree
• Force directed tree
• Edge bundling