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

Rubyfmt

Sublime plugin to autoformat Ruby code with Rubyfmt

Details

Installs

  • Total 5K
  • Win 2K
  • Mac 2K
  • Linux 1K
May 29 May 28 May 27 May 26 May 25 May 24 May 23 May 22 May 21 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
Windows 0 1 0 0 0 1 0 0 0 0 0 0 1 0 2 0 0 1 0 0 0 0 0 1 0 2 0 0 1 1 0 0 0 0 0 1 1 0 0 0 0 0 0 1 0
Mac 0 1 1 0 0 1 1 0 0 0 1 1 1 0 1 0 0 0 0 0 0 2 1 0 0 1 2 0 0 1 0 0 0 1 2 0 0 0 0 2 1 1 0 0 2
Linux 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 1 2 2 0 1 0 0 0 0 0 0 0 0 0 1

Readme

Source
raw.​githubusercontent.​com

sublime-rubyfmt

Sublime text plugin to autoformat Ruby code with Rubyfmt. If the file contains syntax errors it won't be formatted and the error is displayed in the Sublime status bar at the bottom of the editor window.

Dependencies

A ruby and rubyfmt executable is assumed to be in path but this can be overriden with absolute paths in the package settings ("ruby_executable" and "rubyfmt_executable" respectively).

Plugin installation

Through Sublime Package Control: Install Package -> Rubyfmt

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 enabled by default but can be disabled from Sublime Text -> Preferences -> Package Settings -> Rubyfmt -> Settings - User and adding {"format_on_save: false"}.

All settings with default values:

{
  "ruby_executable": "ruby",
  "rubyfmt_executable": "rubyfmt",
  "format_on_save": true,
}

Troubleshooting

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