Repository is archived
A long-lived project that still receives updates
A code linting tool for Chef Infra cookbooks.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
 Project Readme

Foodcritic

⚠️⚠️⚠️ All good things come to an end, and now is the time to say goodbye to Foodcritic. ⚠️⚠️⚠️

At this point we consider the Foodcritic project sunsetted and suggest all users move cookbook linting to Cookstyle.

Cookstyle with Chef cookbook support ships in Chef Workstation 0.9+ and ChefDK 4.4+. If you’d like to checkout the project or request new cops visit github.com/chef/cookstyle


Build Status Gem Version

Foodcritic is a code linting tool for writing better and safer Chef cookbooks that runs both as a command line tool and as a Rake task. Out of the box Foodcritic contains over 70 cookbook rules, and plugin system for writing your own rules.

Basic Usage

$ gem install foodcritic
$ foodcritic my_cookbook_dir

Documentation

The Foodcritic site at http://foodcritic.io/ contains documentation for each of the rules as well as documentation on the API for writing your own rules.

Requirements

  • Ruby 2.3+

Building Foodcritic

$ bundle install
$ bundle exec rake

Testing Foodcritic

Foodcritic includes rspec tests of the application itself and cucumber tests for each of the included rules. Each of these tests can be run via rake

Running rspec tests:

$ bundle exec rake spec

Running cucumber tests:

$ bundle exec rake features

Running regression tests:

$ bundle exec rake 'spec[regression]'

Docker

Foodcritic can also be used with Docker. To build and run Foodcritic in a Docker container please follow the instructions below.

Building the Docker image:

$ docker build --rm -t foodcritic/foodcritic .

Running Foodcritic inside a Docker container:

$ docker run -it --rm -v ~/cookbooks:/cookbooks foodcritic/foodcritic "/cookbooks"

Note: This will mount the host directory ~/cookbooks into the container in the path /cookbooks.

License

MIT - see the accompanying LICENSE file for details.

Changelog

To see what has changed in recent versions see the CHANGELOG. Foodcritic follows the Rubygems Semantic Versioning Policy.

Contributing

Additional rules and bug fixes are welcome! Please fork and submit a pull request on an individual branch per change.