joshuaswilcox / sublime_debugger

Interactive debugger for sublime

SublimeRubyDebugger

debugger plugin for interactive ruby and RoR debugging on Sublime Text.

By Shuky chen, Based Debugger gem and Byebug gem.

Overview

• First Steps
• Features
• Soon
• Commands
• Installation
• Troubleshoot
• License
• Todos
• Screen Shots

First steps

In order to start debugging ruby or RoR applications all you need to do

is to install Debugger plugin and press on F6 or Shift+F6 or Alt+Shift+F6

Features

• Local debugging Ruby and RoR applications.
• Stepping up, down ,over and into while debugging (jumps and goto also available).
• Add watch expression and run immediate code using the current program context.
• Monitoring on stack, threads, output and local variables in the program.
• Builtin rails support.
• Breakpoints, conditional breakpoints and temporary breakpoints (goto) support.
• Works on Sublime Text 2 and 3.
• MRI 1.9.3 support (using debugger gem).
• MRI 2.0.0 support (using byebug gem).
• Linux, Window, OSX support

Soon

• Edit and remove watch expressions

Commands

Here is a complete list of commands you can find Command Pallette under the Debugger namespace or in the menu under Tools / Debugger:

Start/Stop debugging session

• Start Debugging - F6
• Start Debugging Rails - Shift+F6
• Start Debugging (Current file) - Alt+Shift+F6
• Pause Debugger - Alt+d, b
• Stop Debugging - Alt+d, k

Breakpoints

• Toggle Breakpoint - F9
• Toggle Conditional Breakpoint - Shift+F9
• Clear Breakpoints - Alt+Shift+F9

Cursor control

• Step Over - F10
• Step Into - F11
• Step up - - Alt+d, u
• Step down - - Alt+d, d
• Continue - F8
• Run To Line (goto) - ctrl+F10 or ⌘+F10
• Jumo to line - Ctrl+Shift+F10 or ⌘+Shift+F10

Expressions commands

• Run expression (evaluate) - F7
• Add watch expression - Alt+d, w
• Send input (to stdin) - Alt+d, i

Layout commands

• Show debug windows - Alt+l, s
• Hide debug windows - Alt+l, h

Installation

Gem dependencies

Ruby 1.9.3

Run command gem install debugger

Ruby 2.0.0

Run command gem install byebug --version '>=2.5.0'

Sublime Ruby Debugger

Package Control

Execute "Package Control: Install Package" in the Command Pallette to retrieve a list of available packages. Search in the list and install package Ruby Debugger.

Git

Clone the repository by executing the following command in your Packages directory: git clone https://github.com/shuky19/sublime_debugger.git "Ruby Debugger"

Download

Get the latest source from GitHub and extract the source into your Packages directory to a folder named "Ruby Debugger".

Note: You can locate your Packages directory in the menu under Preferences / Browse Packages...

Troubleshoot

Why do i get on the output window "Errno::EADDRINUSE: Address already in use - bind(2)"?

Thats because there is another process running on your OS who is using the port 8989/8990

Another option is that the last debugger process is still alive (killall ruby will solve that)

License

SublimeTextXdebug is released under the MIT License.

Todo

• Settings file
• Break point windows updates
• Set view cursor on debug cursor change
• Nice message when port is taken
• Document & Refacor
• Ruby 1.8.7 support

Screen Shots