A collection of Rubocop rules for modularizing ruby applications that conform to the
Just install the
gem install rubocop-packs
or, if you use
Bundler, add this line your application's
gem 'rubocop-packs', require: false
You need to tell RuboCop to load the Packs extension. There are three ways to do this:
RuboCop configuration file
Put this into your
require: - rubocop-packs
Now you can run
rubocop and it will automatically load the RuboCop Packs cops together with the standard cops.
All cops are located under
lib/rubocop/cop/packs, and contain examples/documentation.
.rubocop.yml, you may treat the Packs cops just like any other cop. For example:
Packs/RootNamespaceIsPackName: Exclude: - lib/example.rb
Bug reports and pull requests are welcome on GitHub at https://github.com/rubyatscale/rubocop-packs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Code Of Conduct.
To contribute a new cop, please use the supplied generator like this:
bundle exec rake new_cop[Packs/NewCopName]
which will create a skeleton cop, a skeleton spec, an entry in the default config file and will require the new cop so that it is properly exported from the gem.
Don't forget to update the documentation with:
VERIFYING_DOCUMENTATION=1 bundle exec rake generate_cops_documentation
The gem is available as open source under the terms of the MIT License.