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

Rubyfmt

Sublime plugin to autoformat Ruby code with Rubyfmt

Details

Installs

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

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