Guard::RSpec 技术文档

本文档旨在帮助用户安装、使用 Guard::RSpec，并详细说明其 API 的使用方法。

1. 安装指南

在您的项目中使用 Guard::RSpec 前，需要先将其添加到 Gemfile 中：

gem 'guard-rspec', require: false

接着运行以下命令安装 Guardfile 的定义：

$ bundle exec guard init rspec

若要安装 RSpec 的 beta 版本，您需要指定所有依赖项的版本，例如：

gem 'rspec', '= 3.5.0.beta3'
gem 'rspec-core', '= 3.5.0.beta3'
gem 'rspec-expectations', '= 3.5.0.beta3'
gem 'rspec-mocks', '= 3.5.0.beta3'
gem 'rspec-support', '= 3.5.0.beta3'
gem 'guard-rspec', '~> 4.7'

对于 Rails 项目，还需要添加：

gem 'rspec-rails', '= 3.5.0.beta3'

然后运行 bundle update 更新所有相关宝石。

2. 项目使用说明

Guard::RSpec 允许在文件被修改时自动智能地启动 specs。

• 兼容 RSpec >2.99 和 3
• 在 Ruby 2.2.x 和 JRuby 9.0.5.0 上进行了测试（Rubinius 不再支持）

请阅读 Guard 使用文档 了解更多使用说明。

3. 项目API使用文档

Guard::RSpec 的配置选项如下：

• cmd: 指定运行 rspec 的自定义命令，默认为 'rspec'
• cmd_additional_args: 在默认参数应用后、spec 列表之前添加的任何参数
• spec_paths: 包含 spec 文件的路径数组
• failed_mode: 对失败 specs 的处理方式，可选值有 :focus、:keep、:none（默认）
• all_after_pass: 在更改的 specs 通过后运行所有 specs，默认：false
• all_on_start: 在启动时运行所有 specs，默认：false
• launchy: 指定 rspec 结果文件的路径
• notification: 在 specs 运行完毕后显示通知，默认：true
• run_all: 运行所有 specs 的自定义选项
• title: 在通知中显示的自定义标题
• chdir: 从给定子目录运行 rspec
• results_file: 存储结果的文件路径
• bundler_env: 指定运行命令的 Bundler 环境

更多配置选项和详细信息，请参考项目的 GitHub Wiki。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明。确保将 Guard::RSpec 添加到 Gemfile 中，并运行 bundle install 命令。之后，使用 bundle exec guard init rspec 命令初始化 Guardfile。

通过以上步骤，您即可成功安装并配置 Guard::RSpec，以便在项目中使用。