Skip to content

aflc/BeautifyRuby

 
 

Repository files navigation

BeautifyRuby

Known Issue

When enabling run_on_save and save_on_focus_lost

If you have two files open and one of them has unsaved changes, if you switch from the file with changes to the file without changes, the file's content without changes will be copied into the file that has changes.

Beautifies Ruby code. This plugin uses the Ruby Script Beautifier written by P.Lotus

I made very little modification to get it to work with a Sublime Text 2 plugin.

Erb html templates uses Paul Battley's htmlbeautifier gem. This (as well as rubygems) is assumed to be installed as seen by the ruby interpreter.

This package offers a pre-save hook, i.e., your ruby and erb files will be reformatted automatically before saving. To activate this feature, set:

"run_on_save": true,

The sublime command "beautify_ruby" performs a save after formatting. You can disable this default by setting:

"save_on_beautify": false

You can change the file patterns handled by this plugin in the settings:

"file_patterns": [ "\\.html\\.erb", "\\.rb", "\\.rake", "Rakefile", "Gemfile" ],

Key Binding

  ctrl + cmd + k on OS X, or ctrl + alt + k on Windows

If your file turns blank you can configure your ruby interpreter under Preferences -> Package Settings -> BeautifyRuby -> Settings Default

I do

  which ruby

and place that in the ruby setting.

On windows, set Preferences -> Package Settings -> BeautifyRuby -> Settings Default

  "ruby": "ruby"

If you use project-specific rubies and gem sets managed with rvm, then simply set

  "ruby": "~/.rvm/bin/rvm-auto-ruby",

and then the htmlbeautifier gem is found even if it is only installed for this project.

Installation

Package Control

Using Package Control, a package manager for Sublime Text 2.

In ST2, press "cmd + shift + p" and then type "install".

Once you see "Package Control: Install Package", enter.

When the packages load, another selection window will appear. Type

BeautifyRuby and enter. All done!

Manual Installation

  cd "~/Library/Application Support/Sublime Text 2/Packages/"
  git clone git://github.com/CraigWilliams/BeautifyRuby.git

About

Sublime Text 2 & 3 Plugin to Beautify Ruby

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published