RailsプロジェクトにPrettierを導入してみた

目次

1. インストールと使い方
2. rubocopと合わせて使う
3. 参考文献

インストールと使い方

gem もしくは npm でインストールできるらしいですが
今回は gem でインストールすることにしました。

Gemfile

group :development do
  gem 'prettier'
end

bundle installでインストール完了

以下コマンドで実行

# フォーマット結果の確認
bundle exec rbprettier --check '**/*.rb'

# フォーマットして上書き保存する
bundle exec rbprettier --write '**/*.rb'

rubocopと合わせて使う

.rubocop.yml

# RubocopとPrettierが競合しないための記述
inherit_gem:
  prettier: rubocop.yml

参考文献

• prettier/plugin-ruby

QA

Q1. ESLintとどう違うの？

A2.

ESlint -> 解析のみ
Prettier -> フォーマットまでやってくれる
参考記事

Q2. rubocopの自動整形とどう違うか

A2.

rubyだけに閉じたPJであればrubocopのほうがprettierの定義ファイルは不要。
複数言語を扱うPJの場合にPrettierでフォーマッタを統一することも出来るのがメリット。