Project

guard-reek

0.02
No commit activity in last 3 years
No release in over 3 years
Guard::Reek automatically runs Reek when files change
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

 Project Readme

Gem Version Build Status

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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request