Yōshiki (様式)

Dev Fu! Style

rubygems build status

Because ruby code should be:

  • Readable.
  • Elegant.
  • Easily read by humans.
  • Approachable by newbs.
  • Clear to developers.
  • Profound to rubyists.

Make it so.

Usage

In your Gemfile:

gem 'yoshiki'

Just ruby (the only config that needs no extra plugins):

inherit_gem:
  yoshiki: .yoshiki-ruby.yml

Rspec — add the plugin, then inherit:

gem 'rubocop-rspec'

inherit_gem:
  yoshiki:
    - .yoshiki-ruby.yml
    - .yoshiki-rspec.yml

Rails — add the Rails RuboCop plugins, then inherit:

gem 'rubocop-rails'
gem 'rubocop-capybara'
gem 'rubocop-factory_bot'
gem 'rubocop-rspec_rails'

inherit_gem:
  yoshiki: .yoshiki-rails.yml

Full stack (ruby + rails + rspec) — declare all of the plugins above, then:

inherit_gem:
  yoshiki: .yoshiki.yml

Ruby compatibility