Contents

# armitage-rubocop · [![Gem Version](https://badge.fury.io/rb/armitage-rubocop.svg)](https://badge.fury.io/rb/armitage-rubocop)

- [Installation](#installation)
- [Usage](#usage)
- [Build](#build)

---

### Installation
```ruby
gem 'armitage-rubocop'
```

```shell
$ bundle install
# --- or ---
$ gem install 'armitage-rubocop'
```

```ruby
require 'armitage-rubocop'
```

---

### Usage

- edit your `.rubocop.yml` file:

```yaml
# --- vanilla ---
inherit_gem:
  armitage-rubocop:
    - lib/rubocop.general.yml
    - lib/rubocop.rspec.yml
```

```yaml
# --- rails ---
inheit_gem:
  # rails-specific cops + general + rspec
  armitage-rubocop: lib/rubocop.rails.yml
```

---

### Build

```ruby
# --- full build ---
bundle exec rake armitage_rubocop:build

# --- validate code style ---
bundle exec rake rubocop

# --- validate yaml files ---
bundle exec rake armitage_rubocop:validation:valid_yamls

# --- validate rubocop cops (existence and params) ---
bundle exec rake armitage_rubocop:validation:recognizable_cops
```

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
armitage-rubocop-0.9.0	README.md
armitage-rubocop-0.8.0	README.md
armitage-rubocop-0.7.0	README.md
armitage-rubocop-0.6.0	README.md