【Rails】View開発に役立つ「annotate_rendered_view_with_filenames」機能を使ってみる

こんにちは、千葉（@yoshi_chibaaa）です。

今回はRails6.1から追加された、Viewの呼び出し元を表示してくれる「annotate_rendered_view_with_filenames」を使ってみたので紹介したいと思います。開発環境でのみ使えるTips機能ですが、使う人にとっては便利な機能なのかなと思います。

この記事の内容

annotate_rendered_view_with_filenamesとは
使い方
まとめ
参考

annotate_rendered_view_with_filenamesとは

「annotate_rendered_view_with_filenames」とは、Viewの呼び出し元を開始タグと終了タグで表示してくれる機能になります。この機能はRails6.1で追加されました。

使い方

新規アプリケーションを作成しながら「annotate_rendered_view_with_filenames」機能を試してみます。

新規アプリケーションの作成

% rails new annotate-rendered-view-with-filenames-demo -d mysql
% cd query-log-tags-demo
% rails db:create

アプリケーション名: annotate_rendered_view_with_filenames
Ruby: 3.2.2
Rails: 7.0.8.3
DB: MySQL

annotate_rendered_view_with_filenamesの有効化

config/environments/development.rbにあるconfig.action_view.annotate_rendered_view_with_filenames = trueのコメントアウトを解除するだけで「annotate_rendered_view_with_filenames」機能が有効化されます。

Rails.application.configure do
  # 省略

  # Annotate rendered view with file names.
  config.action_view.annotate_rendered_view_with_filenames = true
end

UserのCRUDを作成

Sccafoldの機能を用いて、Userに関するCRUDを作成します。

% rails g scaffold User name:string name_kana:string
% rails db:migrate

【Rails】秒速でアプリケーション開発できるscaffoldの使い方を簡単にまとめてみた手っ取り早くアプリケーションを開発することができるscaffold（スキャフォールド）の使い方について簡単に解説しています。新しい機能実装をテストしてみたい、すぐにでもアプリケーションを立ち上げたいといった場合に便利な機能なので、ぜひ覚えておきましょう。...

動作確認

サーバーを起動し、ユーザー一覧画面（http://localhost:3000/users）にアクセスしてみます。デベロッパーツールを開き、レンダリング元が開始タグと終了タグで囲われていることが確認できるかと思います。

まとめ

「annotate_rendered_view_with_filenames」とは、Viewの呼び出し元を開始タグと終了タグで表示してくれる機能
「annotate_rendered_view_with_filenames」はRails6.1から追加された機能
config/environments/development.rbにあるconfig.action_view.annotate_rendered_view_with_filenames = trueのコメントアウトを解除するだけで「annotate_rendered_view_with_filenames」機能が有効化される

参考

今回はRails6.1から追加された、Viewの呼び出し元を表示してくれる「annotate_rendered_view_with_filenames」を紹介しました。個人的にはわざわざ入れるほどの機能でもないかなというのが正直な感想ですが、Railsにはこのように細かい所に手が届く機能がたくさんありますね。

Rails