Cut 1.35

Author: bbatsov

.github/ISSUE_TEMPLATE/bug_report.md

@@ -38,7 +38,7 @@ output by `rubocop -V`, include them as well. Here's an example:
 
 ```
 $ [bundle exec] rubocop -V
-1.34.1 (using Parser 2.7.2.0, rubocop-ast 1.1.1, running on ruby 2.7.2 x86_64-linux)
+1.35.0 (using Parser 2.7.2.0, rubocop-ast 1.1.1, running on ruby 2.7.2 x86_64-linux)
   - rubocop-performance 1.9.1
   - rubocop-rspec 2.0.0
 ```

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## master (unreleased)
 
+## 1.35.0 (2022-08-12)
+
 ### New features
 
 * [#9364](https://github.com/rubocop/rubocop/pull/9364): Add `Style/MagicCommentFormat` cop. ([@dvandersluis][], [@mattbearman][])

CONTRIBUTING.md

@@ -17,7 +17,7 @@ do so.
 
 ```console
 $ rubocop -V
-1.34.1 (using Parser 2.7.2.0, rubocop-ast 1.1.1, running on ruby 2.7.2 x86_64-linux)
+1.35.0 (using Parser 2.7.2.0, rubocop-ast 1.1.1, running on ruby 2.7.2 x86_64-linux)
   - rubocop-performance 1.9.1
   - rubocop-rspec 2.0.0
 ```

README.md

@@ -53,7 +53,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.34', require: false
+gem 'rubocop', '~> 1.35', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.

config/default.yml

@@ -4020,7 +4020,7 @@ Style/LineEndConcatenation:
 Style/MagicCommentFormat:
   Description: 'Use a consistent style for magic comments.'
   Enabled: pending
-  VersionAdded: '<<next>>'
+  VersionAdded: '1.35'
   EnforcedStyle: snake_case
   SupportedStyles:
     # `snake` will enforce the magic comment is written

docs/antora.yml

@@ -2,6 +2,6 @@ name: rubocop
 title: RuboCop
 # We always provide version without patch here (e.g. 1.1),
 # as patch versions should not appear in the docs.
-version: ~
+version: '1.35'
 nav:
   - modules/ROOT/nav.adoc

docs/modules/ROOT/pages/cops.adoc

@@ -471,6 +471,7 @@ In the following section you find all available cops:
 * xref:cops_style.adoc#stylelambda[Style/Lambda]
 * xref:cops_style.adoc#stylelambdacall[Style/LambdaCall]
 * xref:cops_style.adoc#stylelineendconcatenation[Style/LineEndConcatenation]
+* xref:cops_style.adoc#stylemagiccommentformat[Style/MagicCommentFormat]
 * xref:cops_style.adoc#stylemapcompactwithconditionalblock[Style/MapCompactWithConditionalBlock]
 * xref:cops_style.adoc#stylemaptohash[Style/MapToHash]
 * xref:cops_style.adoc#stylemethodcallwithargsparentheses[Style/MethodCallWithArgsParentheses]

docs/modules/ROOT/pages/cops_layout.adoc

@@ -4278,6 +4278,7 @@ are recommended to further format the broken lines.
 (Many of these are enabled by default.)
 
 * ArgumentAlignment
+* ArrayAlignment
 * BlockAlignment
 * BlockDelimiters
 * BlockEndNewline

docs/modules/ROOT/pages/cops_lint.adoc

@@ -2284,18 +2284,18 @@ NOTE: Required Ruby version: 2.6
 
 This cop emulates the following Ruby warnings in Ruby 2.6.
 
+[source,console]
+----
 % cat example.rb
 ERB.new('hi', nil, '-', '@output_buffer')
 % ruby -rerb example.rb
-example.rb:1: warning: Passing safe_level with the 2nd argument of
-ERB.new is deprecated. Do not use it, and specify other arguments as
-keyword arguments.
-example.rb:1: warning: Passing trim_mode with the 3rd argument of
-ERB.new is deprecated. Use keyword argument like
-ERB.new(str, trim_mode:...) instead.
-example.rb:1: warning: Passing eoutvar with the 4th argument of ERB.new
-is deprecated. Use keyword argument like ERB.new(str, eoutvar: ...)
-instead.
+example.rb:1: warning: Passing safe_level with the 2nd argument of ERB.new is
+deprecated. Do not use it, and specify other arguments as keyword arguments.
+example.rb:1: warning: Passing trim_mode with the 3rd argument of ERB.new is
+deprecated. Use keyword argument like ERB.new(str, trim_mode:...) instead.
+example.rb:1: warning: Passing eoutvar with the 4th argument of ERB.new is
+deprecated. Use keyword argument like ERB.new(str, eoutvar: ...) instead.
+----
 
 Now non-keyword arguments other than first one are softly deprecated
 and will be removed when Ruby 2.5 becomes EOL.

docs/modules/ROOT/pages/cops_style.adoc

@@ -5180,6 +5180,7 @@ The supported styles are:
 * always - forces use of the 3.1 syntax (e.g. {foo:})
 * never - forces use of explicit hash literal value
 * either - accepts both shorthand and explicit use of hash literal value
+* consistent - like "always", but will avoid mixing styles in a single hash
 
 === Examples
 
@@ -5268,6 +5269,23 @@ The supported styles are:
 {foo:, bar:}
 ----
 
+==== EnforcedShorthandSyntax: consistent
+
+[source,ruby]
+----
+# bad
+{foo: , bar: bar}
+
+# good
+{foo:, bar:}
+
+# bad
+{foo: , bar: baz}
+
+# good
+{foo: foo, bar: baz}
+----
+
 === Configurable attributes
 
 |===
@@ -5279,7 +5297,7 @@ The supported styles are:
 
 | EnforcedShorthandSyntax
 | `always`
-| `always`, `never`, `either`
+| `always`, `never`, `either`, `consistent`
 
 | UseHashRocketsWithSymbolValues
 | `false`
@@ -6250,6 +6268,161 @@ some_str = 'ala' \
            'bala'
 ----
 
+== Style/MagicCommentFormat
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Pending
+| Yes
+| Yes
+| 1.35
+| -
+|===
+
+Ensures magic comments are written consistently throughout your code base.
+Looks for discrepancies in separators (`-` vs `_`) and capitalization for
+both magic comment directives and values.
+
+Required capitalization can be set with the `DirectiveCapitalization` and
+`ValueCapitalization` configuration keys.
+
+NOTE: If one of these configuration is set to nil, any capitalization is allowed.
+
+=== Examples
+
+==== EnforcedStyle: snake_case (default)
+
+[source,ruby]
+----
+# The `snake_case` style will enforce that the frozen string literal
+# comment is written in snake case. (Words separated by underscores)
+# bad
+# frozen-string-literal: true
+
+module Bar
+  # ...
+end
+
+# good
+# frozen_string_literal: false
+
+module Bar
+  # ...
+end
+----
+
+==== EnforcedStyle: kebab_case
+
+[source,ruby]
+----
+# The `kebab_case` style will enforce that the frozen string literal
+# comment is written in kebab case. (Words separated by hyphens)
+# bad
+# frozen_string_literal: true
+
+module Baz
+  # ...
+end
+
+# good
+# frozen-string-literal: true
+
+module Baz
+  # ...
+end
+----
+
+==== DirectiveCapitalization: lowercase (default)
+
+[source,ruby]
+----
+# bad
+# FROZEN-STRING-LITERAL: true
+
+# good
+# frozen-string-literal: true
+----
+
+==== DirectiveCapitalization: uppercase
+
+[source,ruby]
+----
+# bad
+# frozen-string-literal: true
+
+# good
+# FROZEN-STRING-LITERAL: true
+----
+
+==== DirectiveCapitalization: nil
+
+[source,ruby]
+----
+# any capitalization is accepted
+
+# good
+# frozen-string-literal: true
+
+# good
+# FROZEN-STRING-LITERAL: true
+----
+
+==== ValueCapitalization: nil (default)
+
+[source,ruby]
+----
+# any capitalization is accepted
+
+# good
+# frozen-string-literal: true
+
+# good
+# frozen-string-literal: TRUE
+----
+
+==== ValueCapitalization: lowercase
+
+[source,ruby]
+----
+# when a value is not given, any capitalization is accepted
+
+# bad
+# frozen-string-literal: TRUE
+
+# good
+# frozen-string-literal: TRUE
+----
+
+==== ValueCapitalization: uppercase
+
+[source,ruby]
+----
+# bad
+# frozen-string-literal: true
+
+# good
+# frozen-string-literal: TRUE
+----
+
+=== Configurable attributes
+
+|===
+| Name | Default value | Configurable values
+
+| EnforcedStyle
+| `snake_case`
+| `snake_case`, `kebab_case`
+
+| DirectiveCapitalization
+| `lowercase`
+| String
+
+| ValueCapitalization
+| `<none>`
+| 
+|===
+
 == Style/MapCompactWithConditionalBlock
 
 |===