ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Beautify​Ruby

by CraigWilliams ALL

Sublime Text 2 & 3 Plugin to Beautify Ruby

Details

  • 2020.08.07.01.43.58
  • github.​com
  • github.​com
  • 3 months ago
  • 2 hours ago
  • 9 years ago

Installs

  • Total 65K
  • Win 16K
  • Mac 31K
  • Linux 18K
Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11
Windows 0 1 3 5 5 1 2 3 1 2 3 5 5 3 3 4 2 3 0 1 1 3 1 2 1 0 7 3 4 2 2 2 2 4 2 2 2 2 1 3 1 7 5 0 4 4
Mac 1 1 3 3 5 3 2 3 0 1 1 2 1 5 6 1 1 2 2 1 4 5 2 4 1 3 3 2 5 0 0 1 9 1 2 3 4 0 2 3 5 7 4 0 5 5
Linux 0 1 0 2 3 1 6 5 2 2 1 2 6 6 2 3 1 4 5 2 2 2 1 0 2 4 1 1 0 0 1 0 3 2 2 4 2 0 1 2 1 0 2 1 0 4

Readme

Source
raw.​githubusercontent.​com

Codeship Status for CraigWilliams/BeautifyRuby

BeautifyRuby

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. Note that if you beautify an erb file but htmlbeautifier is not found, the error message is 'check your ruby interpreter settings', do not be misled.

Interpreter settings

If an error is encountered while processing the file, Python receives an empty string and the following message is displayed but may have nothing to do with your Ruby settings.

check your ruby interpreter settings

Hooks

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" ],
"html_erb_patterns": ["\\.html\\.erb"],

This plugin uses ruby scripts to beautify your buffer, so it needs ruby installed. You can configure your ruby interpreter under Preferences -> Package Settings -> BeautifyRuby -> Settings Default/User click here for a screenshot. Although the default should work on linux and osx, not setting this right is a common problem.

If you do not use the system ruby, type in your favourite shell:

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.

If you are using ruby on the Windows Subsystem for Linux, use:

"ruby": "wsl ruby"

Tabs or Spaces

By default, Sublime does not translate tabs to spaces. If you wish to use tabs you will not need to change your settings. If you wish to use spaces, add the following setting.

"translate_tabs_to_spaces": true

Or if you wish to force the use of tabs use:

"translate_tabs_to_spaces": false

Tab size

Sublime's default tab_size is set to 4. Override this setting to change the number of spaces to use when using spaces instead of tabs.

"tab_size": 2

Key Binding

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

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