Skip to content

andyw8/plugin-ruby

Repository files navigation

prettier-ruby

Build Status

This is a prettier plugin for the Ruby programming language. Under the hood it uses Ruby's own ripper library which allows this package to maintain parity with the existing Ruby parser.

prettier-ruby supports Ruby versions 2.5, 2.6, and trunk.

Getting started

First, add prettier-plugin-ruby to your package.json dependencies, then install using either npm install or yarn install.

Verify by running against a file:

yarn prettier --write --plugin=prettier-plugin-ruby --parser=ruby app/controllers/application_controller.rb

If you're happy, you can can run prettier-plugin on an entire codebase:

yarn prettier --write --plugin=prettier-plugin-ruby --parser=ruby app/**/*.rb

Options

Below are the options (from src/ruby.js) that prettier-ruby currently supports:

  • inlineConditionals - When it fits on one line, allow if and unless statements to use the modifier form.
  • inlineLoops - When it fits on one line, allow while and until statements to use the modifier form.
  • preferHashLabels - When possible, use the shortened hash key syntax, as opposed to hash rockets.
  • preferSingleQuotes - When double quotes are not necessary for interpolation, prefer the use of single quotes for string literals.

Development

After checking out the repo, run yarn and bundle to install dependencies. Then, run yarn test to run the tests. You can pretty print a Ruby source file by running yarn print [PATH].

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kddeisz/prettier-ruby.

License

The gem is available as open source under the terms of the MIT License.

About

A prettier plugin for the Ruby programming language

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • JavaScript 65.3%
  • Ruby 34.7%