Performance optimization analysis for your projects, as an extension to RuboCop.
Just install the
$ gem install rubocop-performance
or if you use bundler put this in your
gem 'rubocop-performance', require: false
You need to tell RuboCop to load the Performance extension. There are three ways to do this:
RuboCop configuration file
Put this into your
Alternatively, use the following array notation when specifying multiple extensions.
require: - rubocop-other-extension - rubocop-performance
Now you can run
rubocop and it will automatically load the RuboCop Performance
cops together with the standard cops.
$ rubocop --require rubocop-performance
RuboCop::RakeTask.new do |task| task.requires << 'rubocop-performance' end
All cops are located under
lib/rubocop/cop/performance, and contain
.rubocop.yml, you may treat the Performance cops just like any other
cop. For example:
Performance/Size: Exclude: - lib/example.rb
You can read a lot more about RuboCop Performance in its official docs.
RuboCop Performance complies with the RuboCop core compatibility.
See the compatibility documentation for further details.
Note: Performance cops are all MRI focused and are highly dependent of the version of MRI you're using.
Checkout the contribution guidelines.
rubocop-performance is MIT licensed. See the accompanying file for
the full text.