https://github.com/codeclimate-community/codeclimate-foodcritic

Code Climate Engine for Foodcritic
https://github.com/codeclimate-community/codeclimate-foodcritic

chef chef-cookbook code-quality codeclimate codeclimate-engine linter linting quality static-analysis static-code-analysis

Last synced: about 2 months ago
JSON representation

Code Climate Engine for Foodcritic

• Host: GitHub
• URL: https://github.com/codeclimate-community/codeclimate-foodcritic
• Owner: codeclimate-community
• License: mit
• Created: 2016-03-08T16:53:06.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-10-19T05:55:54.000Z (about 2 years ago)
• Last Synced: 2023-08-06T23:41:02.397Z (over 1 year ago)
• Topics: chef, chef-cookbook, code-quality, codeclimate, codeclimate-engine, linter, linting, quality, static-analysis, static-code-analysis
• Language: Ruby
• Size: 44.9 KB
• Stars: 1
• Watchers: 8
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Code Climate Engine to run [Foodcritic][]

[foodcritic]: http://www.foodcritic.io/

## Usage

**.codeclimate.yml**

```yml

engines:

  foodcritic:

    enabled: true

```

## Configuration

This engine accepts `tags`, `cookbook_paths` and `include_rules` in its

configuration. All values are optional:

```yml

engines:

  foodcritic:

    enabled: true

    config:

      tags:

      - "~FC011"

      - "~FC033"

      cookbook_paths:

      - libraries/mysql.rb

      - libraries/docker.rb

      include_rules:

      - rules/my_custom_rule.rb

      - rules/my_other_custom_rule.rb

```

**NOTE**: `cookbook_paths`, when defined, are passed directly to Foodcritic and

any computed `include_paths` (which take into account your configured

`exclude_paths`) are ignored.