BeautifyRuby
Sublime Text plugin that automatically formats Ruby and ERB files using Ruby scripts.
What is BeautifyRuby?
BeautifyRuby is a Sublime Text plugin that automatically formats Ruby and ERB files to improve code style and readability. It uses Ruby scripts and the htmlbeautifier gem to reformat code according to configurable rules, integrating directly into the editor's workflow. The plugin solves the problem of inconsistent formatting in Ruby projects by providing automated, customizable beautification.
Ruby developers using Sublime Text who want to maintain consistent code style in Ruby, ERB, Rakefile, and Gemfile files without manual formatting.
Developers choose BeautifyRuby for its tight integration with Sublime Text, support for both manual and automatic formatting, and flexibility in configuring Ruby interpreters and formatting rules. It leverages established Ruby gems for reliable formatting while offering project-specific customization.
Overview
Sublime Text 2 & 3 Plugin to Beautify Ruby
Use Cases
Best For
- Automatically formatting Ruby code before saving in Sublime Text
- Enforcing consistent indentation and spacing in ERB templates
- Integrating code beautification into a Sublime Text-based Ruby workflow
- Managing formatting for projects using RVM or custom Ruby environments
- Improving readability of Rakefiles and Gemfiles with standardized formatting
- Applying project-specific formatting rules across Ruby and HTML.erb files
Not Ideal For
- Projects using IDEs or editors other than Sublime Text, such as VS Code or Vim
- Teams requiring formatting for multiple languages beyond Ruby and ERB (e.g., JavaScript or CSS)
- Developers seeking integrated linting with advanced style rules like RuboCop
- Environments where code formatting must be enforced via CI/CD pipelines rather than editor plugins
Pros & Cons
Pros
Seamlessly integrates into Sublime Text with keyboard shortcuts (e.g., Ctrl+Cmd+K) and pre-save hooks, allowing on-demand or automatic formatting without leaving the editor.
Configurable to work with system Ruby, RVM-managed rubies, and Windows Subsystem for Linux, as detailed in the interpreter settings, accommodating diverse development environments.
Offers both manual formatting via shortcuts and automatic pre-save beautification by setting 'run_on_save': true, streamlining code consistency during development.
Users can define which files trigger beautification through 'file_patterns' and 'html_erb_patterns' settings, enabling project-specific formatting rules for Ruby and ERB files.
Allows configuration of tabs vs. spaces and tab size via Sublime Text settings, providing essential style adjustments to match team preferences.
Cons
Relies on the htmlbeautifier gem being manually installed in the Ruby environment, and error messages can be misleading, as the README warns about 'check your ruby interpreter settings' not always indicating the real issue.
Configuring Ruby interpreters, especially with RVM or WSL, requires manual steps like setting 'ruby': '~/.rvm/bin/rvm-auto-ruby', which can be error-prone and confusing for users unfamiliar with these tools.
Only functions within Sublime Text, making it unsuitable for developers using other editors or seeking cross-platform formatting solutions.
Focuses on beautification with limited advanced options, lacking integration with comprehensive style guides or linters, which may not suffice for teams enforcing strict coding standards.
Frequently Asked Questions
Related Projects
Sublime Text setupSublime Text 2 setup used in the Ruby on Rails Tutorial
Sublime Ruby DebuggerInteractive debugger for sublime
ChangeQuotesConverts single and double quotes, and re-escapes quotes within the string
RSpec pluginSublime Text plugin for RSpec BDD Framework
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.