Shared rubocop config to enforce Ruby style consistently across Wealthsimple libraries and services.
Upgrading to 3.x
1.x adds a number of Cops to our default.yml. See the relevant Quip for more information on how to upgrade.
Add this line to your application's Gemfile and execute
group :development, :test do gem 'ws-style' end
Or, for a rubygem, add this to your
To update an existing installation, just run
bundle update ws-style.
.rubocop.yml with the following directives:
inherit_gem: ws-style: - default.yml AllCops: # Specify your target Ruby version here (only major/minor versions): TargetRubyVersion: 2.3
Check if it works by running
bundle exec rubocop.
You can optionally override or specify additional style configurations in your
inherit_gem: ws-style: - default.yml AllCops: TargetRubyVersion: 2.4 Include: - 'db/**/*' Lint/RescueException: Enabled: false Style/HashSyntax: EnforcedStyle: hash_rockets
If you're using
ws-style in a non-Rails project, inherit from the core configuration file instead:
inherit_gem: ws-style: - core.yml
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.
New versions are automatically released by CI when merged to