Guard-Jasmine 开源项目教程
1. 项目的目录结构及介绍
Guard-Jasmine 是一个用于在控制台中自动运行 Jasmine 规范的工具。以下是其主要目录结构及其介绍:
guard-jasmine/
├── CHANGELOG.md
├── Guardfile
├── LICENSE.md
├── README.md
├── lib/
│ ├── guard/
│ │ └── jasmine.rb
│ └── guard-jasmine.rb
└── spec/
└── guard/
└── jasmine_spec.rb
- CHANGELOG.md: 记录项目的更新日志。
- Guardfile: 项目的默认配置文件,用于定义 Guard 的行为。
- LICENSE.md: 项目的许可证信息。
- README.md: 项目的基本介绍和使用说明。
- lib/: 包含项目的主要代码文件。
- guard/jasmine.rb: 定义 Guard::Jasmine 的主要功能。
- guard-jasmine.rb: 项目的主入口文件。
- spec/: 包含项目的测试文件。
- guard/jasmine_spec.rb: Guard::Jasmine 的测试文件。
2. 项目的启动文件介绍
Guard-Jasmine 的启动文件主要是 Guardfile
和 lib/guard-jasmine.rb
。
-
Guardfile: 这是一个配置文件,用于定义 Guard 的行为。用户可以根据需要自定义监视的文件和执行的动作。例如:
guard 'jasmine' do watch(%r[spec/javascripts/spec\ (js\ coffee|js|coffee)$]) watch(%r[spec/javascripts/ +_spec\ (js\ coffee|js|coffee)$]) watch(%r[app/assets/javascripts/( + )\ (js\ coffee|js|coffee)$]) end
-
lib/guard-jasmine.rb: 这是项目的主入口文件,负责加载和初始化 Guard::Jasmine 模块。
3. 项目的配置文件介绍
Guard-Jasmine 的主要配置文件是 Guardfile
。在这个文件中,用户可以定义监视的文件和执行的动作。以下是一些常见的配置选项:
- 监视文件: 定义需要监视的文件模式。
- 服务器选项: 配置服务器环境,例如服务器类型和端口。
- 自定义选项: 用户可以根据需要自定义 Guard::Jasmine 的行为,例如设置
all_on_start
和specdoc
选项。
例如:
guard 'jasmine', all_on_start: false, specdoc: :always do
watch(%r[spec/javascripts/spec\ (js\ coffee|js|coffee)$])
watch(%r[spec/javascripts/ +_spec\ (js\ coffee|js|coffee)$])
watch(%r[app/assets/javascripts/( + )\ (js\ coffee|js|coffee)$])
end
以上配置定义了在启动时不自动运行所有测试,并且在每次测试运行时总是显示测试文档。