0.0
The project is in a healthy, maintained state
Pioneer Valley Books Rubocop Configuration
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies
 Project Readme

pvb-rubocop

pvb-rubocop holds common configuration for rubocop utility.

Installation

$ bundle add pvb-rubocop --group=development
$ bundle add rubocop --group=development
$ bundle add rubocop-performance --group=development

For RSpec projects:

$ bundle add rubocop-rspec --group=development

For Rails projects:

$ bundle add rubocop-factory_bot --group=development

Usage

Add the following to the rubocop.yml file:

inherit_gem:
  pvb-rubocop: default.yml

For RSpec projects:

inherit_gem:
  pvb-rubocop: rspec.yml

For Rails projects:

inherit_gem:
  pvb-rubocop: rails.yml

For more details see rubocop documentation on inheriting configuration from a dependency gem

Creating a release

  1. Create a new pull request that:
  • Bumps the version in pvb-rubocop.gemspec
  • Updates CHANGELOG.md to include all noteworthy changes, the release version, and the release date.
  1. After the pull request lands, checkout the most up to date main branch and build the gem:
$ docker run --rm -it -v $(pwd):$(pwd) -w $(pwd) ruby gem build
  1. Publish the gem:
$ docker run --rm -it -v $(pwd):$(pwd) -w $(pwd) ruby gem push pvb-rubocop-X.Y.Z.gem
  1. Create and publish a git tag:
$ git tag X.Y.Z
$ git push https://github.com/Pioneer-Valley-Books/pvb-rubocop.git X.Y.Z