English | 简体中文

PHP Debug Manager (with Featured VarDumper tool)

A VS Code extension focused on managing debug statements in PHP. The main feature is the Debug Manager (tree view, bookmarks, export, logs, i18n), plus a featured VarDumper insertion tool.

Features

Smart Scanning (v2.0 - Tree-sitter)

• Uses Tree-sitter-php for accurate PHP AST parsing with incremental updates
• Supports multiple patterns: var_dump, print_r, error_log, debug_backtrace, dump, dd, etc.
• Tree view: file → line → content
• Precisely identifies debug statements, avoiding false positives in strings and comments
• Incremental scanning for fast updates when files change
• Parallel workspace scanning for large projects

Inline Decorator

• Real-time highlighting of debug statements in the editor
• Gutter icons for quick identification
• Color-coded by severity (error, warning, info)

Variable Preview

• Hover over PHP variables to see type and scope information
• Quick documentation for variables in context

Batch Operations

• Toggle comments on debug statements
• Delete debug statements
• Enable/disable debug statements
• Export statements to JSON, CSV, or Text format

Theme Support

• Automatic light/dark theme switching
• Consistent with VS Code theme settings

Status Bar

• Shows debug statement count
• Scan progress indicator
• Quick actions menu

Interactions

• Jump to location
• Clear statements (single/file/global; bookmarked items are protected)
• Expand/collapse
• Reveal in Manager from SCM warning dialog

Filtering

• View-level filter with funnel button to hide selected built-in debug types
• Selection persists per workspace
• Types are system-provided (non-editable): var_dump, print_r, echo, print, var_export, printf, die, exit, error_log, trigger_error, user_error, debug_backtrace, dump, dd, xdebug_var_dump, xdebug_debug_zval, xdebug_break

Monitoring

• Auto refresh on file changes
• Manual refresh and auto scan
• Output channel logs time and results (EN/ZH)

SCM Staging Guard

• Modes:
  • strict: block staging when debug statements exist
  • warn: unstage first, require "Continue" to re-stage; supports "Reveal Location" and "Reveal in Manager"
  • lenient: log only
• Configurable and enabled by default (strict)
• Intercept types can be configured; strict and warn modes respect your selection
• Command: phpDebugManager.stagingGuard.configureTypes (shield icon) opens a multi-select for built-in types

VarDumper Tool (featured)

• Shortcut: mac cmd+shift+/, win/linux ctrl+shift+/
• Smart insertion after semicolon or into empty block, matching indentation
• AST-based expression validation for variables and function calls
• Avoids arrays/argument lists; warns and skips in strings or incomplete selections

Configuration (example)

{
  "phpDebugManager.autoScan": true,
  "phpDebugManager.scanOnStartup": true,
  "phpDebugManager.showStatusBar": true,
  "phpDebugManager.stagingGuard.enabled": true,
  "phpDebugManager.stagingGuard.mode": "strict",
  "phpDebugManager.stagingGuard.types": [
    "var_dump","print_r","echo","print","var_export","printf",
    "die","exit","error_log","trigger_error","user_error",
    "debug_backtrace","dump","dd","xdebug_var_dump","xdebug_debug_zval","xdebug_break"
  ],
  "phpDebugManager.language": "system"
}

Internationalization

• Manifest strings follow VS Code UI language
• Runtime strings (dialogs, status bar, logs, tree labels) switchable via setting

Commands

Performance

• Scan < 2s for 1000+ files with incremental updates
• Low memory footprint during scan with intelligent caching
• Real-time updates with < 100ms response time

Implementation (overview)

• Tree-sitter parsing: Uses tree-sitter-php for precise PHP syntax analysis with incremental updates
• Modular architecture: Core (parser, scanner, cache), Features (debug manager, var dumper, staging guard, export), UI (views, themes, webview), Utils (i18n, logger, performance)
• Core components: TreeSitterParser, IncrementalScanner, WorkspaceScanner, AstCache, FileCache
• Efficient file filtering and caching; incremental scan; memory usage optimization
• Output logs for scan duration and results; guard integrates with repository state changes

License & Support

• MIT License
• Issues: GitHub repository

Keep your repo clean with organized debugging.