Skip to content

Jason-Tan1/VisualDebugger

 
 

Repository files navigation

🐞 Visual Debugger

AI-Powered Bug Tutor for VS Code

View RepoReport Bug

📖 About The Project

Visual Debugger is an AI-powered educational tool that transforms the debugging process into a learning opportunity. Instead of just fixing code blindly, it helps students and junior developers understand why an error occurred and how to verify the fix.

Debugging is often the most frustrating part of learning to code. Beginners get stuck on cryptic error messages, apply random fixes from StackOverflow, or let AI write code they don't understand. Visual Debugger bridges this gap by acting as an always-available tutor that explains the logic, visualizes the changes, and tracks learning progress over time.

Built for the CTRL HACK DEL, utilizing Google Gemini 2.0 Flash for high-speed, structured reasoning.

✨ Key Features

  • 🧠 Plain English Explanations – Translates cryptic runtime errors and syntax issues into clear, beginner-friendly language.
  • 🗣️ Audio Guidance – Uses ElevenLabs (Elise) to read explanations aloud, helping auditory learners.
  • 📊 Visual Diff Reviews – Shows exactly what changed with a clear red/green diff visualization and "Why this works" breakdown.
  • 🎯 Interactive Quizzes – Generates quick multiple-choice questions to ensure you actually understood the bug.
  • 📈 Progress Dashboard – Tracks your most common error categories over time using Chart.js.
  • 🔎 Inline Actions – "Explain This Error" CodeLens appears right next to red squiggles in your editor.

🛠️ Built With

Core

VS Code TypeScript Esbuild

AI & Services

Google Gemini ElevenLabs

UI & Visualization

HTML5 CSS3 Chart.js

🚀 Getting Started

Installation

  1. Clone the repository

    git clone https://github.com/kurtjallo/visualDebugger.git
    cd visualDebugger
  2. Install dependencies

    cd extension
    npm install
  3. Set up API Keys

    You will need a Google Gemini API key.

    • Press Ctrl+Shift+P (Cmd+Shift+P on Mac)
    • Run command: Visual Debugger: Set Gemini API Key
    • Paste your key from Google AI Studio

    (Optional) For voice features:

    • Run command: Visual Debugger: Set ElevenLabs API Key
  4. Run the Extension

    • Open extension/src/extension.ts
    • Press F5 to open a new VS Code window with the extension loaded.

Screenshots

ErrorFound BugInfo1 BugDashboard1

💡 Usage

  1. Open a file with errors (or use our demo-app folder).
  2. Click "Explain This Error" floating above the red squiggle.
  3. Read or Listen to the explanation in the side panel.
  4. Apply Fix to see the code changes.
  5. Review the Diff to understand exactly what was modified and why.

👨‍💻 Team

Built with ❤️ at CTRL HACK DEL by:

📄 License

Distributed under the MIT License. See LICENSE for more information.

🙏 Acknowledgments

  • Google Gemini for the incredible speed and structured output capabilities.
  • ElevenLabs for the natural-sounding voice API.
  • CTRL HACK DEL for the creating such a memorable hackathon.

Made at York University's CTRL HACK DEL

⬆ Back to Top

About

A VS Code extension that helps developers truly learn and understand code through deep visual inspection, moving beyond "vibecoding" and AI prompting to build real comprehension.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 71.5%
  • HTML 14.7%
  • CSS 13.3%
  • JavaScript 0.5%