ah-feng_shui

This repository is one place for common resources needed with static code analyze of Ruby in AirHelp.

Installation

Preferred way: In your Gemfile add all the feng-shui dependencies, without actually using this gem. Example can be found here.

The old way: In your Gemfile add:

group :test do
  # Configuration for pronto
  gem 'ah-feng_shui', git: 'https://github.com/AirHelp/ah-feng_shui', branch: 'master'
end

Then install the gem locally:

$ bundle

Note: you probably need to install cmake for this to work

$ brew install cmake

Just run pronto using bundler and it will use the correct config:

$ bundle exec pronto run

Create a .rubocop.yml file in your project and make sure it starts with:

inherit_gem:
  ah-feng_shui:
    - config/rubocop_default.yml

It can also contain project specific rules to tweak Rubocop for special project needs.

For Rubocop 0.51 and above use rubocop_default_rails_5.1.yml

Just run pronto using bundler and it will use the correct config:

$ bundle exec rubocop

or

$ bundle exec pronto run -r rubocop

Copy config/config-rails.reek into your project root directory and tweak as needed.

$ bundle exec reek

or

$ bundle exec pronto run -r reek