Prettier Ruby

Prettier for Ruby

Gitter GitHub Actions NPM Version code style: prettier Follow+Prettier+on+Twitter

`@prettier/plugin-ruby` is a [prettier](https://prettier.io/) plugin for the Ruby programming language and its ecosystem. `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. For example, the below [code segment](http://www.rubyinside.com/advent2006/4-ruby-obfuscation.html): ```ruby 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: ```ruby d = [ 30_644_250_780, 9_003_106_878, 30_636_278_846, 66_641_217_692, 4_501_790_980, 671_24_603036, 131_61973916, 66_606629_920, 30_642_677_916, 30_643_069_058 ] 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 ``` ## Getting started To run `prettier` with the Ruby plugin, you're going to need [`ruby`](https://www.ruby-lang.org/en/documentation/installation/) (version `2.7.3` or newer) and [`node`](https://nodejs.org/en/download/) (version `8.3` or newer). If you're integrating with a project that is not already using `prettier`, you should use the Ruby gem. Otherwise you can use the `npm` package directly. Note that currently the editor integrations work best with the `npm` package, as most of the major editor plugins expect a `node_modules` directory. You can get them to work with the Ruby gem, but it requires manually configuring the paths. This plugin currently supports formatting the following kinds of files: - All varieties of Ruby source files (e.g., `*.rb`, `*.gemspec`, `Gemfile`, etc.) - [RBS type language](https://github.com/ruby/rbs) files - requires having the `rbs` gem in your gem path - [HAML template language](https://haml.info/) files - requires having the `haml` gem in your gem path ### Ruby gem Add this line to your application's Gemfile: ```ruby gem "prettier" ``` And then execute: ```bash bundle ``` Or install it yourself as: ```bash gem install prettier ``` The `rbprettier` executable is now installed and ready for use: ```bash bundle exec rbprettier --write '**/*' ``` ### `npm` package If you're using the `npm` CLI, then add the plugin by: ```bash npm install --save-dev prettier @prettier/plugin-ruby ``` Or if you're using `yarn`, then add the plugin by: ```bash yarn add --dev prettier @prettier/plugin-ruby ``` You'll also need to add the necessary Ruby dependencies. You can do this by running: ```bash gem install bundler prettier_print syntax_tree syntax_tree-haml syntax_tree-rbs ``` The `prettier` executable is now installed and ready for use: ```bash ./node_modules/.bin/prettier --write '**/*' ``` ## Configuration Below are the options (from [`src/plugin.js`](src/plugin.js)) that `@prettier/plugin-ruby` currently supports: | API Option | CLI Option | Default | Description | | --------------- | ------------------ | :-----: | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `printWidth` | `--print-width` | `80` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width)). | | `requirePragma` | `--require-pragma` | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#require-pragma)). | | `rubyPlugins` | `--ruby-plugins` | `""` | The comma-separated list of plugins to require. See [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree#plugins). | | `tabWidth` | `--tab-width` | `2` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)). | | `singleQuote` | `--single-quote` | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#quotes)). | | `trailingComma` | `--trailing-comma` | `es5` | Almost same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#trailing-commas)). Will be on for any value except `none`. | Any of these can be added to your existing [prettier configuration file](https://prettier.io/docs/en/configuration.html). For example: ```json { "tabWidth": 4 } ``` Or, they can be passed to `prettier` as arguments: ```bash bundle exec rbprettier --tab-width 4 --write '**/*' ``` ### Usage with RuboCop RuboCop and Prettier for Ruby serve different purposes, but there is overlap with some of RuboCop's functionality. Prettier provides a RuboCop configuration file to disable the rules which clash. To enable, add the following config at the top of your project's `.rubocop.yml`: #### Ruby gem ```yaml inherit_gem: prettier: rubocop.yml ``` #### `npm` package ```yaml inherit_from: - node_modules/@prettier/plugin-ruby/rubocop.yml ``` ### Usage with an editor For [supported editor integrations](https://github.com/prettier/prettier/blob/main/website/data/editors.yml), you should follow the instructions for installing the integration, then install the npm version of this plugin as a development dependency of your project. For most integrations, that should be sufficient. For convenience, the instructions for integrating with VSCode are used as an example below: - Install the [Prettier - Code Formatter](https://github.com/prettier/prettier-vscode) extension. - Add the npm `@prettier/plugin-ruby` package to your project as described above. - Configure in your `settings.json` (`formatOnSave` is optional): ```json { "[ruby]": { "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.formatOnSave": true } } ``` Refer to [this issue](https://github.com/prettier/plugin-ruby/issues/113#issuecomment-783426539) if you're having difficulties. ## Contributing Check out our [contributing guide](CONTRIBUTING.md). Bug reports and pull requests are welcome on GitHub at https://github.com/prettier/plugin-ruby. You can support `prettier/plugin-ruby` [on OpenCollective](https://opencollective.com/prettier-ruby/contribute). Your organization's logo will show up here with a link to your website. ## License The package is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).