#【Rails Gem】 Rubocopの除外設定 <missing top-level class documentation comment ><# frozen_string_literal: true>

#【Rails Gem】 Rubocopの除外設定

Rubocopのデフォルトのアラートを一部無効にする設定を行ったので、
そのときの手順をまとめます。

目次

• 動作環境
• やりたいこと
• 手順
  • .rubocop.ymlの作成
  • .rubocop.ymlの編集

---

動作環境

OS : macOS Mojave 10.14.6
ruby : 2.6.5
rails : 5.2.4
rubocop-0.82.0 : global(開発用PC)にインストールしています

やりたいこと

rubocopによる自動フォーマットを利用していますが以下の理由によりアラート・自動整形のデフォルト設定を変更します。

1. missing top-level class documentation commentという
   アラートが何度も出るため、このアラートをオフにすること.

2.frozen_string_literal: trueが全てのファイルの先頭に記載されるため、
この設定をオフにすること.

手順

Rubocopのインストール手順は省略します。

.rubocop.ymlの作成

.rubocop.ymlをユーザのホームディレクトリに作成します.

Terminal

$ pwd
/Users/xxxx
$ touch .rubocop.yml

.rubocop.ymlの編集

viで.rubocop.ymlを開きます。

$ vi .rubocop.yml

missing top-level class documentation commentの除外設定

そして以下のコードを追加します。

.rubocop.yml

#追加
Documentation:
  Enabled: false

frozen_string_literal: trueが付かないようにする

またfrozen_string_literal: trueには以下のコードを追加します.

.rubocop.yml

#追加
Style/FrozenStringLiteralComment:
  Enabled: false

*補足

Ruby3.0では文字列は変更不可(イミュータブル)な文字列に移行する計画があります。
ただRuby2.2では文字列のデフォルトが変更可(ミュータブル)のため、
Ruby3.0への移行を支援するため、frozen_string_literal: trueをつけることで文字列をイミュータブルにすることができるようです。
詳細はこちらの記事になります。
https://qiita.com/gipcompany/items/256a36ac727025f8f525

最後に.rubocop.ymlを保存して終了し、VS codeを再起動して確認します。

.rubocop.yml(最終版)

Style/FrozenStringLiteralComment:
  Enabled: false
Documentation:
  Enabled: false