Guard::RackUnit
Guard::RackUnit
is a Guard plugin to run
Racket's
RackUnit unit
tests.
By default, Guard::RackUnit
uses the raco test
command to run
tests. Consequently, your RackUnit tests should be placed in
Racket test modules: (module+ test ...)
.
guard init rackunit
Setup
There are many ways to set up Guard. For the non-Rubyist, the ceremony described below is a typical setup.
- Install a relatively recent version of Ruby.
- Install bundler
- Install rvm
- Create a
Gemfile
in your Racket project's root directory. To theGemfile
, add both the guard gem and the guard-rackunit gem. See the example below. - In the directory where the
Gemfile
is stored, runbundle install
If everything successfully installs, you are now ready to use Guard. Consult the usage section below on how to use the RackUnit plugin.
Example Gemfile
source 'https://www.rubygems.org'
gem "guard", "~> 2.5.1"
gem 'guard-rackunit', path: '/home/calbers/src/mine/guard-rackunit'
Usage
To use the RackUnit Guard plugin, Guard must be initialized. To do so,
execute the following command in your project's root directory: bundle exec guard init
. This should create a Guardfile
with a default
setup for RackUnit.
Now, to start Guard, execute the following command: bundle exec guard start
.
Please consult Guard's own usage notes for more information.
##List of available options:
test_paths: ['tests/'] # Specify an array of paths that contain unit test files
all_on_start: true # Run all the tests at startup, default: false
Support and Issues
Please submit support questions, feature requests, and issues to the Github repository's issue tracker.
Updates
Consult the ChangeLog when upgrading to newer versions.
Development
The source code is hosted at GitHub.
Pull requests are more than welcome. To contribute, please add new unit tests to the existing suite of Ruby rspec unit tests.
Requirements
- Racket, with
raco test
support - Ruby, and the gems which
Guard::RackUnit
depends on.
Author
License
This Guard plugin is released under the GPLv3. Consult the LICENSE file for more details