rubocop-rails/.rubocop.yml at master · rubocop/rubocop-rails · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# This is the configuration used to check the rubocop source code.

inherit_from: .rubocop_todo.yml
plugins:
  - rubocop-internal_affairs
  - rubocop-performance
  - rubocop-rails
  - rubocop-rspec

AllCops:
  NewCops: enable
  Exclude:
    - 'vendor/**/*'
    - 'spec/fixtures/**/*'
    - 'tmp/**/*'
  TargetRubyVersion: 2.7
  SuggestExtensions: false
  # RuboCop Rails does not depend on Active Support.
  ActiveSupportExtensionsEnabled: false

InternalAffairs/NodeMatcherDirective:
  Enabled: false

Naming/InclusiveLanguage:
  Enabled: true
  CheckStrings: true
  FlaggedTerms:
    ' a offense':
      Suggestions:
        - an offense
    ' and offense':
      Suggestions:
        - ' an offense'
    auto-correct:
      Suggestions:
        - autocorrect
    auto_correct:
      Suggestions:
        - autocorrect
    behaviour:
      Suggestions:
        - behavior
    offence:
      Suggestions:
        - offense
    'does not registers':
      Suggestions:
        - does not register
    'register no offense':
      Suggestions:
        - registers no offense
    'register an error':
      Suggestions:
        - register an offense
    'registers an error':
      Suggestions:
        - registers an offense
    'does not register and corrects':
      Suggestions:
        does not register
    'does not register an offense and corrects':
      Suggestions:
        does not register an offense
  # These are excluded for compatible API names. RuboCop Rails 3.0 will fix it.
  Exclude:
    - lib/rubocop/cop/rails/dynamic_find_by.rb
    - lib/rubocop/cop/rails/skips_model_validations.rb
    - spec/rubocop/cop/rails/dynamic_find_by_spec.rb
    - spec/rubocop/cop/rails/skips_model_validations_spec.rb

Naming/PredicatePrefix:
  # Method define macros for dynamically generated method.
  MethodDefinitionMacros:
    - define_method
    - define_singleton_method
    - def_node_matcher
    - def_node_search

Rails:
  Enabled: false

Style/FormatStringToken:
  # Because we parse a lot of source codes from strings. Percent arrays
  # look like unannotated format string tokens to this cop.
  Exclude:
    - spec/**/*

Layout/HashAlignment:
  EnforcedHashRocketStyle:
    - key
    - table
  EnforcedColonStyle:
    - key
    - table

Layout/EndOfLine:
  EnforcedStyle: lf

Layout/ClassStructure:
  Enabled: true
  Categories:
    module_inclusion:
      - include
      - prepend
      - extend
  ExpectedOrder:
    - module_inclusion
    - constants
    - public_class_methods
    - initializer
    - instance_methods
    - protected_methods
    - private_methods

Layout/RedundantLineBreak:
  Enabled: true

# Trailing white space is meaningful in code examples
Layout/TrailingWhitespace:
  AllowInHeredoc: true

Lint/AmbiguousBlockAssociation:
  Exclude:
    - 'spec/**/*.rb'

Lint/InterpolationCheck:
  Exclude:
    - 'spec/**/*.rb'

Lint/UselessAccessModifier:
  MethodCreatingMethods:
    - 'def_matcher'
    - 'def_node_matcher'

Metrics/BlockLength:
  Exclude:
    - 'Rakefile'
    - '**/*.rake'
    - 'spec/**/*.rb'
    - '*.gemspec'

Naming/FileName:
  Exclude:
    - lib/rubocop-rails.rb

Metrics/ModuleLength:
  Exclude:
    - 'spec/**/*.rb'

Performance/DeletePrefix:
  SafeMultiline: false

Performance/DeleteSuffix:
  SafeMultiline: false

RSpec:
  Language:
    Expectations:
      - expect_correction
      - expect_no_offenses
      - expect_offense
      - expect_offense_if_model_file

RSpec/PredicateMatcher:
  EnforcedStyle: explicit

RSpec/NestedGroups:
  Max: 7