[rubocop#8827] Change Style/FormatStringToken style to template

pirj · Jun 19, 2022 · 0207a03 · 0207a03
1 parent 736e8d6
commit 0207a03
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 20 deletions.
diff --git a/changelog/change_style_format_string_token_enforced_style_to_template.md b/changelog/change_style_format_string_token_enforced_style_to_template.md
@@ -0,0 +1 @@
+* [#8827](https://github.com/rubocop/rubocop/issues/8827): Change the enforced style of `Style/FormatStringToken` to `template`. ([@pirj][])
diff --git a/config/default.yml b/config/default.yml
@@ -3635,20 +3635,20 @@ Style/FormatString:
 Style/FormatStringToken:
   Description: 'Use a consistent style for format string tokens.'
   Enabled: true
-  EnforcedStyle: annotated
+  EnforcedStyle: template
   SupportedStyles:
+    # Prefer simple looking "template" style tokens like `%{name}`, `%{age}`
+    - template
     # Prefer tokens which contain a sprintf like type annotation like
     # `%<name>s`, `%<age>d`, `%<score>f`
     - annotated
-    # Prefer simple looking "template" style tokens like `%{name}`, `%{age}`
-    - template
     - unannotated
   # `MaxUnannotatedPlaceholdersAllowed` defines the number of `unannotated`
   # style token in a format string to be allowed when enforced style is not
   # `unannotated`.
   MaxUnannotatedPlaceholdersAllowed: 1
   VersionAdded: '0.49'
-  VersionChanged: '1.0'
+  VersionChanged: '<<next>>'
   IgnoredMethods: []
 
 Style/FrozenStringLiteralComment:

diff --git a/docs/modules/ROOT/pages/cops_style.adoc b/docs/modules/ROOT/pages/cops_style.adoc
@@ -4208,7 +4208,7 @@ puts '%10s' % 'hoge'
 | Yes
 | No
 | 0.49
-| 1.0
+| <<next>>
 |===
 
 Use a consistent style for named format string tokens.
@@ -4227,28 +4227,28 @@ if the number of them is less than or equals to
 
 === Examples
 
-==== EnforcedStyle: annotated (default)
+==== EnforcedStyle: template (default)
 
 [source,ruby]
 ----
 # bad
-format('%{greeting}', greeting: 'Hello')
+format('%<greeting>s', greeting: 'Hello')
 format('%s', 'Hello')
 
 # good
-format('%<greeting>s', greeting: 'Hello')
+format('%{greeting}', greeting: 'Hello')
 ----
 
-==== EnforcedStyle: template
+==== EnforcedStyle: annotated
 
 [source,ruby]
 ----
 # bad
-format('%<greeting>s', greeting: 'Hello')
+format('%{greeting}', greeting: 'Hello')
 format('%s', 'Hello')
 
 # good
-format('%{greeting}', greeting: 'Hello')
+format('%<greeting>s', greeting: 'Hello')
 ----
 
 ==== EnforcedStyle: unannotated
@@ -4300,8 +4300,8 @@ redirect('foo/%{bar_id}')
 | Name | Default value | Configurable values
 
 | EnforcedStyle
-| `annotated`
-| `annotated`, `template`, `unannotated`
+| `template`
+| `template`, `annotated`, `unannotated`
 
 | MaxUnannotatedPlaceholdersAllowed
 | `1`

diff --git a/lib/rubocop/cop/style/format_string_token.rb b/lib/rubocop/cop/style/format_string_token.rb
@@ -13,23 +13,23 @@ module Style
       #
       # This cop can be customized ignored methods with `IgnoredMethods`.
       #
-      # @example EnforcedStyle: annotated (default)
+      # @example EnforcedStyle: template (default)
       #
       #   # bad
-      #   format('%{greeting}', greeting: 'Hello')
+      #   format('%<greeting>s', greeting: 'Hello')
       #   format('%s', 'Hello')
       #
       #   # good
-      #   format('%<greeting>s', greeting: 'Hello')
+      #   format('%{greeting}', greeting: 'Hello')
       #
-      # @example EnforcedStyle: template
+      # @example EnforcedStyle: annotated
       #
       #   # bad
-      #   format('%<greeting>s', greeting: 'Hello')
+      #   format('%{greeting}', greeting: 'Hello')
       #   format('%s', 'Hello')
       #
       #   # good
-      #   format('%{greeting}', greeting: 'Hello')
+      #   format('%<greeting>s', greeting: 'Hello')
       #
       # @example EnforcedStyle: unannotated
       #

diff --git a/spec/rubocop/cop/style/format_string_token_spec.rb b/spec/rubocop/cop/style/format_string_token_spec.rb
@@ -90,7 +90,7 @@
       it_behaves_like 'maximum allowed unannotated', token
     end
 
-    context 'when enforced style is template' do
+    context 'when enforced style is template (default)' do
       let(:enforced_style) { :template }
 
       it 'registers offenses for annotated style' do