guard-reek
guard-reek allows you to automatically detect code smells with Reek when files are modified.
Installation
Please make sure to have Guard installed before continue.
Add guard-reek
to your Gemfile
:
group :development do
gem 'guard-reek'
end
and then execute:
$ bundle install
or install it yourself as:
$ gem install guard-reek
Add the default Guard::Reek definition to your Guardfile
by running:
$ guard init reek
Usage
Please read the Guard usage documentation.
Options
You can pass some options in Guardfile
like the following example:
guard :reek, all_on_start: false, run_all: false, cli: '--single-line --no-wiki-links' do
# ...
end
Available Options
all_on_start: true # Check all files at Guard startup.
# default: true
all: 'app lib spec' # What to run when running all
# An array or string is acceptable.
# default: *
cli: '--single-line' # Pass arbitrary reek CLI arguments.
# An array or string is acceptable.
# default: nil
run_all: true # Check all files on "Enter"
# default: true
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request