【VSCode】rubocopの警告をエディター上に表示させる

Rubyでよくない書き方をしていたときに、その部分に警告を出してくれるツールです。

静的コード解析ツールと言ったりします。

rubocopのおかげで書き方を統一できたりコードを見やすくできたり利点が盛りだくさんです。

よくない書き方の例はこちらのgithubで確認できます。

VSCodeでRubyを書くならこれ！

みたいなRuby 拡張機能があったのですでに入れていて、この拡張機能のおかげでrubocopは使えていました！

...これで終わりならいいんですが、デフォルトのrubocopだとなんせコードの制約が厳しい。

ちょこっと制限をゆるくしたいなぁなんて考えて設定方法を調べてましたが見つかりませんでした。

Ruby 拡張機能では無理そうだったんでruby-rubocop拡張機能をインストールすることにしました。

こちらはVSCodeでrubocopを使用するための拡張機能です。

インストールはVSCodeの下記画像の場所からいけます。

検索窓に ruby って打ったら出てくると思います。

rubocopの制限をゆるめるためには .rubocop.yml というファイルを設定してあげる必要があります。

command + , で設定を開きます。(Macの場合)

∨拡張機能があるのでそのなかの

Ruby-Rubocop configuration を確認しましょう。

Config File Path とあり、こちらで.rubocop.ymlファイルを指定できます。

基本的にはプロジェクトのルートディレクトリに置いておくようです。

/Users/username/project/.rubocop.yml

みたいな感じで書いておきます。

あと、On Saveをチェックすると保存時にrubocopが走るようになります。

Config File Path に指定したパスと同じになるように .rubocop.yml という名前のファイルを作成します。

作成したら下記のコードをコピペして保存します。

これは日本語のコメント

を許可するためのコードです。

# 日本語のコメントを許可する

Style/AsciiComments:

Enabled: false

これで制限を緩めるための作業は終わりです！

いくつか設定例を探してみました。

そのまま使用しても必要そうな部分をピックして使用するのもよいと思います。