0.0
No commit activity in last 3 years
No release in over 3 years
Guild's RuboCop config based around our preferred style
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0.2
~> 12.3.2
~> 3.8.0

Runtime

~> 0.73
~> 1.33.0
 Project Readme

Gem Version

RuboCop Guild

Guild Education shared RuboCop config

Installation

Add this line to your application's Gemfile:

gem 'rubocop-guild'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rubocop-guild

Usage

Rake Task

This gem exposes a Rake task that will perform the installation for you:

rake guild:rubocop:install

Manually

Add this to the top of your .rubocop.yml:

inherit_gem:
  rubocop-guild:
    - config/guild.yml

If you want to override the settings, do that below these lines.

Development

Clone the repo and make the associated changes to the config/guild.yml file.

In addition, please follow these guildlines:

  1. Associated cop definitions should be grouped
  2. Cops should be in alphabetical order within their groups. This makes it easier to look up the cop in the RuboCop documentation

Publishing

Make sure you've been granted publish access to the rubygem

  1. Increment the gem version in rubocop-guild.gemspec
  2. Run bin/rake release. This will create a new tag based on the version, push the tag to Github, and then push the gem to Rubygems