-
Notifications
You must be signed in to change notification settings - Fork 524
/
.rubocop.yml
311 lines (249 loc) · 6.25 KB
/
.rubocop.yml
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
Style/MultipleComparison:
Enabled: false
Style/PercentLiteralDelimiters:
Enabled: false
# kind_of? is a good way to check a type
Style/ClassCheck:
EnforcedStyle: kind_of?
Style/FrozenStringLiteralComment:
Enabled: false
# This doesn't work with older versions of Ruby (pre 2.4.0)
Style/SafeNavigation:
Enabled: false
# This doesn't work with older versions of Ruby (pre 2.4.0)
Performance/RegexpMatch:
Enabled: false
# This suggests use of `tr` instead of `gsub`. While this might be more performant,
# these methods are not at all interchangable, and behave very differently. This can
# lead to people making the substitution without considering the differences.
Performance/StringReplacement:
Enabled: false
# .length == 0 is also good, we don't always want .zero?
Style/NumericPredicate:
Enabled: false
# this would cause errors with long lanes
Metrics/BlockLength:
Enabled: false
# this is a bit buggy
Metrics/ModuleLength:
Enabled: false
# certificate_1 is an okay variable name
Style/VariableNumber:
Enabled: false
# This is used a lot across the fastlane code base for config files
Style/MethodMissing:
Enabled: false
# This rule isn't useful, lots of discussion happening around it also
# e.g. https://github.com/bbatsov/rubocop/issues/2338
MultilineBlockChain:
Enabled: false
#
# File.chmod(0777, f)
#
# is easier to read than
#
# File.chmod(0o777, f)
#
Style/NumericLiteralPrefix:
Enabled: false
#
# command = (!clean_expired.nil? || !clean_pattern.nil?) ? CLEANUP : LIST
#
# is easier to read than
#
# command = !clean_expired.nil? || !clean_pattern.nil? ? CLEANUP : LIST
#
Style/TernaryParentheses:
Enabled: false
# sometimes it is useful to have those empty methods
Style/EmptyMethod:
Enabled: false
# It's better to be more explicit about the type
Style/BracesAroundHashParameters:
Enabled: false
# specs sometimes have useless assignments, which is fine
Lint/UselessAssignment:
Exclude:
- '**/spec/**/*'
# In specs requires are done automatically
Require/MissingRequireStatement:
Exclude:
- '**/spec/**/*.rb'
- '**/spec_helper.rb'
- 'spaceship/lib/spaceship/babosa_fix.rb'
- '**/Fastfile'
- '**/*.gemspec'
- 'rakelib/**/*'
- '**/*.rake'
- '**/Rakefile'
- 'fastlane/**/*' # TODO: remove
- 'supply/**/*' # TODO: remove
# We could potentially enable the 2 below:
Layout/IndentHash:
Enabled: false
Layout/AlignHash:
Enabled: false
# HoundCI doesn't like this rule
Layout/DotPosition:
Enabled: false
# We allow !! as it's an easy way to convert to boolean
Style/DoubleNegation:
Enabled: false
# Prevent to replace [] into %i
Style/SymbolArray:
Enabled: false
# We still support Ruby 2.0.0
Layout/IndentHeredoc:
Enabled: false
# This cop would not work fine with rspec
Style/MixinGrouping:
Exclude:
- '**/spec/**/*'
# Sometimes we allow a rescue block that doesn't contain code
Lint/HandleExceptions:
Enabled: false
# Cop supports --auto-correct.
Lint/UnusedBlockArgument:
Enabled: false
Lint/AmbiguousBlockAssociation:
Enabled: false
# Needed for $verbose
Style/GlobalVars:
Enabled: false
# We want to allow class Fastlane::Class
Style/ClassAndModuleChildren:
Enabled: false
# $? Exit
Style/SpecialGlobalVars:
Enabled: false
Metrics/AbcSize:
Enabled: false
Metrics/MethodLength:
Enabled: false
Metrics/CyclomaticComplexity:
Enabled: false
# The %w might be confusing for new users
Style/WordArray:
MinSize: 19
# raise and fail are both okay
Style/SignalException:
Enabled: false
# Better too much 'return' than one missing
Style/RedundantReturn:
Enabled: false
# Having if in the same line might not always be good
Style/IfUnlessModifier:
Enabled: false
# "and" and "or" are okay
Style/AndOr:
Enabled: true
EnforcedStyle: conditionals
# Configuration parameters: CountComments.
Metrics/ClassLength:
Max: 320
# Configuration parameters: AllowURI, URISchemes.
Metrics/LineLength:
Max: 370
# Configuration parameters: CountKeywordArgs.
Metrics/ParameterLists:
Max: 17
Metrics/PerceivedComplexity:
Max: 18
# Sometimes it's easier to read without guards
Style/GuardClause:
Enabled: false
# We allow both " and '
Style/StringLiterals:
Enabled: false
# something = if something_else
# that's confusing
Style/ConditionalAssignment:
Enabled: false
# Better to have too much self than missing a self
Style/RedundantSelf:
Enabled: false
# e.g.
# def self.is_supported?(platform)
# we may never use `platform`
Lint/UnusedMethodArgument:
Enabled: false
# the let(:key) { ... }
Lint/ParenthesesAsGroupedExpression:
Exclude:
- '**/spec/**/*'
# This would reject is_ in front of methods
# We use `is_supported?` everywhere already
Style/PredicateName:
Enabled: false
# We allow the $
Style/PerlBackrefs:
Enabled: false
# Disable '+ should be surrounded with a single space' for xcodebuild_spec.rb
Layout/SpaceAroundOperators:
Exclude:
- '**/spec/actions_specs/xcodebuild_spec.rb'
AllCops:
TargetRubyVersion: 2.0
Include:
- '*/lib/assets/*Template'
- '*/lib/assets/*TemplateAndroid'
Exclude:
- '**/lib/assets/custom_action_template.rb'
- './vendor/**/*'
- '**/lib/assets/DefaultFastfileTemplate'
# They have not to be snake_case
Style/FileName:
Exclude:
- '**/Dangerfile'
- '**/Brewfile'
- '**/Gemfile'
- '**/Podfile'
- '**/Rakefile'
- '**/Fastfile'
- '**/Deliverfile'
- '**/Snapfile'
- '**/*.gemspec'
# We're not there yet
Style/Documentation:
Enabled: false
# Added after upgrade to 0.38.0
Style/MutableConstant:
Enabled: false
# length > 0 is good
Style/ZeroLengthPredicate:
Enabled: false
# Adds complexity
Style/IfInsideElse:
Enabled: false
# Sometimes we just want to 'collect'
Style/CollectionMethods:
Enabled: false
# Check whether fork is handled correctly on all platforms
CrossPlatform/ForkUsage:
Exclude:
- '**/plugins/template/**/*'
# ( ) for method calls
Style/MethodCallWithArgsParentheses:
Enabled: true
IgnoredMethods:
- 'require'
- 'require_relative'
- 'fastlane_require'
- 'gem'
- 'program'
- 'command'
- 'raise'
- 'attr_accessor'
- 'attr_reader'
- 'desc'
- 'lane'
- 'private_lane'
- 'platform'
# rspec tests code below
- 'to'
- 'describe'
- 'it'
- 'be'
- 'context'
- 'before'
- 'after'