Rack::LiveReload 技术文档

本文档旨在帮助用户安装、使用和理解 Rack::LiveReload 项目。以下是详细的技术指南和说明。

1. 安装指南

Rails 项目

在 Rails 项目中使用 Rack::LiveReload，首先需要在 Gemfile 中添加以下内容：

gem "rack-livereload", group: :development

然后执行 bundle install 命令安装该宝石。

接着，在 config/environments/development.rb 文件中添加以下代码，将 Rack::LiveReload 中间件添加到 Rails 中间件栈中：

# config/environments/development.rb

MyApp::Application.configure do
  # 在中间件栈底部添加 Rack::LiveReload，使用默认选项：
  config.middleware.insert_after ActionDispatch::Static, Rack::LiveReload

  # 或者，如果你在使用 better_errors：
  config.middleware.insert_before Rack::Lock, Rack::LiveReload

  # ...
end

调整选项

你还可以通过以下方式指定 Rack::LiveReload 的选项：

# 指定 Rack::LiveReload 选项。
config.middleware.use(Rack::LiveReload,
  min_delay:        500,    # 默认 1000
  max_delay:        10_000, # 默认 60_000
  live_reload_port: 56789,  # 默认 35729
  host:             'myhost.cool.wow',
  ignore:           [ %r{dont/modify\.html$} ]
)

此外，可以通过 insert_before 或 insert_after 方法指定 Rack::LiveReload 在中间件栈中的位置。请参考 Rails on Rack: Adding a Middleware 了解更多信息。

Sinatra / config.ru

在 Sinatra 或 config.ru 文件中，使用以下代码：

require 'rack-livereload'

use Rack::LiveReload
# ...或者...
use Rack::LiveReload, min_delay: 500, ...

2. 项目使用说明

Rack::LiveReload 是一个 Rack 中间件，它可以在 Rack 应用程序中实现 LiveReload 功能，无需浏览器扩展即可自动刷新页面。它支持没有 WebSocket 支持的浏览器。

与 guard-livereload 一起使用可以获得最佳效果。

3. 项目 API 使用文档

Rack::LiveReload 提供了以下选项：

• min_delay: 最小延迟时间（毫秒）。
• max_delay: 最大延迟时间（毫秒）。
• live_reload_port: LiveReload 服务器端口。
• host: LiveReload 服务器地址。
• ignore: 忽略匹配正则表达式的文件或目录。
• force_swf: 强制使用 Flash 支持。
• no_swf: 不包括 Flash 支持。

4. 项目安装方式

请参考上述安装指南，根据你的项目类型（Rails 或 Sinatra）选择相应的安装方法。