Shopify Ruby Style Guide Versions Save

Shopify’s Ruby Style Guide

v2.8.0

1 year ago

What's Changed

  • Require Rubocop 1.31.0
  • Enable Lint/ConstantOverwrittenInRescue.

Full Changelog: https://github.com/Shopify/ruby-style-guide/compare/v2.7.1...v2.8.0

v2.7.1

1 year ago

What's Changed

Non consumer facing change omitted.

New Contributors

Full Changelog: https://github.com/Shopify/ruby-style-guide/compare/v2.7.0...v2.7.1

v2.7.0

1 year ago

What's Changed

New Contributors

Full Changelog: https://github.com/Shopify/ruby-style-guide/compare/v2.6.0...v2.7.0

v2.6.0

2 years ago

What's Changed

Note that the minimum required Rubocop version has been updated to 1.29.

Full Changelog: https://github.com/Shopify/ruby-style-guide/compare/v2.5.0...v2.6.0

v2.5.0

2 years ago

What's Changed

Full Changelog: https://github.com/Shopify/ruby-style-guide/compare/v2.4.0...v2.5.0

v2.4.0

2 years ago

What's Changed

  • Upgraded Rubocop to 1.24
  • Enabled Lint/UselessRuby2Keywords
  • Enabled Style/OpenStructUse

Full Changelog: https://github.com/Shopify/ruby-style-guide/compare/v2.3.0...v2.4.0

v2.3.0

2 years ago

🍂 🍁 🎃 Happy autumn! 🎃 🍁 🍂

This release includes a change in our update policy. So far we've been very conservative about enabling new cops and rules in the name of not breaking anyone's setups and CI servers. However this also means we've been missing out in a lot of new features and capabilities from the latest versions of RuboCop. That is why from now on we might enable new cops in minor versions of the Ruby Style Guide according to their value and ease of adoption.

For 2.3.0 Pumpkin Spice Latte edition, we've revisited all the cops from the Bundler, Gemspec, and Layout departments and added some additions to our RuboCop config. Most of these changes are autocorrectable. Please try them out and if you have any feedback feel free to open a discussion on GitHub!

Notable changes:

  • Enable Layout cops (#319)
  • Enable Gemspec cops (#317)
  • Enable Bundler cops (#316)
  • Enable Style/ExplicitBlockArgument cop (#314)
  • Add the mastercard brand to AllowedRegex of Naming/InclusiveLanguage (#306)

Stay safe, everyone 👋🏼

v2.2.0

2 years ago
  • Use RuboCop 1.18.
  • Disable Lint/ShadowingOuterLocalVariable cop (#273).
  • Enforce consistent comma in Array and Hash literals (#276).
  • Enable Style/InPatternThen and Style/QuotedSymbols cops (#278).
  • Enable Naming/InclusiveLanguage cop (#288).

I'm gonna try to be direct and brief in my release notes so far. You know, everybody's busy these days and I don't want to bother too much just because you want to make sure I'm not breaking your RuboCop CI. Rest assured that I'm trying my best to avoid any breaking changes, promise 😚

Anyway, I hope you and your loved ones are doing well, wherever you are. Coding is great and stuff, but don't forget to disconnect from your screens from time to time. The world is a beautiful place with many possibilities. I recommend also to stay hydrated, exercise, and go for walks in whatever green spaces you have around you. It really makes a difference.

Oh and in case you haven't heard this in a while: you are awesome, just the way you are, and you deserve to be happy. Have a lovely day!

v2.1.0

3 years ago

Thank you for reading our release notes! I'm never sure if folks really check this out. After all, if a tree falls in a forest but it doesn't introduce breaking changes, does it count as a release? Anyway, here's what's new:

  • We now require RuboCop 1.13 and up.
  • Inherit mode is now set to merge configs for inclusions and exclusions. In case you want to completely override exclusions and inclusions, you might need to explicit configure your preferred inherit mode in your RuboCop config file. More info in the PR: #250
  • The Lint/Syntax cop is now enabled. It goes without saying but syntax errors do violate the Style Guide! (PR #254)
  • We also re-enabled the Layout/BeginEndAlignment cop. It was disabled in the past due to a bug, and now it's back to fix your code blocks! (PR #258)
  • This is a big one: we finally removed the DisabledByDefault: true setting and we disabled all unwanted cops one-by-one. This should not have any consequence for most people using our gem, but in case you are using other RuboCop extensions or your own custom cops, you might notice that now everything comes enabled by default (unless you are disabling them yourself). If you were overriding this setting to false you might also be able to remove it from your RuboCop config file. (PR #220)
  • Last but not least: Style/WordArray and Style/SymbolArray are now enabled and set to enforce the brackets style. This rule was actually introduced back in 2019 to the Style Guide but we did not enforce it with RuboCop. Well, now we do! (and therefore we are not considering this a breaking change). (PR #256)

v2.0.1

3 years ago
  • Fix rubocop-cli.yml to inherit from rubocop.yml (#245).