タイトル: precompile standard library とは
SEOタイトル: precompile standard library とは(Pythonインストール)
| この記事の要点 |
|---|
|
Asset Pipeline と precompile の関係
Rails の Sprockets ベース Asset Pipeline では、本番デプロイ時に rails assets:precompile を実行し、app/assets/ 配下のソースをミニファイ・指紋付きファイル名で public/assets/ に出力します。
このとき「どのファイルをコンパイル対象にするか」を制御するのが config.assets.precompile 設定(standard library と呼ばれることもある、デフォルト含む組み込み一覧)です。
デフォルトの precompile 対象
# config/initializers/assets.rb
Rails.application.config.assets.precompile += %w( admin.css admin.js )
# デフォルト (Rails が自動で含めるもの)
# - application.css
# - application.js
# - 画像 (jpg/png/gif/svg/eot/woff/woff2/ttf) すべて
個別ファイルをコンパイル対象に追加
例えば app/assets/javascripts/admin.js を直接読み込みたい場合:
# config/initializers/assets.rb
Rails.application.config.assets.precompile += %w( admin.js admin.css )
# 複数ファイル
Rails.application.config.assets.precompile += %w(
admin.css
admin.js
print.css
pages/landing.css
)
# 正規表現で一括
Rails.application.config.assets.precompile += [/\.(?:svg|eot|woff|ttf)\z/]
追加後、view から直接参照可能:
<!-- ERB -->
<%= stylesheet_link_tag "admin", media: "all" %>
<%= javascript_include_tag "admin" %>
よくあるエラー
Asset is not precompiled
ActionController::RoutingError (Sprockets::Rails::Helper::AssetNotPrecompiled):
admin.js is not precompiled.
Add `Rails.application.config.assets.precompile += %w( admin.js )` to `config/initializers/assets.rb` and restart your server
対処: メッセージ通り config/initializers/assets.rb に追加 + サーバ再起動 + rails assets:precompile 再実行
本番でファイルが見つからない
# 本番でアセットを生成
$ RAILS_ENV=production bundle exec rails assets:precompile
# キャッシュをクリア
$ rails assets:clobber
# 全部やり直し
$ rm -rf public/assets tmp/cache
$ RAILS_ENV=production bundle exec rails assets:precompile
確認方法
# 現在の precompile 対象を確認
$ rails console
> Rails.application.config.assets.precompile
=> ["application.css", "application.js", /\.svg\z/, /\.eot\z/, ...]
# precompile 後の出力先を確認
$ ls public/assets/
admin-abc123def456.js
admin-abc123def456.css
application-def456abc123.js
...
Rails 7 の Propshaft / importmap での違い
Rails 7 から Propshaft(Sprockets の後継)や importmap が新規プロジェクトのデフォルトに。これらでは precompile 設定の意味が変わります:
- Propshaft: ファイル変換しない(コピーするだけ)。precompile の概念が単純化
- importmap: JS をブラウザネイティブの import map で扱う。Sprockets の JS バンドルが不要
- esbuild / webpacker: JS は別バンドラに分離、CSS のみ Sprockets で管理
関連設定
| 設定 | 用途 |
|---|---|
config.assets.compile | true で本番でも動的コンパイル(パフォーマンス悪、開発時のみ) |
config.assets.digest | 指紋ファイル名 (xxx-abc123.js) |
config.assets.prefix | URL プレフィックス(デフォルト /assets) |
config.assets.css_compressor | :sass / :yui 等の CSS 圧縮 |
config.assets.js_compressor | :uglifier / :terser 等の JS 圧縮 |
本番デプロイ時のベストプラクティス
- CI でアセットをプリコンパイル
- サーバ側で
RAILS_ENV=production rails assets:precompileを実行 - 古いアセットは
rails assets:cleanで削除(デフォルトで 3 世代保持) - CDN 配信なら
config.action_controller.asset_hostを設定