Sha256: 0773bf308fcbaa50e4957490dada87c25520270820fa011862e8897dc6eba3ee
Contents?: true
Size: 1.89 KB
Versions: 16
Compression:
Stored size: 1.89 KB
Contents
# ws-style [](https://circleci.com/gh/wealthsimple/ws-style) [](https://rubygems.org/gems/ws-style)
Shared [rubocop](https://github.com/bbatsov/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.
## Installation
Add this line to your application's Gemfile and execute `bundle`:
```ruby
group :development, :test do
gem 'ws-style'
end
```
Or, for a rubygem, add this to your `gemspec`:
```ruby
spec.add_development_dependency 'ws-style'
```
To update an existing installation, just run `bundle update ws-style`.
## Usage
Create a `.rubocop.yml` with the following directives:
```yaml
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 `.rubocop.yml`, e.g.:
```yaml
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:
```yaml
inherit_gem:
ws-style:
- core.yml
```
## 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`.
New versions are automatically released by CI when merged to `master`.
Version data entries
16 entries across 16 versions & 1 rubygems