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
  • 7 months ago
  • 25 minutes ago
  • 9 years ago

Installs

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

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