@prettier/plugin-ruby
is a prettier plugin for the Ruby programming language. prettier
is an opinionated code formatter that supports multiple languages and integrates with most editors. The idea is to eliminate discussions of style in code review and allow developers to get back to thinking about code design instead.
Under the hood @prettier/plugin-ruby
uses Ruby's own ripper
library which allows this package to maintain parity with the existing Ruby parser. @prettier/plugin-ruby
supports Ruby versions 2.5
, 2.6
, and trunk
.
For example, the below code segment:
d=[30644250780,9003106878,
30636278846,66641217692,4501790980,
671_24_603036,131_61973916,66_606629_920,
30642677916,30643069058];a,s=[],$*[0]
s.each_byte{|b|a<<("%036b"%d[b.
chr.to_i]).scan(/\d{6}/)}
a.transpose.each{ |a|
a.join.each_byte{\
|i|print i==49?\
($*[1]||"#")\
:32.chr}
puts
}
when run through @prettier/plugin-ruby
will generate:
d = [
30644250780,
9003106878,
30636278846,
66641217692,
4501790980,
671_24_603036,
131_61973916,
66_606629_920,
30642677916,
30643069058
]
a, s = [], $*[0]
s.each_byte { |b| a << ('%036b' % d[b.chr.to_i]).scan(/\d{6}/) }
a.transpose.each do |a|
a.join.each_byte { |i| print i == 49 ? ($*[1] || '#') : 32.chr }
puts
end
First, your system on which you're running is going to need a couple of things:
ruby
2.5
or newer - there are a lot of ways to installruby
, but I recommendrbenv
node
8.3
or newer -prettier
is a JavaScript package, so you're going to need to installnode
to work with itnpm
oryarn
- these are package managers for JavaScript, either one will do
Second, you're going to need to list @prettier/plugin-ruby
as a JavaScript dependency from within whatever project on which you're working.
If you do not already have a package.json
file in the root of your repository, you can create one with:
echo '{ "name": "My Project" }' > package.json
After that you can add prettier
and @prettier/plugin-ruby
to your package.json
's devDependencies
by running npm install --save-dev prettier @prettier/plugin-ruby
if you are using npm
or yarn add --dev prettier @prettier/plugin-ruby
if you are using yarn
.
Now, you can run prettier
to tidy up your ruby
files! Verify by running against one single file:
./node_modules/.bin/prettier --write path/to/file.rb
If you're happy, you can can run prettier
on an entire codebase:
./node_modules/.bin/prettier --write '**/*.{rb,rake}'
Note that you can also install prettier
globally with npm install -g prettier
or you can add ./node_modules/.bin
to your $PATH
so you don't need to reference the executable from the directory each time.
Below are the options (from src/ruby.js
) that @prettier/plugin-ruby
currently supports:
Name | Default | Description |
---|---|---|
printWidth |
80 |
Same as in Prettier (see prettier docs). |
requirePragma |
false |
Same as in Prettier (see prettier docs). |
tabWidth |
2 |
Same as in Prettier (see prettier docs). |
addTrailingCommas |
false |
Adds a trailing comma to array literals, hash literals, and method calls. |
inlineConditionals |
true |
When it fits on one line, allows if and unless statements to use the modifier form. |
inlineLoops |
true |
When it fits on one line, allows while and until statements to use the modifier form. |
preferHashLabels |
true |
When possible, uses the shortened hash key syntax, as opposed to hash rockets. |
preferSingleQuotes |
true |
When double quotes are not necessary for interpolation, prefers the use of single quotes for string literals. |
Any of these can be added to your existing prettier configuration file. For example:
{
"preferSingleQuotes": false
}
Or, they can be passed to prettier
as arguments:
./node_modules/.bin/prettier --prefer-single-quotes false --write '**/*.{rb,rake}'
Check out our contributing guide. Bug reports and pull requests are welcome on GitHub at https://github.com/prettier/plugin-ruby.
The package is available as open source under the terms of the MIT License.
Thanks goes to these wonderful people (emoji key):
Kevin Deisz 💻 📖 🚧 👀 | Alan Foster 💻 📖 👀 | johnschoeman | Aaron Jensen 📖 | Cameron Bothner 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!