Propshaft 开源项目教程

Propshaft 开源项目教程

propshaftDeliver assets for Rails项目地址:https://gitcode.com/gh_mirrors/pr/propshaft

项目介绍

Propshaft 是一个用于 Rails 应用的资产交付工具，旨在替代 Sprockets 作为 Rails 的默认资产管道。Propshaft 设计简洁，专注于资产的消化和提供，而不是全面的转译器功能。它支持可配置的加载路径、摘要标记和开发服务器等功能，适用于需要快速资产管道的现代 Rails 应用。

项目快速启动

安装 Propshaft

要开始使用 Propshaft，首先确保你使用的是 Rails 7 或更高版本。你可以通过以下命令创建一个新应用并启用 Propshaft：

rails new myapp -a propshaft
cd myapp

配置 Propshaft

对于现有应用，你需要在 Gemfile 中添加 Propshaft 并运行 bundle install：

gem 'propshaft'

然后在 config/environments/development.rb 文件中添加以下配置：

config.file_watcher = ActiveSupport::EventedFileUpdateChecker

使用 Propshaft

Propshaft 会自动处理所有配置路径中的资产，并在预编译时将它们复制到 public/assets 目录中。你可以在开发环境中直接引用这些资产，无需预编译。

应用案例和最佳实践

应用案例

Propshaft 特别适用于那些已经使用 Node-based 工具进行 JavaScript 和 CSS 打包的应用。如果你不需要额外的转译功能，Propshaft 可以无缝集成到你的工作流程中。

最佳实践

1. 避免复杂的转译需求：如果你依赖 CoffeeScript 或 Sass 等转译功能，考虑使用 Node-based 转译器。
2. 优化开发性能：在开发环境中，通过添加 listen gem 来提高资产更新的检查性能。

典型生态项目

Propshaft 作为 Rails 生态系统的一部分，与以下项目协同工作：

1. jsbundling-rails：用于 JavaScript 打包。
2. cssbundling-rails：用于 CSS 打包。
3. Rails 7+：Propshaft 是 Rails 7 及以上版本的默认资产管道。

通过这些项目的结合使用，可以构建一个高效、现代的 Rails 应用。

propshaftDeliver assets for Rails项目地址:https://gitcode.com/gh_mirrors/pr/propshaft