🌊

[Rails7]annotaition gem追加

2024/02/12に公開

annotaitionとは

各モデルのスキーマ情報をファイルの先頭もしくは末尾にコメントアウトとして書き出してくれるGem
どんなカラムあったっけ?となった際にdb/schema.rbを確認する手間が省くことができる・
さらに、config/route.rbにリーティング情報を書き出してくれる機能がある。

準備

Gemfileに下記を記述し、bundle installを実行

gem 'annotate'

設定ファイルの作成

以下のコマンドを実行すると、lib/tasks/auto_annotate_models.rakeが作成される。
これで、次回のマイグレーション移行で自動でアノテーションが追記される。

bundle exec rails g annotate:install

モデルの作成

モデルの作成コマンド

$ rails g model comment board:references name:string comment:text
$ rails db:migrate

board:references
Boardモデルと紐付けるためのboard_idカラムを作成する
``

Discussion