Enable and configure Naming/InclusiveLanguage

Shopify · Jul 5, 2021 · 293b13a · 293b13a
1 parent 5fe88eb
commit 293b13a
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 4 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     rubocop-shopify (2.1.0)
-      rubocop (~> 1.17)
+      rubocop (~> 1.18)
 
 GEM
   remote: https://rubygems.org/

diff --git a/rubocop-shopify.gemspec b/rubocop-shopify.gemspec
@@ -21,5 +21,5 @@ Gem::Specification.new do |s|
     "allowed_push_host" => "https://rubygems.org",
   }
 
-  s.add_dependency("rubocop", "~> 1.17")
+  s.add_dependency("rubocop", "~> 1.18")
 end
diff --git a/rubocop.yml b/rubocop.yml
@@ -340,7 +340,17 @@ Naming/HeredocDelimiterNaming:
   Enabled: false
 
 Naming/InclusiveLanguage:
-  Enabled: false
+  Enabled: true
+  FlaggedTerms:
+    master:
+      Suggestions:
+        - main
+        - primary
+        - leader
+      AllowedRegex:
+        - !ruby/regexp '/master[_\s\.]key/' # Rails master key
+        - 'blob/master/'
+        - 'origin/master'
 
 Naming/MemoizedInstanceVariableName:
   Enabled: false

diff --git a/test/fixtures/full_config.yml b/test/fixtures/full_config.yml
@@ -1857,7 +1857,7 @@ Naming/HeredocDelimiterNaming:
   - !ruby/regexp /(^|\s)(EO[A-Z]{1}|END)(\s|$)/
 Naming/InclusiveLanguage:
   Description: Recommend the use of inclusive language instead of problematic terms.
-  Enabled: false
+  Enabled: true
   VersionAdded: '1.18'
   CheckIdentifiers: true
   CheckConstants: true
@@ -1882,6 +1882,15 @@ Naming/InclusiveLanguage:
       - replica
       - secondary
       - follower
+    master:
+      Suggestions:
+      - main
+      - primary
+      - leader
+      AllowedRegex:
+      - !ruby/regexp /master[_\s\.]key/
+      - blob/master/
+      - origin/master
 Naming/MemoizedInstanceVariableName:
   Description: Memoized method name should match memo instance variable name.
   Enabled: false