【Rails】Webpacker管理下の構成を整える

2020年8月31日 9:40

はじめに

Rails6で標準導入されたWebpacker管理下の構成を整えたので記事にします。Webpackerで管理対象としているのは以下の3つです。

  • JavaScript
  • CSS
  • 画像

あくまで自分なりにわかりやすい構成に整えたという話ですので、ベストプラクティスを提案するとか言った大それたものではないことはご了承ください。

もっといい構成や命名があればぜひ教えてください。

構成を整える

ソースパス(エントリーポイント)

そもそもWebpacker管理下の構成を整えようと思ったのは、デフォルトのソースパスがapp/javascriptなのはわかりにくいと思ったのがきっかけです。

Webpackerで管理するのはJavaScriptが大半だからという理由なのかはわかりませんが、JavaScript以外の諸々(CSSと画像)も管理するようになると、デフォルトのソースパスは混乱をきたします。

※特にWebpack/Webpackerが何なのかまったく知らない時分には、多くの人が大いに混乱させられたのではないかと思います(「javascript配下にあるのにCSSや画像を管理...?」みたいな)。

前置きが長くなってしまいましたが、ソースパスを変更するには以下を行います。

app/config/webpacker.ymlを以下のように修正します。

default: &default
  source_path: app/webpack   ←任意のディレクトリ名に変更

Webpackerで管理するファイルを置くディレクトリだからwebpackにしましたが、お好きなディレクトリ名にしてください(デファクトスタンダードがあるのなら知りたい)。

変更できたら実際のディレクトリ名も変更します。

app
 |-webpack

最後にbin/webpackを実行、またはbin/webpack-dev-serverを再起動して完了です。

JavaScriptの管理

自分で作ったJavaScriptファイルやダウンロードした外部プラグインは以下のディレクトリに配置します。

app
 |-webpack
    |-src
       |-javascript
          |-base.js          ←JavaScriptのエントリーファイル
          |-modules          ←自分で作ったJavaScriptを配置
          |  |-module-1.js
          |  |-module-2.js
          |-vendor           ←ダウンロードした外部プラグインを配置
             |-plugin-1.js
             |-plugin-2.js

app/webpack/packs/application.jsに以下を追記します。

import '../src/javascript/base'
import '../src/javascript/vendor/plugin-1'
import '../src/javascript/vendor/plugin-2'

自分で作ったJavaScriptは、以下のようにbase.jsですべてのモジュールをインポートしておきます。

import * as module1 from './modules/module-1';
import * as module2 from './modules/module-2';

CSSの管理

CSSは以下のディレクトリに配置します。ファイルが増えてくればブロック単位にサブディレクトリを切ってもいいかもしれません。

app
 |-webpack
    |-src
       |-stylesheets
          |-_footer.scss
          |-_footer-sm.scss
          |-_header.scss
          |-_header-sm.scss
          |-_main.scss
          |-_main-sm.scss
          |-_variables.scss
          |-base.scss

app/webpack/packs/application.jsに以下を追記します。

import '../src/stylesheets/base'

個別のCSSは以下のようにbase.scssですべてのCSSをインポートしておきます。ファイル名の先頭にアンダースコア(_)をつけておくと簡略表記でインポートできます。

@import 'variables'
@import 'header';
@import 'header-sm';
@import 'main';
@import 'main-sm';
@import 'footer';
@import 'footer-sm';

画像の管理

画像は以下のディレクトリに配置します。

app
 |-webpack
    |-images
       |-cover.jpg
       |-favicon.png
       |-guitar.jpg

app/webpack/packs/application.jsに以下を追記します。

const images = require.context('../images', true)
const imagePath = (name) => images(name, true)

最終的な構成

最終的な構成は以下の通りになりました。

app
 |-webpack
    |-images
    |  |-cover.jpg
    |  |-favicon.png
    |  |-guitar.jpg
    |
    |-packs
    |  |-application.js     ←ソースパス(エントリーポイント)
    |
    |-src
      |-javascript
      |  |-base.js          ←JavaScriptのエントリーファイル
      |  |-modules          ←自分で作ったJavaScriptを配置
      |  |  |-module-1.js
      |  |  |-module-2.js
      |  |-vendor           ←ダウンロードした外部プラグインを配置
      |     |-plugin-1.js
      |     |-plugin-2.js
      |
      |-stylesheets
         |-_footer.scss
         |-_footer-sm.scss
         |-_header.scss
         |-_header-sm.scss
         |-_main.scss
         |-_main-sm.scss
         |-_variables.scss
         |-base.scss

app/packs/application.jsの内容は以下の通りです。

require("@rails/ujs").start()
require("turbolinks").start()
require("@rails/activestorage").start()
require("channels")
require("jquery")

// ここから下が今回の対象
// 画像
const images = require.context('../images', true)
const imagePath = (name) => images(name, true)

// JavaScript
import '../src/javascript/base'
import '../src/javascript/vendor/plugin-1'
import '../src/javascript/vendor/plugin-2'

// CSS
import '../src/stylesheets/base'

関連記事

【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12
【Rails】モデルに外部キーを設定する方法とよく起こるエラー内容について
# はじめに Railsでモデルに外部キーを設定する方法について説明します。 # モデルに外部キーを設定する ## リレーションシップ 今回は1つのブログ記事は複数のコメントを持つ1対多のリレーションシップを例に説明します。現在は` [...]
2022年2月10日 14:18
【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】
# はじめに RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。 入力フォームの内容を書 [...]
2022年1月27日 21:22
【Rails】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36
【Rails】devise-two-factorを使った2段階認証の実装方法【初学者】
# はじめに Railsアプリで2段階認証を実装するには、「rotp」というGemを使う方法の他に、「devise-two-factor」というGemを使う方法があります。「devise-two-factor」はその名の通り、IDとパスワードによ [...]
2021年12月12日 17:58
【Rails】rotpを使った2段階認証の実装方法【初学者】
# はじめに 昨今はIDとパスワードによる認証だけでなく、ワンタイムパスワードによる2段階認証を導入するWebアプリが増えてきました。Railsで作成したWebアプリでも、IDとパスワードによる認証に加えて2段階認証を導入するニーズが高まっていま [...]
2021年11月27日 13:02
【Rails】deviseを使った認証機能の実装【初学者】
# はじめに Railsアプリに認証機能を導入するには「devise」というGemを使う方法が最も簡単です。「devise」は認証に係る機能をほとんどコードを書くことなく実装できる反面、処理がブラックボックス化されており、全容が把握しづらいという [...]
2021年11月27日 13:01