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
Feb 29 Feb 28 Feb 27 Feb 26 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
Windows 0 0 0 0 0 0 1 2 0 0 1 0 0 1 2 0 1 1 0 3 2 0 2 0 0 0 0 1 1 0 1 0 0 0 1 0 0 1 2 0 0 2 0 1 2 1
Mac 0 1 0 0 0 2 0 1 3 1 4 0 0 0 0 1 0 0 0 0 2 0 0 2 2 0 0 0 0 4 4 2 0 0 1 0 1 1 0 0 0 0 4 0 2 1
Linux 0 0 3 3 0 0 0 0 1 1 0 0 0 0 0 0 0 0 1 0 0 1 1 0 0 1 0 0 0 0 2 0 0 0 3 0 1 0 0 0 0 1 0 1 0 0

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