Sprockets Rails 技术文档

1. 安装指南

要安装 Sprockets Rails，您可以通过以下方式将其添加到您的 Rails 项目中：

gem 'sprockets-rails', :require => 'sprockets/railtie'

或者，如果您禁用了 Bundler 自动加载，可以在 config/application.rb 文件中添加以下代码：

require 'sprockets/railtie'

确保在 Gemfile 中添加后运行 bundle install 来安装依赖。

2. 项目的使用说明

Sprockets Rails 为 Rails 4.x 及以上版本提供了一个 Asset Pipeline 实现。以下是一些基本的使用说明：

Rake 任务

• rake assets:precompile：部署任务，用于编译 config.assets.precompile 中列出的所有资产，并将其放置在 public/assets 目录下。
• rake assets:clean：仅删除 public/assets 目录下的旧资产（保留最近的三个副本）。在进行滚动部署时，当新资产正在编译时，这可能会有用，因为可能仍在服务旧资产。
• rake assets:clobber：彻底删除 public/assets 目录。

定制

如果基本任务不符合您的需求，可以轻松重定义它们，并用更适合您应用程序的任务替换它们。

require 'sprockets/rails/task'
Sprockets::Rails::Task.new(Rails.application) do |t|
  t.environment = lambda { Rails.application.assets }
  t.assets = %w( application.js application.css )
  t.keep = 5
end

每个资产任务都会首先调用 assets:environment。默认情况下，这将加载 Rails 环境。您可以根据特定的编译环境添加或删除依赖。

初始化选项

以下是一些可配置的初始化选项：

• config.assets.unknown_asset_fallback：当设置为真值时，即使请求的资产在资产管道中未找到，也会返回结果。当设置为假值时，如果未找到资产，将引发错误。默认值为 true。
• config.assets.precompile：添加在部署时编译的额外资产。默认为 application.js、application.css 和 app/assets 下的任何非 js/css 文件。
• config.assets.paths：向此数组添加其他加载路径。Rails 默认包括 app/assets、lib/assets 和 vendor/assets。
• config.assets.quiet：抑制资产请求的日志输出。默认为 false。
• config.assets.version：设置自定义缓存破坏字符串。更改它将导致在下次构建时重新编译所有资产。
• config.assets.prefix：默认为 /assets。更改编译资产的目录。
• config.assets.digest：启用时，将在资产文件名中添加指纹。
• config.assets.debug：启用资产调试模式。当此值为真时，每个资产将包含一个源地图。
• config.assets.compile：启用 Sprockets 编译环境。如果禁用，Rails.application.assets 将为 nil，以防止不慎调用编译。
• config.assets.configure：当环境初始化时，调用块并带有环境。允许直接访问环境实例，并允许您延迟加载仅用于资产编译的库。

3. 项目 API 使用文档

由于 Sprockets Rails 是 Rails Asset Pipeline 的一部分，因此它主要与 Rails 应用程序中的配置和环境设置交互。以下是一些关键 API 和配置选项的说明：

• Sprockets::Rails::Task：用于创建自定义的 Rake 任务。
• config.assets.*：用于配置资产处理的各个方面，如预编译、路径、版本等。

4. 项目安装方式

Sprockets Rails 的安装方式已在安装指南中详细说明。简而言之，您需要将 sprockets-rails 添加到您的 Gemfile 中，然后运行 bundle install。如果您的 Bundler 自动加载被禁用，还需要在 config/application.rb 中明确引入 sprockets/railtie。

通过遵循上述步骤，您可以轻松地将 Sprockets Rails 集成到您的 Rails 项目中，并利用其提供的 Asset Pipeline 功能。