-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path.rubocop.yml
228 lines (165 loc) · 5.43 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
AllCops:
TargetRubyVersion: 2.5.0
Style/SingleLineMethods:
Exclude:
- 'test/**/*.rb'
# Don't leave calls to pry lying around.
Lint/Debugger:
Enabled: true
# ==============================================================================
# Documentation
# ==============================================================================
Style/Documentation:
Enabled: true
Exclude:
- 'test/**/*.rb'
Style/DocumentationMethod:
Enabled: true
Exclude:
- 'test/**/*.rb'
# ==============================================================================
# Naming
# ==============================================================================
Naming/MethodParameterName:
AllowedNames:
- el
- id
Naming/MethodName:
Enabled: true
Exclude:
- 'lib/definitions/**/*.rb'
- 'build/**/*.rb'
Naming/ClassAndModuleCamelCase:
Enabled: true
Exclude:
- 'lib/definitions/**/*.rb'
- 'build/**/*.rb'
# ==============================================================================
# Layout
# ==============================================================================
Metrics/LineLength:
Max: 150
Layout/EmptyLineAfterGuardClause:
Enabled: false
Layout/EmptyLinesAroundModuleBody:
Enabled: false
Layout/EmptyLinesAroundClassBody:
Enabled: false
Layout/EmptyLinesAroundBlockBody:
Enabled: false
# https://unix.stackexchange.com/a/18789
Layout/TrailingEmptyLines:
EnforcedStyle: final_newline
# ==============================================================================
# Strings
# ==============================================================================
Style/StringLiterals:
EnforcedStyle: double_quotes
Style/FrozenStringLiteralComment:
Enabled: false
Naming/HeredocDelimiterNaming:
Enabled: false
Style/FormatString:
EnforcedStyle: sprintf
Style/FormatStringToken:
# EnforcedStyle: template
Enabled: false
# ==============================================================================
# Numbers
# ==============================================================================
Style/ZeroLengthPredicate:
Enabled: false
Style/NumericPredicate:
Enabled: false
# preferably `EnforcedStyle: snake_case`, but it varies.
Naming/VariableNumber:
Enabled: false
# ==============================================================================
# Braces, Brackets, and Parentheses
# ==============================================================================
Style/DefWithParentheses:
Enabled: false
Style/MethodCallWithoutArgsParentheses:
Enabled: false
Style/WordArray:
EnforcedStyle: brackets
Style/SymbolArray:
EnforcedStyle: brackets
# ==============================================================================
# Trailing Commas
# ==============================================================================
Style/TrailingCommaInArguments:
EnforcedStyleForMultiline: comma
Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: comma
Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: comma
# ==============================================================================
# Fewer lines doesn't mean better code
# ==============================================================================
Metrics/ModuleLength:
Enabled: false
Metrics/ClassLength:
Enabled: false
Metrics/MethodLength:
Enabled: false
Metrics/BlockLength:
Enabled: false
# TODO: Look into adding an `EnforcedStyle` to not use guard clauses.
Style/GuardClause:
Enabled: false
# TODO: Look into adding an `EnforcedStyle` to not use if/unless modifiers.
Style/IfUnlessModifier:
Enabled: false
Style/Next:
Enabled: false
# ==============================================================================
# Explicit, not redundant
# ==============================================================================
Style/RedundantReturn:
Enabled: false
Style/RedundantSelf:
Enabled: false
# ==============================================================================
# Exceptions
# ==============================================================================
Lint/SuppressedException:
AllowComments: true
Style/RaiseArgs:
EnforcedStyle: exploded
# ==============================================================================
# Unsorted
# ==============================================================================
# Default value (special_inside_parentheses) is ridiculous.
# Look for yourself: https://www.rubydoc.info/gems/rubocop/0.69.0/RuboCop/Cop/Layout/IndentFirstHashElement
Layout/FirstHashElementIndentation:
EnforcedStyle: consistent
# Default value (special_inside_parentheses) is ridiculous.
# Look for yourself: https://www.rubydoc.info/gems/rubocop/0.69.0/RuboCop/Cop/Layout/IndentFirstArrayElement
Layout/FirstArrayElementIndentation:
EnforcedStyle: consistent
Layout/HashAlignment:
Enabled: false
# `x&.y&.[](:argument)` isn't what I'd call "readable".
# https://stackoverflow.com/questions/34794697/using-with-the-safe-navigation-operator-in-ruby
Style/SafeNavigation:
Enabled: false
Style/NegatedIf:
EnforcedStyle: postfix
# TODO: File issue to ignore enums when using `EnforcedStyle: assign_inside_condition`.
Style/ConditionalAssignment:
Enabled: false
Style/TernaryParentheses:
EnforcedStyle: require_parentheses_when_complex
Metrics/AbcSize:
Enabled: false
Metrics/CyclomaticComplexity:
Enabled: false
Metrics/PerceivedComplexity:
Enabled: false
Style/CommentedKeyword:
Enabled: False
Style/AsciiComments:
Enabled: false
Lint/EmptyWhen:
Enabled: false