Releases · Shopify/ruby-style-guide

15 Feb 18:45

sambostock

v2.15.1

fecd514

v2.15.1 Latest

Latest

What's Changed

Bug fixes

Add missing files to gemspec & bump version to 2.15.1 by @sambostock in #615
This should fix the cannot load such file -- rubocop/shopify/gem_version_string_comparable_backport error present in v2.15.0.

Full Changelog: v2.15.0...v2.15.1

Contributors

sambostock

Assets 2

15 Feb 16:56

sambostock

v2.15.0

f4a923d

v2.15.0

What's Changed

Enabled Cops

Changed Cops

Naming/InclusiveLanguage's AllowedRegex is changed to permit any unbroken word which includes master. (#564)
The motivation for this change is to avoid continuously needing to add exclusions such as mastercard, remaster, etc. to the list, while still allowing the cop to catch problematic uses of the word master.
Style/FrozenStringLiteralComment's EnforcedStyle is changed from always to always_true. (#589)
Consumers should aim to use frozen_string_literal: true in all files, but if certain files need frozen_string_literal: false, they should disable the cop in those files, mark them as TODO, or add them to the Exclude list.

Changed `AllCops` Configuration

NewCops is changed from enable to disable. (#581)
This silences the warning about pending cops for consumers, as the style guide maintainers will triage them instead.

Minimum RuboCop Version

Despite enabling new cops, the minimum RuboCop version is unchanged from the previous release, and remains 1.51.0.

Details

This is possible due to the new approach taken in rubocop.yml, in which ERB is used to conditionally enable cops based on the RuboCop version. (#582, #593, #612)

<% rubocop_version = Gem.loaded_specs.fetch("rubocop").version %>

<% if rubocop_version >= "1.23" %>
Department/NewCopName:
  Enabled: true
<% end %>

The motivation for this is to try the approach ahead of rubocop-shopify including optional configuration for rubocop-* extensions, which would need to work without adding dependencies on the extensions, or their versions.

Relevant PRs

Bump rubocop from 1.51.0 to 1.52.0 by @dependabot in #544
Bump rubocop from 1.52.0 to 1.53.1 by @dependabot in #550
Enable Style/IfWithBooleanLiteralBranches by @nvasilevski in #551
Allow remaster in Naming/InclusiveLanguage by @kpost in #564
Enable line continuation cops by @sambostock in #585
Disable new cops by default by @sambostock in #581
disallow multi-lines endless methods by @elfassy in #577
Enforce frozen_string_literal: true by @sambostock in #589
Bump rubocop from 1.56.4 to 1.57.1 by @dependabot in #582
Bump rubocop from 1.57.1 to 1.59.0 by @dependabot in #593
Reduce minimum RuboCop version back to ~> 1.51 by @sambostock in #612

New Contributors

@nvasilevski made their first contribution in #551
@kpost made their first contribution in #564
@elfassy made their first contribution in #577

Full Changelog: v2.14.0...v2.15.0

Contributors

kpost, elfassy, and 3 other contributors

Assets 2

09 Jun 20:22

rafaelfranca

v2.14.0

375cde7

v2.14.0

What's Changed

Enabled Cops

Changed Cops

Tweak Naming/InclusiveLanguage AllowedRegex to allow more git repository links (#535)

Minimum Rubocop Version

The minimum Rubocop version is now 1.51.0 (#541).

Relevant PRs

Bump rubocop from 1.50.0 to 1.50.1 by @dependabot in #531
Enable Style/ReturnNil cop by @larouxn in #529
Tweak Naming/InclusiveLanguage AllowedRegex by @sambostock in #535
Bump rubocop from 1.50.2 to 1.51.0 by @dependabot in #541
Enable the Lint/NoReturnInBeginEndBlocks cop by @catlee in #545

New Contributors

@catlee made their first contribution in #545

Full Changelog: v2.13.0...v2.14.0

Contributors

catlee, larouxn, and 2 other contributors

Assets 2

11 Apr 15:26

sambostock

v2.13.0

259a946

v2.13.0

What's Changed

Enabled Cops

The following cops have been enabled:

Changed Cops

Layout/LineLength now allows inline # rubocop:disable ... comments to exceed the line length. (#488)
Layout/LineLength now allows def test_... lines to exceed the line length limit, making it consistent with test "..." do lines, which were already permitted to exceed the limit. (#496)
Naming/MethodName now allows methods starting with test_ to violate the snake_case convention. (#511)
Style/AndOr now allows and and or outside of conditionals (which must still use && and || instead). (#515)

Minimum Rubocop Version

The minimum Rubocop version is now 1.50.0 (#525).

Relevant PRs

Ignore lines made long by cop directive comments by @sambostock in #488
Allow def test_... lines to be long by @sambostock in #496
Bump rubocop from 1.44.1 to 1.45.1 by @dependabot in #497
Bump rubocop from 1.45.1 to 1.48.0 by @dependabot in #510
Allow test_ method names to violate snake_case by @sambostock in #511
Bump rubocop from 1.48.0 to 1.48.1 by @dependabot in #513
Set Style/AndOr.EnforcedStyle to 'conditionals' by @cbothner in #515
Bump rubocop from 1.48.1 to 1.49.0 by @dependabot in #524
Bump rubocop from 1.49.0 to 1.50.0 by @dependabot in #525

New Contributors

@cbothner made their first contribution in #515

Full Changelog: v2.12.0...v2.13.0

Contributors

cbothner, sambostock, and dependabot

Assets 2

30 Jan 22:24

sambostock

v2.12.0

a1e210c

v2.12.0

What's Changed

Enabled Cops

The following cops have been enabled:

Lint/UselessRescue (#486)
Style/ArrayIntersect (#487)
Style/ComparableClamp (#486)
Style/InvertibleUnlessCondition (#486)
Style/OperatorMethodCall
- Originally enabled in #452
- Disabled in #474 due to rubocop/rubocop#11377
- Re-enabled in #475, after rubocop/rubocop#11378 was released