Rubocop::Katalyst

Katalyst's style guide for Ruby and Rails, in gem form. Katalyst does not at present have any custom cops; this is simply a repository for our configuration of the standard cops with Rails, Rake, Performance and RSpec extensions.

Cops are broken down by department; a file corresponding to each department can be found in the config directory, as well as the default.yml file which contains any global configuration and loads the cops. The .rubocop.yml file contains the configuration for this particular project as a guide for use in non-Rails environments.

Add this line to your application's Gemfile:

gem "rubocop-katalyst", require: false
gem "erb_lint", require: false # optional dependency

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rubocop-katalyst

Add the following to your .rubocop.yml file:

require:
  - rubocop-katalyst

inherit_mode:
  merge:
    - Exclude

You can integrate this gem with Rake by adding the following to your Rakefile:

require "rubocop/katalyst/rake_task"
RuboCop::Katalyst::RakeTask.new

require "rubocop/katalyst/erb_lint_task"
RuboCop::Katalyst::ErbLintTask.new

require "rubocop/katalyst/prettier_task"
RuboCop::Katalyst::PrettierTask.new

desc "Run lint before running RSpec"
task spec: :lint

That's it. You're all set to use Katalyst's base code styles. Override what you need in your .rubocop.yml file as the project demands.

The gem is designed for use with Rails, so if you're using this in a non-Rails environment, you can disable the Rails cops in your configuration file with:

Rails:
  Enabled: false

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/katalyst/rubocop-katalyst. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Rubocop::Katalyst project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.