Sha256: 9a66187a1ac4f2a2613e856ebca509ddbe5d987293dffe2be6db392e995954bc
Contents?: true
Size: 1.46 KB
Versions: 6
Compression:
Stored size: 1.46 KB
Contents
# armitage-rubocop · [](https://badge.fury.io/rb/armitage-rubocop)
- [Installation](#installation)
- [Usage](#usage)
- [Build](#build)
---
Configured rules:
- **Common** (`.rubocop.general.yml`) (`.rubocop.rails.yml`) (`.rubocop.rake.yml`)
- Bundler
- Rake
- Gemspec
- Layout
- Lint
- Metrics
- Naming
- Performance
- Rails (isn't included in `.rubocop.general.yml`)
- Security
- Style
- Rake (isn't included in `.rubocop.general.yml`)
- **RSpec** (`.rubocop.rspec.yml`) (`.rubocop.rails.yml`)
- Capybara
- FactoryBot
- Rails
- RSpec
---
### 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
- lib/rubocop.rake.yml
```
```yaml
# --- rails ---
inherit_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
6 entries across 6 versions & 1 rubygems