Sinatra AssetPack 技术文档

Sinatra AssetPack 是一个用于管理 Sinatra 应用程序中静态资源（如 JavaScript、CSS 和图像）的简便方法。以下文档将帮助您了解如何安装和使用 Sinatra AssetPack，以及如何通过项目 API 进行操作。

1. 安装指南

在您的 Sinatra 应用程序的 Gemfile 文件中添加以下依赖项：

gem 'sinatra-assetpack', :require => 'sinatra/assetpack'

然后运行以下命令安装宝石：

bundle install

2. 项目使用说明

设置

在您的 Sinatra 应用程序中，首先需要注册 Sinatra::AssetPack 并配置您的资产：

require 'sinatra/base'
require 'sinatra/assetpack'

class App < Sinatra::Base
  set :root, File.dirname(__FILE__) # 设置应用程序根目录

  register Sinatra::AssetPack

  assets {
    serve '/js',     from: 'app/js'        # 默认
    serve '/css',    from: 'app/css'       # 默认
    serve '/images', from: 'app/images'    # 默认

    # 定义资产包及其服务路径和文件模式
    js :app, '/js/app.js', [
      '/js/vendor/**/*.js',
      '/js/lib/**/*.js'
    ]

    css :application, '/css/application.css', [
      '/css/screen.css'
    ]

    # 设置压缩方式
    js_compression  :jsmin    # :jsmin | :yui | :closure | :uglify
    css_compression :simple   # :simple | :sass | :yui | :sqwish
  }
end

使用

1. 将您的资产（如 CSS、JavaScript 和图像文件）放入 /app/css、/app/js 和 /app/images 目录中。
2. 在您的设置中注册 Sinatra::AssetPack。
3. 在您的布局文件中使用 <%= js :app %> 和 <%= css :application %> 标签。
4. 现在您可以进行适当的资产管理了！

在布局中使用

在您的布局文件中，使用 css 和 js 助手：

# layout.erb
<%= css :application, :media => 'screen' %>
<%= js :app %>

# layout.haml
!= css :application, :media => 'screen'
!= js :app

3. 项目 API 使用文档

Sinatra AssetPack 提供了以下 API 用于管理和压缩资产：

• assets.serve 'PATH', :from => 'LOCALPATH': 在指定的 URI 路径中服务文件。
• assets.js_compression :ENGINE: 设置 JavaScript 压缩引擎。
• assets.css_compression :ENGINE: 设置 CSS 压缩引擎。
• assets.js_compression_options HASH: 设置 JavaScript 压缩选项。
• assets.css_compression_options HASH: 设置 CSS 压缩选项。

更多 API 文档和示例，请参考官方 GitHub 仓库。

4. 项目安装方式

如上所述，您可以通过修改 Gemfile 并运行 bundle install 命令来安装 Sinatra AssetPack。确保您已经安装了所有必要的依赖项，并根据需要配置了资产。

请遵循上述指南以顺利使用 Sinatra AssetPack。如果您需要进一步的定制或帮助，请参考官方文档和 GitHub 仓库。