README.md in guard-rspec-2.6.0 vs README.md in guard-rspec-3.0.0
- old
+ new
@@ -1,11 +1,11 @@
# Guard::RSpec [](http://badge.fury.io/rb/guard-rspec) [](http://travis-ci.org/guard/guard-rspec) [](https://gemnasium.com/guard/guard-rspec) [](https://codeclimate.com/github/guard/guard-rspec) [](https://coveralls.io/r/guard/guard-rspec)
RSpec guard allows to automatically & intelligently launch specs when files are modified.
-* Compatible with RSpec >= 2.11 (use guard-rspec 1.2.x for older release, including RSpec 1.x)
-* Tested against Ruby 1.8.7, 1.9.2, 1.9.3, REE and the latest versions of JRuby & Rubinius.
+* Compatible with RSpec >= 2.13 (use guard-rspec 1.2.x for older release, including RSpec 1.x)
+* Tested against Ruby 1.8.7, 1.9.3, 2.0.0, REE and the latest versions of JRuby & Rubinius.
## Install
Please be sure to have [Guard](https://github.com/guard/guard) installed before continuing.
@@ -38,21 +38,21 @@
RSpec guard can be adapted to all kinds of projects.
### Standard RubyGem project
``` ruby
-guard 'rspec' do
+guard :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
```
### Typical Rails app
``` ruby
-guard 'rspec' do
+guard :rspec do
watch('spec/spec_helper.rb') { "spec" }
watch('config/routes.rb') { "spec/routing" }
watch('app/controllers/application_controller.rb') { "spec/controllers" }
watch(%r{^spec/.+_spec\.rb$})
watch(%r{^app/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
@@ -111,10 +111,16 @@
``` ruby
guard 'rspec', :parallel => true, :parallel_cli => '-n 2' do
# ...
end
```
+[Foreman](https://github.com/ddollar/foreman) is supported, but you must enable it:
+``` ruby
+guard 'rspec', :foreman => true do
+ # ...
+end
+```
Former `:color`, `:drb`, `:fail_fast` and `:formatter` options are deprecated and no longer have effect.
### List of available options:
@@ -122,18 +128,19 @@
:cli => "-c -f doc" # pass arbitrary RSpec CLI arguments, default: "-f progress"
:bundler => false # use "bundle exec" to run the RSpec command, default: true
:binstubs => true # use "bin/rspec" to run the RSpec command (takes precedence over :bundle), default: false
:rvm => ['1.8.7', '1.9.2'] # directly run your specs on multiple Rubies, default: nil
:notification => false # display Growl (or Libnotify) notification after the specs are done running, default: true
-:all_after_pass => false # run all specs after changed specs pass, default: true
-:all_on_start => false # run all the specs at startup, default: true
-:keep_failed => false # keep failed specs until they pass, default: true
+:all_after_pass => true # run all specs after changed specs pass, default: false
+:all_on_start => true # run all the specs at startup, default: false
+:keep_failed => true # keep failed specs until they pass, default: false
:run_all => { :cli => "-p" } # cli arguments to use when running all specs, default: same as :cli
:spec_paths => ["spec"] # specify an array of paths that contain spec files
:exclude => "spec/foo/**/*" # exclude files based on glob
:spring => true # enable spring support; default: false
:turnip => true # enable turnip support; default: false
:zeus => true # enable zeus support; default: false
+:foreman => true # enable foreman support; default: false
:focus_on_failed => false # focus on the first 10 failed specs first, rerun till they pass
:parallel => true # run all specs in parallel using [ParallelTests](https://github.com/grosser/parallel_tests) gem, default: false
:parallel_cli => "-n 2" # pass arbitrary Parallel Tests arguments, default: ""
```