Guard 开源项目教程

Guard 开源项目教程

guardGuard is a command line tool to easily handle events on file system modifications.项目地址:https://gitcode.com/gh_mirrors/gu/guard

1. 项目的目录结构及介绍

Guard 项目的目录结构如下：

guard/
├── bin/
│   └── guard         # 启动脚本
├── lib/
│   ├── guard/
│   │   ├── notifier/ # 通知相关模块
│   │   ├── runner.rb # 运行器
│   │   └── ...       # 其他核心模块
│   └── guard.rb      # 主文件
├── spec/             # 测试目录
├── Guardfile         # 配置文件
├── README.md         # 项目说明
└── ...               # 其他文件和目录

目录结构介绍

• bin/: 包含项目的启动脚本。
• lib/: 包含项目的主要代码，其中 guard/ 目录下是核心模块。
• spec/: 包含项目的测试代码。
• Guardfile: 项目的配置文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

Guard 项目的启动文件位于 bin/ 目录下，名为 guard。这个文件是一个可执行脚本，用于启动 Guard 项目。

启动文件内容概述

#!/usr/bin/env ruby

require 'guard'
require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: guard [options]"
  opts.on('-c', '--clear', 'Clear the screen before each run') { |v| options[:clear] = v }
  opts.on('-n', '--notify', 'Notify on changes') { |v| options[:notify] = v }
  opts.on('-w', '--watchdir DIR', 'Specify the directory to watch') { |v| options[:watchdir] = v }
end.parse!

Guard.start(options)

启动文件功能

• 引入 guard 库。
• 解析命令行选项。
• 根据选项启动 Guard 项目。

3. 项目的配置文件介绍

Guard 项目的配置文件名为 Guardfile，它定义了项目的监听规则和执行任务。

配置文件内容示例

guard :rspec, cmd: "bundle exec rspec" do
  watch(%r{^spec/.+_spec\.rb$})
  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
  watch('spec/spec_helper.rb')  { "spec" }
end

guard :coffeescript do
  watch(%r{^app/assets/javascripts/.*\.coffee$})
end

配置文件功能

• 定义不同类型的监听任务。
• 指定监听到变化时执行的命令。
• 支持多种编程语言和框架的集成。

以上是 Guard 开源项目的教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

guardGuard is a command line tool to easily handle events on file system modifications.项目地址:https://gitcode.com/gh_mirrors/gu/guard