Skip to content

sat-wik/code-visualizer

Repository files navigation

Code Visualizer

Code Visualizer is a VS Code extension that provides an interactive, WebGL-based visualization of your codebase architecture. It helps developers understand complex codebases by visualizing code relationships, dependencies, and structure in an intuitive 3D interface.

Features

  • Interactive 3D Visualization: Explore your code architecture through an immersive WebGL-powered visualization using Three.js
  • Real-time Code Analysis: Automatically detects changes in your codebase and updates the visualization
  • Dependency Mapping: Visualizes relationships between files, functions, and modules
  • Advanced Navigation: Intuitive controls for zooming, panning, and rotating the visualization
  • Customizable Views: Filter and highlight specific elements to focus on areas of interest
  • Performance Optimized: Efficiently handles large codebases with minimal performance impact

Requirements

  • VS Code 1.85.0 or higher
  • WebGL-capable browser environment

Usage

  1. Open your project in VS Code
  2. Launch the extension by:
    • Running the "Open Code Visualizer" command from the Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
    • Clicking on the Code Visualizer icon in the Activity Bar
  3. The visualization will open in a new WebView panel
  4. Navigate the visualization:
    • Left-click and drag to rotate the view
    • Right-click and drag to pan
    • Scroll to zoom in/out
    • Click on nodes to view detailed information
  5. Use the controls panel to filter and customize the visualization

Development Setup

Prerequisites

  • Node.js (latest LTS version recommended)
  • npm or yarn

Setup Steps

  1. Clone the repository
git clone https://github.com/example/code-visualizer.git
cd code-visualizer
  1. Install dependencies
npm install
  1. Build the extension
npm run compile
  1. Package the extension
npm run package
  1. Run and debug
    • Press F5 in VS Code to launch a new window with the extension loaded
    • Run the "Open Code Visualizer" command to test the extension

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages