Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Foodcritic/foodcritic
Lint tool for Chef cookbooks.
https://github.com/Foodcritic/foodcritic
Last synced: 13 days ago
JSON representation
Lint tool for Chef cookbooks.
- Host: GitHub
- URL: https://github.com/Foodcritic/foodcritic
- Owner: Foodcritic
- License: mit
- Archived: true
- Created: 2011-11-28T00:37:19.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2020-09-01T05:48:58.000Z (about 4 years ago)
- Last Synced: 2024-09-08T15:35:55.296Z (2 months ago)
- Language: Ruby
- Homepage: http://foodcritic.io
- Size: 2.79 MB
- Stars: 408
- Watchers: 17
- Forks: 153
- Open Issues: 84
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ruby-toolbox - foodcritic - Lint tool for Chef cookbooks. (Code Quality / Code Metrics)
README
# Foodcritic
**⚠️⚠️⚠️ All good things come to an end, and now is the time [to say goodbye to Foodcritic.](https://blog.chef.io/goodbye-foodcritic/) ⚠️⚠️⚠️**
**At this point we consider the Foodcritic project sunsetted and suggest all users move cookbook linting to [Cookstyle](https://github.com/chef/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](https://github.com/chef/cookstyle/)**
[](https://travis-ci.org/Foodcritic/foodcritic) [](http://badge.fury.io/rb/foodcritic)
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
```shell
$ gem install foodcritic
$ foodcritic my_cookbook_dir
```
## Documentation
The Foodcritic site at 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:
```shell
$ docker build --rm -t foodcritic/foodcritic .
```
Running Foodcritic inside a Docker container:
```shell
$ 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](https://github.com/Foodcritic/foodcritic/blob/master/LICENSE) file for details.
## Changelog
To see what has changed in recent versions see the [CHANGELOG](https://github.com/Foodcritic/foodcritic/blob/master/CHANGELOG.md). Foodcritic follows the [Rubygems Semantic Versioning Policy](http://guides.rubygems.org/patterns/#semantic-versioning).
## Contributing
Additional rules and bug fixes are welcome! Please fork and submit a pull request on an individual branch per change.