RuboCop has many stylistic rules (RuboCop calls a rule "Cop"). "Style Cops" provide one of several settings. So, we encounter many many warnings when we introduce RuboCop. The cause is a mismatch between the RuboCop's default settings and your project's coding style.
In the configuration of MeowCop, almost all stylistic rules are disabled. Because such rules are almost specific for your project. If you want, you can use RuboCop as a linter without many noisy warnings.
In contrast, if you want to use RuboCop as a style checker, we recommend Gry.
Add this line to your application's Gemfile:
And then execute:
$ bundle install
Or install it yourself as:
$ gem install meowcop
MeowCop provides a CLI tool to initialize
.rubocop.yml. See below:
$ meowcop init Meow! .rubocop.yml has been created successfully. $ cat .rubocop.yml # To use the MeowCop gem. inherit_gem: meowcop: - config/rubocop.yml # You can customize RuboCop settings. # For example. # Style/FrozenStringLiteralComment: # Enabled: true # EnforcedStyle: always
See this example.
Just execute RuboCop with
.rubocop.yml configured by MeowCop:
$ bundle exec rubocop
After checking out the repo, run
bin/setup to install dependencies. 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,
- Move to the master branch and fetch the latest revision. E.g.
git checkout master && git pull
- Update the version number in
- Update the changelog.
- Commit the updated files with the following message:
- Run the
bundle exec rake releasecommand. This command will:
- create a git tag for the new version
- push the git commit and tag
- push the
.gemfile to rubygems.org
Bug reports and pull requests are welcome on GitHub at https://github.com/sider/meowcop.