https://github.com/joenas/guard-preek

Guard for refactoring, view code smells in color
https://github.com/joenas/guard-preek

Last synced: 2 months ago
JSON representation

Guard for refactoring, view code smells in color

• Host: GitHub
• URL: https://github.com/joenas/guard-preek
• Owner: joenas
• License: mit
• Created: 2013-08-24T12:13:28.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-11-14T17:06:12.000Z (about 10 years ago)
• Last Synced: 2024-04-09T22:12:52.435Z (9 months ago)
• Language: Ruby
• Homepage:
• Size: 333 KB
• Stars: 7
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Gem Version](https://badge.fury.io/rb/guard-preek.png)](http://badge.fury.io/rb/guard-preek)

[![Build Status](https://travis-ci.org/joenas/guard-preek.png)](https://travis-ci.org/joenas/guard-preek)

[![Dependency Status](https://gemnasium.com/joenas/guard-preek.png)](https://gemnasium.com/joenas/guard-preek)

[![Coverage Status](https://coveralls.io/repos/joenas/guard-preek/badge.png?branch=master)](https://coveralls.io/r/joenas/guard-preek?branch=master)

# Guard::Preek

Do your refactoring with [Guard](https://github.com/guard/guard) and [Preek](https://github.com/joenas/preek) printing the smells for you. In color!

## Installation

    $ gem install guard-preek

or

    # Add to Gemfile

    gem 'guard-preek'

or install it yourself

    $ git clone [email protected]:joenas/guard-preek.git

    $ cd guard-preek

    $ rake install

## Usage

To generate template:

    $ guard init preek

### Examples

```ruby

guard :preek, run_all_dir: 'lib' do

	watch(/lib\/(.*).rb/)

end

```

### Available options

``` ruby

run_all_dir: 'lib'           # Enter in guard will run Preek on 'lib'

report: :verbose             # Use Preek::VerboseReport, default is QuietReport

```

## 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