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

Rubyfmt

by toreriklinnerud ST2/ST3

Sublime plugin to autoformat Ruby code with Rubyfmt

Details

Installs

  • Total 118
  • Win 44
  • OS X 45
  • Linux 29
May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1 Apr 30 Apr 29 Apr 28 Apr 27 Apr 26 Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7 Apr 6
Windows 0 3 0 3 0 1 2 1 1 1 2 2 0 1 0 3 4 2 1 1 1 2 0 4 0 1 2 3 2 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0
OS X 0 1 2 3 2 0 2 2 0 0 5 4 2 2 2 0 0 1 2 0 1 0 1 0 6 1 0 1 1 1 2 1 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 1 1 0 1 1 0 2 2 0 0 2 1 1 2 0 0 0 1 0 1 0 4 1 1 0 3 3 1 0 0 2 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

sublime-rubyfmt

Sublime text plugin to autoformat Ruby code with Rubyfmt

Dependencies

ruby and rubyfmt must already be installed and in your path:

$ which {ruby,rubyfmt}
/Users/tel/.rbenv/shims/ruby
/Users/tel/bin/rubyfmt

Plugin installation

Through Sublime Package Control: “ Tools -> Command Palette -> type: Install Package (enter) type: rubyfmt (enter)

or manually:

Download [Rubyfmt.sublime-package](https://github.com/toreriklinnerud/sublime-rubyfmt/releases/download/v0.1.0/Rubyfmt.sublime-package) and place in `Installed Packages` (not `Packages`). See [Sublime Packages docs](https://www.sublimetext.com/docs/3/packages.html).

## Formatting code

On Windows/Linux: `Alt + ;`  
On MacOS: `Cmd + ;`

With a file open and syntax set to Ruby or Ruby on Rails, hit the above combination to apply auto format.

If your file contains syntax errors it won't be formatted. The syntax error will briefly flash in the Sublime Text status bar at the bottom of the editor window.

## Format on Save / Other settings

Format on save is disabled by default but can be enabled from `Sublime Text -> Preferences -> Package Settings -> Rubyfmt -> Settings - User` and adding `{"format_on_save: true"}`.

See other settings available under `Settings - Default`.

## Troubleshooting

If execution of Ruby/Rubyfmt fails, debug information will be printed to the Sublime Text console: View -> Show Console