Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 1.51 KB

README.md

File metadata and controls

57 lines (37 loc) · 1.51 KB
Raw

Bookingsync::Rubocop

This gem is a collection of Rubocop configuration and (potentially) custom cops for BookingSync projects.

Installation

Add this line to your application's Gemfile:

gem "bookingsync-rubocop", require: false, group: :development

And then execute:

$ bundle install

Usage

Add the following lines to .rubocop.yml:

inherit_gem:
  bookingsync-rubocop:
    - config/base.yml
    - config/rails.yml
    - config/rspec.yml

Keep in mind that in order to use the last 2 configs file must contain:

require:
  - rubocop-rails
  - rubocop-rspec

In order for your local config, gem configs and .rubocop.todo.yml to merge nicely use:

inherit_mode:
  merge:
    - Exclude

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bookingsync-rubocop.

License

The gem is available as open source under the terms of the MIT License.