Contents

# Guard::Foodcritic

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

[![Build Status](https://travis-ci.org/Nordstrom/guard-foodcritic.png?branch=master)](https://travis-ci.org/Nordstrom/guard-foodcritic)

[![Inline docs](http://inch-ci.org/github/nordstrom/guard-foodcritic.svg?branch=master)](http://inch-ci.org/github/nordstrom/guard-foodcritic)

[![Code Climate](https://codeclimate.com/github/Nordstrom/guard-foodcritic/badges/gpa.svg)](https://codeclimate.com/github/Nordstrom/guard-foodcritic)

Guard::Foodcritic automatically runs [foodcritic](http://www.foodcritic.io/).

## Installation

guard-foodcritic depends on foodcritic v6.x, which only works with Ruby
v2.0.0 and higher.  If you are still using Ruby v1.9.3, you should use
v1.1.1 of this gem.  The current best practice for running foodcritic
against cookbooks is to use [ChefDK](https://downloads.chef.io/chef-dk/)
for cookbook development, which includes Ruby 2.x.x on all platforms.

Install the gem:

    $ gem install guard-foodcritic

Add the guard-foodcritic definition to your Guardfile by running this
command:

    $ guard init foodcritic

## Options

```ruby
:all_on_start => false    # Whether to run Foodcritic on all cookbooks at startup
                          # default: true

:cli => "--epic-fail any" # Command line arguments passed to foodcritic
                          # default: "--epic-fail any"

:cookbook_paths => "."    # The path(s) to your cookbooks
                          # default: ["cookbooks"]

:notification => false    # Whether to display notifications after the lint is done running
                          # default: true
```

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
guard-foodcritic-2.1.0	README.md