Skip to content

A modern, dependency-free, cross-browser extension for Xdebug.

License

Notifications You must be signed in to change notification settings

JetBrains/xdebug-extension

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Xdebug Extension use Xdebug Extension

A modern, dependency-free, cross-browser extension for Xdebug.

It works in Chrome*, Firefox and Edge browsers

This work is based on some of the ideas in the legacy Xdebug helper extension.

The motivation for this new extension was that xdebug-helper will soon no longer be supported and was limited to Chrome in any case. I had originally intended to update and submit a PR on that extension, but realized that it was probably better to just start from scratch using a more modern approach.

Available in Chrome Web Store Available in the Mozilla Addons Available in Microsoft Edge Addons

* It may also work on other Chromium based browsers (Opera, Vivaldi, Brave, etc) that allow Chrome extensions, however these are untested and are not offically supported by this project.

Note

This extension was originally developed by @FraserChapman, who continues to maintain it in collaboration with @JetBrains.
We appreciate Fraser’s work in making debugging easier for PHP developers!

Features

  • Set custom IDE key, trace trigger, and profile triggers

Xdebug Extension options

  • Toggle debugging, profiling, and tracing

Xdebug Extension popup

Installation

Chrome

Available in Chrome Web Store

From source

  1. Clone the xdebug-extension repository
  2. Go to chrome://extensions/
  3. Turn on "Developer Mode"
  4. Choose "Load unpacked extension"
  5. select the src directory inside the xdebug-extension directory you downloaded in step one.

Firefox

From Mozilla Addons

Available in the Mozilla Addons

From source

  1. Clone the xdebug-extension repository
  2. Run the build.sh file
  3. Click on "This Firefox"
  4. Choose "Load Temporary Add-on…"
  5. Select the xdebug-extension@[version].xpi file in the xdebug-extension/build directory.

Prebuilt

  1. Download the latest xpi file from releases e.g [email protected]
  2. Click on "This Firefox"
  3. Choose "Load Temporary Add-on…"
  4. Select the xdebug-extension@[version].xpi file you downloaded in step one.

Edge

Available in Microsoft Edge Addons

From source

  1. Clone the xdebug-extension repository
  2. Go to edge://extensions/
  3. Turn on "Developer Mode"
  4. Choose "Load unpacked"
  5. select the src directory inside the xdebug-extension directory you downloaded in step one.

Usage

Once installed, you can:

  • Toggle the popup with (default: Alt+X) or by clicking the extension icon.
  • Toggle debugging with a shortcut (default: Alt+C) or from the popup menu.
  • Toggle profiling with a shortcut (default: Alt+V) or from the popup menu.
  • Toggle tracing with a shortcut (default: Alt+B) or from the popup menu.
  • Click the extension icon to open the popup menu and select a debugging state: Debug, Profile, Trace, or Disable.
  • Clink the "options" link in the popup to configure the IDE key, profile trigger, and trace trigger. Alternatively, right click the extension icon and choose "Options".

Custom shortcuts

Chrome

  1. shortcuts can be configured via chrome://extensions/shortcuts

chrome-extensions-shortcuts

FireFox

  1. Click the menu button
  2. Click Add-ons and themes
  3. Select Extensions.
  4. Click the Tools for all add-ons cogwheel.
  5. Click Manage Extension Shortcuts in the menu.

firefox-extensions/shortcuts

Edge

  1. shortcuts can be configured via edge://extensions/shortcuts

edge-extensions-shortcuts

Contributing

If you want to contribute and make it even better, feel free to fork the repository and submit a pull request. Your contributions are always welcome!

License

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

Icons

debug Freepik

trace rukanicon

profile UIcons