ezcater_rubocop
ezCater custom cops, and eventually shared rubocop configuration.
RuboCop is a static code analyzer that can enforce style conventions as well as identify common problems.
Installation
Add this line to your application's Gemfile:
group :development do
gem "ezcater_rubocop", require: false
end
And then execute:
$ bundle install
Or install it yourself as:
$ gem install ezcater_rubocop
Usage
Run rubocop
for an entire project:
$ bundle exec rubocop
See the rubocop
command-line for additional options including auto-generating
configuration for existing offenses and auto-correction.
Versioning
This gem is versioned based on the MAJOR.MINOR version of rubocop
. The first
release of the ezcater_rubocop
gem was v0.49.0.
The patch version for this gem does not correspond to the patch version of
rubocop
. The patch version for this gem will change any time that one of its
configurations is modified or its dependency on rubocop
is changed to require
a different patch version.
This gem also includes a dependency on rubocop-rspec
that will be updated to
the latest compatible version each time that the MAJOR.MINOR version of rubocop
is updated.
Custom Cops
- RailsConfiguration - Enforce use of
Rails.configuration
instead ofRails.application.config
. - RspecDotNotSelfDot - Enforce ".
" instead of "self. " for example group description. - RspecRequireBrowserMock - Enforce use of
mock_ezcater_app
,mock_chrome_browser
&mock_custom_browser
helpers instead of mockingBrowser
orEzBrowser
directly. - RspecRequireFeatureFlagMock - Enforce use of
mock_feature_flag
helper instead of mockingFeatureFlag.is_active?
directly. - RspecRequireGqlErrorHelpers - Use the helpers provided by
GQLErrors
instead of raisingGraphQL::ExecutionError
directly. - StyleDig - Recommend
dig
for deeply nested access.
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/ezcater/ezcater_rubocop.
License
The gem is available as open source under the terms of the MIT License.