RuboCop::Vicenzo
Installation
Install the gem and add to the application's Gemfile by executing:
bundle add rubocop-vicenzo --group=development --require=false
If bundler is not being used to manage dependencies, install the gem by executing:
gem install rubocop-vicenzo
Usage
You need to tell RuboCop to load the Vicenzo extension. There are three ways to do this:
RuboCop configuration file
Put this into your .rubocop.yml
.
plugins: rubocop-vicenzo
Alternatively, use the following array notation when specifying multiple extensions.
plugins:
- rubocop-other-extension
- rubocop-vicenzo
Now you can run rubocop
and it will automatically load the RuboCop Vicenzo
cops together with the standard cops.
Note
The plugin system is supported in RuboCop 1.72+. In earlier versions, use require
instead of plugins
.
Command line
rubocop --plugin rubocop-vicenzo
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 the created tag, and push the .gem
file to rubygems.org.
Creating a new cop
bundle exec rake 'new_cop[Vicenzo/OptionalNamespace/CopName]'
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-vicenzo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Rubocop::Vicenzo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.