Guard::LiveReload 技术文档

1. 安装指南

1.1 前提条件

在安装 Guard::LiveReload 之前，请确保已经安装了 Guard。

1.2 安装步骤

1. 使用以下命令安装 guard-livereload gem：

   $ gem install guard-livereload
   

2. 将 guard-livereload 添加到你的 Gemfile 中（建议放在 development 组中）：

   group :development do
     gem 'guard-livereload', '~> 2.5', require: false
   end
   

3. 运行以下命令将 guard-livereload 的定义添加到你的 Guardfile 中：

   $ guard init livereload
   

4. 为了在浏览器中启用 LiveReload 功能，你可以使用 rack-livereload 或者安装 LiveReload Safari/Chrome/Firefox 扩展。

2. 项目的使用说明

2.1 快速开始

要快速开始使用 Guard::LiveReload，请参考 wiki。

2.2 在 Rails 或 Rack 应用中的使用

如果你使用的是 Rails 或基于 Rack 的应用，请参考 rack-livereload 的 README 部分。

2.3 Guard 和插件的使用

关于 Guard 及其插件的更多信息，请参阅 Guard 的使用文档。

2.4 LiveReload 扩展的使用

关于 LiveReload 扩展的更多信息，请参阅 LiveReload 扩展的使用文档。

3. 项目 API 使用文档

3.1 Guardfile 配置

你可以根据需要自定义你的 "view" 文件。请阅读 Guard 文档 以获取更多关于 Guardfile DSL 的信息。

示例 Guardfile 配置：

guard 'livereload' do
  watch(%r{app/views/.+\.(erb|haml|slim)})
  watch(%r{app/helpers/.+\.rb})
  watch(%r{public/.+\.(css|js|html)})
  watch(%r{config/locales/.+\.yml})
  # Rails Assets Pipeline
  watch(%r{(app|vendor)(/assets/\w+/(.+\.(css|js|html))).*}) { |m| "/assets/#{m[3]}" }
end

3.2 选项配置

Guard::LiveReload 提供了 6 个选项，你可以像这样设置：

guard 'livereload', grace_period: 0.5, override_url: true do
  # ...
end

可用选项：

notify: true          # 默认 false
host: '127.3.3.1'     # 默认 '0.0.0.0'
port: '12345'         # 默认 '35729'
apply_css_live: false # 默认 true
override_url: false   # 默认 false
grace_period: 0.5     # 默认 0 (秒)
js_template: './my_livereload.js.erb' # 默认是 livereload.js.erb 来自 gem

3.3 自定义 JS 模板选项

js_apple_webkit_extra_wait_time: 50 # 默认是 5 (见 issue #123)
js_default_extra_wait_time: 100 # 默认是 200

4. 项目安装方式

4.1 安装 gem

使用以下命令安装 guard-livereload：

$ gem install guard-livereload

4.2 添加到 Gemfile

将 guard-livereload 添加到你的 Gemfile 中：

group :development do
  gem 'guard-livereload', '~> 2.5', require: false
end

4.3 初始化 Guardfile

运行以下命令将 guard-livereload 的定义添加到你的 Guardfile 中：

$ guard init livereload

4.4 浏览器扩展

为了在浏览器中启用 LiveReload 功能，你可以使用 rack-livereload 或者安装 LiveReload Safari/Chrome/Firefox 扩展。