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

Rubyfmt

Sublime plugin to autoformat Ruby code with Rubyfmt

Details

Installs

  • Total 3K
  • Win 1K
  • Mac 1K
  • Linux 898
Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7 Jun 6 Jun 5 Jun 4 Jun 3 Jun 2 Jun 1 May 31 May 30 May 29 May 28 May 27 May 26 May 25 May 24 May 23 May 22 May 21 May 20 May 19
Windows 1 0 0 0 0 0 1 0 0 1 1 0 1 1 0 1 0 0 1 2 0 0 0 2 0 2 0 0 0 0 1 0 1 0 0 0 1 1 1 0 0 0 0 0 2 0
Mac 0 2 1 4 4 2 1 0 0 1 1 2 0 1 0 1 2 2 0 0 2 1 0 1 1 1 0 0 1 1 1 1 0 0 0 1 1 1 1 0 2 0 0 0 1 5
Linux 0 0 1 2 0 0 1 0 0 2 0 0 0 0 2 2 0 4 0 0 1 0 1 1 0 0 1 0 0 0 1 0 1 1 0 1 0 0 1 1 1 0 0 0 2 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