https://github.com/joshbuker/rubocop-athix

Contains my commonly used styling overrides for Rubocop
https://github.com/joshbuker/rubocop-athix

Last synced: 9 days ago
JSON representation

Contains my commonly used styling overrides for Rubocop

• Host: GitHub
• URL: https://github.com/joshbuker/rubocop-athix
• Owner: joshbuker
• License: mit
• Created: 2021-06-23T16:50:17.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-04T20:20:49.000Z (11 months ago)
• Last Synced: 2024-10-27T05:43:26.905Z (24 days ago)
• Language: Ruby
• Homepage:
• Size: 46.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# RuboCop Athix

Contains my commonly used styling overrides for Rubocop.

## Adding additional Excludes

Inherit mode does not get inherited, meaning you'll need to add the following to

your config if you overwrite the Exclude and want it to append rather than

replace:

```yaml

##

# Merge instead of overwriting. For more details, see:

# https://docs.rubocop.org/rubocop/configuration.html#merging-arrays-using-inherit_mode

#

inherit_mode:

  merge:

    - Exclude

```

## Usage

### Rails Applications

**Gemfile**

```ruby

gem 'rubocop-athix'

gem 'rubocop-i18n'

gem 'rubocop-rails'

gem 'rubocop-rake'

gem 'rubocop-rspec'

```

**.rubocop.yml**

```yaml

inherit_gem:

  rubocop-athix:

    - config/rails.yml

```

### Ruby Gems

**Gemspec**

```ruby

s.add_development_dependency 'rubocop-athix'

s.add_development_dependency 'rubocop-rake'

s.add_development_dependency 'rubocop-rspec'

```

**Gemfile**

```ruby

gem 'rubocop-athix'

gem 'rubocop-rake'

gem 'rubocop-rspec'

```

**.rubocop.yml**

```yaml

inherit_gem:

  rubocop-athix:

    - config/gems.yml

```

### Other Ruby code

**Gemfile**

```ruby

gem 'rubocop-athix'

```

**.rubocop.yml**

```yaml

inherit_gem:

  rubocop-athix:

    - config/default.yml

```