-
Notifications
You must be signed in to change notification settings - Fork 2
/
.rubocop.yml
216 lines (216 loc) · 4.54 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
---
inherit_from: .rubocop_todo.yml
require:
- rubocop-rspec
- rubocop/devtools
AllCops:
Exclude:
- 'test_app/**/*'
- 'tmp/**/*'
- vendor/**/*
DisplayCopNames: true
TargetRubyVersion: 2.3
# This ends up being too spammy
Style/Documentation:
Enabled: false
Layout/ExtraSpacing:
AllowForAlignment: true
Metrics/LineLength:
Max: 100
Metrics/BlockLength:
Exclude:
# Ignore RSpec DSL
- spec/**/*
# Ignore Rake task DSL
- Rakefile
Style/IfUnlessModifier:
MaxLineLength: 100
Style/Next:
EnforcedStyle: always
Style/PercentLiteralDelimiters:
PreferredDelimiters:
'%i': '[]'
'%I': '[]'
'%q': '{}'
'%Q': '{}'
'%r': '{}'
'%s': ()
'%w': '[]'
'%W': '[]'
'%x': ()
Style/TrivialAccessors:
ExactNameMatch: false
Style/SymbolArray:
Enabled: true
Style/BarePercentLiterals:
EnforcedStyle: percent_q
Style/CollectionMethods:
Enabled: true
Style/Send:
Enabled: true
Style/AutoResourceCleanup:
Enabled: true
Layout/FirstArrayElementLineBreak:
Enabled: true
Layout/FirstHashElementLineBreak:
Enabled: true
Layout/FirstMethodArgumentLineBreak:
Enabled: true
Layout/FirstMethodParameterLineBreak:
Enabled: true
Layout/MultilineArrayBraceLayout:
Enabled: true
Layout/MultilineAssignmentLayout:
EnforcedStyle: new_line
Enabled: true
Layout/MultilineHashBraceLayout:
Enabled: true
Layout/MultilineMethodCallBraceLayout:
Enabled: true
Layout/MultilineMethodDefinitionBraceLayout:
Enabled: true
Style/OptionHash:
Enabled: true
Style/StringMethods:
Enabled: true
Layout/IndentArray:
EnforcedStyle: consistent
Layout/IndentHash:
EnforcedStyle: consistent
MultilineMethodCallIndentation:
EnforcedStyle: indented
Style/Alias:
EnforcedStyle: prefer_alias_method
Layout/AlignHash:
EnforcedColonStyle: table
Style/SignalException:
EnforcedStyle: semantic
Style/SingleLineBlockParams:
Enabled: false
# We prefer being able to write
#
# foo(*%w[bar baz qux norf hello goodbye])
#
# over
#
# foo('bar', 'baz', 'qux', 'norf', 'hello', 'goodbye')
#
# because
#
# 1. the `%w` signals that all elements are strings without interpolation
# 2. the `%w` case is more compact
#
# The only exception is method invocations with a single argument. These
# cases should be `foo('bar')` and never `foo(*%w[bar])`
#
Lint/UnneededSplatExpansion:
Enabled: false
# We only use guard clauses when it guards two or more statements:
#
# # bad
# def foo
# return if bar
#
# baz
# end
#
# # good
# def foo
# baz if bar
# end
#
# This includes conditionals with an `else` branch:
#
# # bad
# def foo
# return qux if bar
#
# baz
# end
#
# # good
# def foo
# if bar
# qux
# else
# baz
# end
# end
#
# It is up to the author of the code in question if the condition concerns
# exactly two statements
#
# # ok
# def foo
# return if bar
#
# baz
# qux
# end
#
# # also ok
# def foo
# if bar
# baz
# qux
# end
# end
#
# Use a guard clause if more than two statements are being guarded by the conditional
#
# # bad
# def foo
# if bar
# baz
# qux
# norf
# end
# end
#
# # good
# def foo
# return if bar
#
# baz
# qux
# norf
# end
Style/GuardClause:
Enabled: false
# Prefer writing an empty method on two lines
#
# # good
# def foo
# end
#
# # bar
# def foo; end
#
Style/EmptyMethod:
EnforcedStyle: expanded
# RuboCop disables end alignment by default. Explanation:
#
# The end alignment cops are in the Lint category because the bad
# indentation could be something more serious than just a style issue.
# It could be a mistake in which keyword you think you're matching with the end.
# (ruby -w warns for these too, by the way.) So for this reason I don't think
# we can add auto-correct for these cops.
#
# From https://github.com/bbatsov/rubocop/pull/1789#issuecomment-92308357
#
# I think we have more than enough tools that sound the alarms if we have
# such an obvious mistake like mismatched tokens.
#
# - Our specs are likely to fail
# - RuboCop will flag it regardless, it just doesn't autocorrect it by default
# - Ruby will emit a warning which we configure to fail our specs
#
# So I think it is safe to enable autocorrect for end alignment cops because it
# does not seem unsafe and it improves workflow to be able to autocorrect alignment
Lint/DefEndAlignment:
AutoCorrect: true
# See explanation for `Lint/DefEndAlignment`
Lint/EndAlignment:
AutoCorrect: true
Style/MixinGrouping:
EnforcedStyle: grouped