johaned / guard-rubycritic

Real time Ruby code smell detector

Guard::RubyCritic

Guard::RubyCritic is a tool that uses [RubyCritic](https://github.com/whitesmith/rubycritic) to detect and report smells in Ruby code in real-time.

Installation

Add this line to your application's Gemfile:

gem "guard-rubycritic"

And then execute:

$ bundle

Next, generate a default Guardfile in your root directory:

$ guard init rubycritic

Usage

Change your Guardfile to your heart's content and start it with the following command:

$ guard

Each time you save a file, that file will be analysed and its report will be available at YOUR_PROJECT_ROOT/tmp/rubycritic/current_file.html.

Improving Guard::RubyCritic

See Guard::RubyCritic's contributing guidelines about how to proceed.