# SublimeTextXdebug
Xdebug debugger client integration for Sublime Text.
Based on the Xdebug protocol functionality in [SublimeXdebug](https://github.com/Kindari/SublimeXdebug) package by [Kindari](https://github.com/Kindari).
[![Build Status][travis-badge]][travis-link] [![Package Control][package-control-badge]][package-control-link] [![MIT License][license-badge]][license-link]
## Overview
* [Features](#features)
* [Commands](#commands)
* [Installation](#installation)
* [Xdebug](#xdebug)
* [Configuration](#configuration)
* [Troubleshoot](#troubleshoot)
* [License](#license)
## Features
* Remote debugging by configuring path mapping
* Navigate on breakpoint hit to relevant file on specific line, when found on local drive
* Customizable debugging layout for displaying stack history and context variables with syntax
* Overview of breakpoints in all files and disable/enable breakpoints with simple click
* Evaluate code within the current execution context, by setting watch expressions
* Inspect (nested) context variables
* Works on both Sublime Text 2 __and__ 3
## Commands
Here is a complete list of commands you can find Command Palette under the `Xdebug` namespace or in the menu under `Tools / Xdebug`:
#### Start/Stop debugging session
* Start Debugging - Ctrl+Shift+F9 or ⌘+Shift+F9
* Start Debugging (Launch Browser)
* Restart Session
* Stop Debugging - Ctrl+Shift+F10 or ⌘+Shift+F10
* Stop Debugging (Launch Browser)
* Stop Debugging (Close Windows)
*__Launch Browser__ menu option will only show if you have an url configured within [settings](#configuration).*
#### Breakpoints
* Add/Remove Breakpoint - Ctrl+F8 or ⌘+F8
* Set Conditional Breakpoint - Shift+F8
* Clear Breakpoints
* Clear All Breakpoints
#### Watch expressions
* Set Watch Expression
* Edit Watch Expression
* Remove Watch Expression
* Clear Watch Expressions
#### Session commands
* Evaluate
* Execute
* Status
#### Continuation commands
* Run - Ctrl+Shift+F5 or ⌘+Shift+F5
* Run To Line
* Step Over - Ctrl+Shift+F6 or ⌘+Shift+F6
* Step Into - Ctrl+Shift+F7 or ⌘+Shift+F7
* Step Out - Ctrl+Shift+F8 or ⌘+Shift+F8
* Stop
* Detach
#### Other
* Restore Layout / Close Windows - Ctrl+Shift+F11 or ⌘+Shift+F11
* Settings - Default
* Settings - User
## Installation
#### [Package Control](http://wbond.net/sublime_packages/package_control)
Execute __"Package Control: Install Package"__ in the Command Palette to retrieve a list of available packages.
Search in the list and install package `Xdebug Client`.
#### Git
Clone the repository by executing the following command in your Packages directory:
```bash
git clone https://github.com/martomo/SublimeTextXdebug.git "Xdebug Client"
```
#### Download
Get the latest [source from GitHub](https://github.com/martomo/SublimeTextXdebug/archive/master.zip) and extract the source into your Packages directory.
*__Note:__ You can locate your Packages directory in the menu under* `Preferences / Browse Packages...`
## Xdebug
In order to be able to debug your PHP scripts, you will need have Xdebug extension installed on your server.
[See here for installation instructions](http://xdebug.org/docs/install)
Below is a configuration template for php.ini/xdebug.ini, be warned if you are on a Live environment, __remote\_connect\_back__ allows every debug request from any source to be accepted.
```ini
[xdebug]
zend_extension = /absolute/path/to/your/xdebug-extension.so
;zend_extension = "C:\Program Files (x86)\PHP\ext\php_xdebug.dll"
xdebug.remote_enable = 1
xdebug.remote_host = "127.0.0.1"
xdebug.remote_port = 9000
xdebug.remote_handler = "dbgp"
xdebug.remote_mode = req
xdebug.remote_connect_back = 1
```
For details about all available settings for configuring Xdebug, see [here](http://xdebug.org/docs/all_settings).
## Configuration
The following settings can be configured in Xdebug.sublime-settings or in \*.sublime-project files:
*__path\_mapping__*
For remote debugging to resolve the file locations it is required to configure the path mapping with the server path as key and local path as value.
*__url__*
Determine which URL to launch in the default web browser when starting/stopping a session.
*__ide\_key__*
An IDE key is used to identify with debugger engine when Sublime Text will start or stop a debugging session.
_This package does not filter sessions by IDE key, it will accept any IDE key, also ones that do not match this configured IDE key. It is merely used when launching the default web browser with the configured URL._
*__host__*
Host address of network interface which Sublime Text should listen to connect with debugger engine.
_When specifying host address of network interface, be sure to specify an IPv4 address as Sublime Text will listen for connections through an IPv4 socket._
*__port__*
Which port number Sublime Text should listen to connect with debugger engine.
*__max\_children__*
Maximum amount of array children and object's properties to return.
*__max\_data__*
Maximum amount of variable data to initially retrieve.
*__max\_depth__*
Maximum amount of nested levels to retrieve of array elements and object properties.
*__break\_on\_start__*
Break at first line on session start, when debugger engine has connected.
*__break\_on\_exception__*
Break on exceptions, suspend execution when the exception name matches an entry in this list value.
*__close\_on\_stop__*
Always close debug windows and restore layout on session stop.
*__super\_globals__*
Show information about super globals in context view.
*__fullname\_property__*
Display property by fullname in context view.
*__hide\_password__*
Do not show possible password values in context view.
*__pretty\_output__*
Render evaluated result as parsed output instead of raw XML.
*__launch\_browser__*
Always launch browser on session start/stop.
*This will only work if you have the '__url__' setting configured.*
*__browser\_no\_execute__*
When launching browser on session stop do not execute script.
By using parameter XDEBUG\_SESSION\_STOP\_NO\_EXEC instead of XDEBUG\_SESSION\_STOP.
*__disable\_layout__*
Do not use the debugging window layout.
*__debug\_layout__*
Window layout that is being used when debugging.
*__breakpoint\_group__*
*__breakpoint\_index__*
*__context\_group__*
*__context\_index__*
*__stack\_group__*
*__stack\_index__*
*__watch\_group__*
*__watch\_index__*
Group and index positions for debug views.
*__breakpoint\_enabled__*
*__breakpoint\_disabled__*
*__breakpoint\_current__*
*__current\_line__*
Custom gutter icons for indicating current line or enabled/disabled breakpoints.
_Do not use same icon for above values, because Sublime Text is unable to use the same icon for different scopes, in case there are duplicate icons detected it will fall back to the corresponding icon in the package._
*__python\_path__*
Path to Python installation on your system.
Which is being used to load missing modules.
*__debug__*
Show detailed log information about communication between debugger engine and Sublime Text.
---
Below are examples how to configure your Xdebug.sublime-settings and \*.sublime-project files.
__Xdebug.sublime-settings__
```json
{
"path_mapping": {
"/absolute/path/to/file/on/server" : "/absolute/path/to/file/on/computer",
"/var/www/htdocs/example/" : "C:/git/websites/example/"
},
"url": "http://your.web.server/index.php",
"super_globals": true,
"close_on_stop": true
}
```
__\*.sublime-project__
```json
{
"folders":
[
{
"path": "..."
}
],
"settings":
{
"xdebug": {
"path_mapping": {
"/absolute/path/to/file/on/server" : "/absolute/path/to/file/on/computer",
"/var/www/htdocs/example/" : "C:/git/websites/example/"
},
"url": "http://your.web.server/index.php",
"super_globals": true,
"close_on_stop": true
}
}
}
```
## Troubleshoot
#### Can I have both [SublimeTextXdebug](https://github.com/martomo/SublimeTextXdebug) and [SublimeXdebug](https://github.com/Kindari/SublimeXdebug) installed?
No. Having installed both packages can cause conflicts, because they might both listen to the same port for a debugger engine response and have similar keymapping.
However (project) settings from SublimeXdebug are compatible with SublimeTextXdebug.
#### How can I start a debugging session?
SublimeTextXdebug can [start or stop a debugging session](#startstop-debugging-session) by launching the default web browser with the configured URL and parameter `XDEBUG_SESSION_START` or `XDEBUG_SESSION_STOP` which uses the configured IDE key as value. By default the IDE key is `sublime.xdebug`.
When you do not configure the URL, the plugin will still listen for debugging connections from Xdebug, but you will need to trigger Xdebug [for a remote session](http://xdebug.org/docs/remote#starting).
If you want to run a start a debugging session from command line, before you run your script, you will need to set the environment variable __XDEBUG\_CONFIG__ with the IDE key.
__Windows__
```bash
set XDEBUG_CONFIG="idekey=sublime.xdebug"
php myscript.php
```
__UNIX__
```bash
export XDEBUG_CONFIG="idekey=sublime.xdebug"
php myscript.php
```
Make sure before defining the environment variable you have switched to the proper user environment.
As example you would set the environment variable as __guest__ and execute the script as __root__ _(sudo)_, then __root__ will not have the environment variable XDEBUG\_CONFIG that was defined by __guest__.
#### How do I set a breakpoint and/or watch expression?
With SublimeTextXdebug you can easily [add/remove breakpoints](#breakpoints), which are send on session start.
Or [set/edit/remove watch expressions](#watch-expressions), that are evaluated in the current execution context.
Setting a conditional breakpoints or watch expressions is quite easy, it is like an __if__ statement in PHP.
As example you only want to stop on breakpoint when value of __$number__ is equal to __13__, then your __Breakpoint condition__ would be `$number==13`.
Another example would be when you would like to know the value of __$item['image']__ on each break, then your __Watch expression__ would be `$item['image']`.
Another way is to set the breakpoint in your PHP code with the following function [`xdebug_break()`](http://xdebug.org/docs/remote#xdebug_break).
#### How to configure or disable breaking on exceptions?
By default the execution of a debugging session is suspended on each of the following exception names:
* __"Fatal error"__ \- E\_ERROR, E\_CORE\_ERROR, E\_COMPILE\_ERROR, E\_USER\_ERROR
* __"Catchable fatal error"__ \- E\_RECOVERABLE\_ERROR (since PHP 5.2.0)
* __"Warning"__ \- E\_WARNING, E\_CORE\_WARNING, E\_COMPILE\_WARNING, E\_USER\_WARNING
* __"Parse error"__ \- E\_PARSE
* __"Notice"__ \- E\_NOTICE, E\_USER\_NOTICE
* __"Strict standards"__ \- E\_STRICT
* __"Deprecated"__ \- E\_DEPRECATED, E\_USER\_DEPRECATED (since PHP 5.3.0)
* __"Xdebug"__
* __"Unknown error"__
In order to specify which exception names to suspend the execution of a debugging session, configure the `break_on_exception` setting with a list of the specific exception names by choice from the list shown above.
It is also possible to specify custom exceptions instead of __all__ exceptions (__"Fatal error"__). For example if you would configure __"MissingArgumentException"__ instead of __"Fatal error"__, it would not break on __"InvalidParameterException"__.
To disable breaking on exceptions either configure an empty list `break_on_exception: []` or set as `break_on_exception: false`.
#### How can I customize/disable the debugging layout?
Re-adjust the layout in Sublime Text to your liking and then in console (Ctrl+\`) you type `window.get_layout()` and set that value as your `debug_layout`.
Further customizing can be done by assigning the Xdebug views to a group/index with the `breakpoint_group`, `breakpoint_index`, `context_group`, `context_index`, `stack_group`, `stack_index`, `watch_group`, `watch_index` settings.
Or you can disable the debugging layout by setting `disable_layout: true`, which will open all Xdebug views in current active group/window on session start and does not change your layout.
#### How to solve `ImportError`?
Older versions of Sublime Text do not come with Python bundled and rely on your Python system installation.
Some systems do not include specific modules which are required by this package, such as __pyexpat__.
Configure the `python_path` setting to the path of your Python installation on your system which is either newer or has all required modules. For example: `"python_path" : "/usr/lib/python2.7"`.
#### What to do when you experience any issues?
First check following _possible_ solutions that could resolve any issues:
- Use __absolute__ paths in your `path_mapping` setting, Xdebug does not return symbolic links.
- Breakpoint is on an empty line, Xdebug does not stop on empty lines.
- Set `port` and [xdebug.remote_port](http://xdebug.org/docs/all_settings#remote_port) to different port *(9001)*, default port 9000 might already be used by an other application.
- Add an exception for Sublime Text *(plugin_host.exe)* to your firewall, response from Xdebug could be blocked by firewall.
- Lower the `max_data`/`max_depth`/`max_children` settings to increase response speed or prevent crashing, Xdebug could return to much data to process.
- Change permissions for Sublime Text and it's packages on your filesystem, Sublime Text or package might not have valid rights.
Do you still experience any issues, then [create an issue](https://github.com/martomo/SublimeTextXdebug/issues/new) including the following data:
- What operating system(s) and version of Sublime Text are you using?
- How did you [install](https://github.com/martomo/SublimeTextXdebug#installation) SublimeTextXdebug, Package Control, git clone or download?
- Are you trying to debug the script remotely or locally, through browser or command line?
- Which version of Xdebug extension do you have?
- Can you post your [project/settings file](https://github.com/martomo/SublimeTextXdebug#configuration) and [Xdebug configuration](https://github.com/martomo/SublimeTextXdebug#xdebug) from the \*.ini located on your server.
- Does the console window (Ctrl+\`) show any more information regarding the error?
## License
SublimeTextXdebug is released under the [MIT License][license-link].
[travis-badge]: https://travis-ci.org/martomo/SublimeTextXdebug.svg?branch=master
[travis-link]: https://travis-ci.org/martomo/SublimeTextXdebug
[package-control-badge]: https://img.shields.io/packagecontrol/dt/Xdebug%20Client.svg
[package-control-link]: https://packagecontrol.io/packages/Xdebug%20Client
[license-badge]: https://img.shields.io/badge/license-MIT-007EC7.svg
[license-link]: LICENSE