docquet 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +20 -0
- data/LICENSE +21 -0
- data/README.md +205 -0
- data/config/cops/bundler.yml +19 -0
- data/config/cops/capybara.yml +1 -0
- data/config/cops/capybara_rspec.yml +1 -0
- data/config/cops/gemspec.yml +4 -0
- data/config/cops/i18n_gettext.yml +2 -0
- data/config/cops/i18n_railsi18n.yml +1 -0
- data/config/cops/layout.yml +79 -0
- data/config/cops/lint.yml +7 -0
- data/config/cops/metrics.yml +14 -0
- data/config/cops/migration.yml +2 -0
- data/config/cops/naming.yml +4 -0
- data/config/cops/performance.yml +7 -0
- data/config/cops/rake.yml +5 -0
- data/config/cops/rspec.yml +41 -0
- data/config/cops/security.yml +1 -0
- data/config/cops/sequel.yml +2 -0
- data/config/cops/style.yml +153 -0
- data/config/cops/thread_safety.yml +5 -0
- data/config/defaults/bundler.yml +97 -0
- data/config/defaults/capybara.yml +103 -0
- data/config/defaults/capybara_rspec.yml +24 -0
- data/config/defaults/gemspec.yml +121 -0
- data/config/defaults/i18n_gettext.yml +20 -0
- data/config/defaults/i18n_railsi18n.yml +9 -0
- data/config/defaults/layout.yml +1121 -0
- data/config/defaults/lint.yml +1315 -0
- data/config/defaults/metrics.yml +119 -0
- data/config/defaults/migration.yml +9 -0
- data/config/defaults/naming.yml +332 -0
- data/config/defaults/performance.yml +445 -0
- data/config/defaults/rake.yml +34 -0
- data/config/defaults/rspec.yml +1081 -0
- data/config/defaults/security.yml +67 -0
- data/config/defaults/sequel.yml +59 -0
- data/config/defaults/style.yml +2985 -0
- data/config/defaults/thread_safety.yml +45 -0
- data/exe/docquet +7 -0
- data/lib/docquet/cli/base.rb +21 -0
- data/lib/docquet/cli/install_config.rb +75 -0
- data/lib/docquet/cli/regenerate_todo.rb +46 -0
- data/lib/docquet/cli.rb +6 -0
- data/lib/docquet/commands.rb +12 -0
- data/lib/docquet/config_processor.rb +52 -0
- data/lib/docquet/generators/rubocop_yml_generator.rb +78 -0
- data/lib/docquet/inflector.rb +22 -0
- data/lib/docquet/plugin_detector.rb +29 -0
- data/lib/docquet/rake_task.rb +126 -0
- data/lib/docquet/version.rb +6 -0
- data/lib/docquet.rb +17 -0
- data/templates/rubocop.yml.erb +35 -0
- metadata +172 -0
|
@@ -0,0 +1,1121 @@
|
|
|
1
|
+
# Department 'Layout' (100):
|
|
2
|
+
# Supports --autocorrect
|
|
3
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutaccessmodifierindentation
|
|
4
|
+
Layout/AccessModifierIndentation:
|
|
5
|
+
Description: Checks indentation of private/protected visibility modifiers.
|
|
6
|
+
StyleGuide: "#indent-public-private-protected"
|
|
7
|
+
Enabled: true
|
|
8
|
+
VersionAdded: '0.49'
|
|
9
|
+
EnforcedStyle: indent
|
|
10
|
+
SupportedStyles:
|
|
11
|
+
- outdent
|
|
12
|
+
- indent
|
|
13
|
+
IndentationWidth:
|
|
14
|
+
|
|
15
|
+
# Supports --autocorrect
|
|
16
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutargumentalignment
|
|
17
|
+
Layout/ArgumentAlignment:
|
|
18
|
+
Description: Align the arguments of a method call if they span more than one line.
|
|
19
|
+
StyleGuide: "#no-double-indent"
|
|
20
|
+
Enabled: true
|
|
21
|
+
VersionAdded: '0.68'
|
|
22
|
+
VersionChanged: '0.77'
|
|
23
|
+
EnforcedStyle: with_first_argument
|
|
24
|
+
SupportedStyles:
|
|
25
|
+
- with_first_argument
|
|
26
|
+
- with_fixed_indentation
|
|
27
|
+
IndentationWidth:
|
|
28
|
+
|
|
29
|
+
# Supports --autocorrect
|
|
30
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutarrayalignment
|
|
31
|
+
Layout/ArrayAlignment:
|
|
32
|
+
Description: Align the elements of an array literal if they span more than one line.
|
|
33
|
+
StyleGuide: "#no-double-indent"
|
|
34
|
+
Enabled: true
|
|
35
|
+
VersionAdded: '0.49'
|
|
36
|
+
VersionChanged: '0.77'
|
|
37
|
+
EnforcedStyle: with_first_element
|
|
38
|
+
SupportedStyles:
|
|
39
|
+
- with_first_element
|
|
40
|
+
- with_fixed_indentation
|
|
41
|
+
IndentationWidth:
|
|
42
|
+
|
|
43
|
+
# Supports --autocorrect
|
|
44
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutassignmentindentation
|
|
45
|
+
Layout/AssignmentIndentation:
|
|
46
|
+
Description: Checks the indentation of the first line of the right-hand-side of a
|
|
47
|
+
multi-line assignment.
|
|
48
|
+
Enabled: true
|
|
49
|
+
VersionAdded: '0.49'
|
|
50
|
+
VersionChanged: '1.45'
|
|
51
|
+
IndentationWidth:
|
|
52
|
+
|
|
53
|
+
# Supports --autocorrect
|
|
54
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutbeginendalignment
|
|
55
|
+
Layout/BeginEndAlignment:
|
|
56
|
+
Description: Align ends corresponding to begins correctly.
|
|
57
|
+
Enabled: true
|
|
58
|
+
VersionAdded: '0.91'
|
|
59
|
+
EnforcedStyleAlignWith: start_of_line
|
|
60
|
+
SupportedStylesAlignWith:
|
|
61
|
+
- start_of_line
|
|
62
|
+
- begin
|
|
63
|
+
Severity: warning
|
|
64
|
+
|
|
65
|
+
# Supports --autocorrect
|
|
66
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutblockalignment
|
|
67
|
+
Layout/BlockAlignment:
|
|
68
|
+
Description: Align block ends correctly.
|
|
69
|
+
Enabled: true
|
|
70
|
+
VersionAdded: '0.53'
|
|
71
|
+
EnforcedStyleAlignWith: either
|
|
72
|
+
SupportedStylesAlignWith:
|
|
73
|
+
- either
|
|
74
|
+
- start_of_block
|
|
75
|
+
- start_of_line
|
|
76
|
+
|
|
77
|
+
# Supports --autocorrect
|
|
78
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutblockendnewline
|
|
79
|
+
Layout/BlockEndNewline:
|
|
80
|
+
Description: Put end statement of multiline block on its own line.
|
|
81
|
+
Enabled: true
|
|
82
|
+
VersionAdded: '0.49'
|
|
83
|
+
|
|
84
|
+
# Supports --autocorrect
|
|
85
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutcaseindentation
|
|
86
|
+
Layout/CaseIndentation:
|
|
87
|
+
Description: Indentation of when in a case/(when|in)/[else/]end.
|
|
88
|
+
StyleGuide: "#indent-when-to-case"
|
|
89
|
+
Enabled: true
|
|
90
|
+
VersionAdded: '0.49'
|
|
91
|
+
VersionChanged: '1.16'
|
|
92
|
+
EnforcedStyle: case
|
|
93
|
+
SupportedStyles:
|
|
94
|
+
- case
|
|
95
|
+
- end
|
|
96
|
+
IndentOneStep: false
|
|
97
|
+
IndentationWidth:
|
|
98
|
+
|
|
99
|
+
# Supports --autocorrect
|
|
100
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutclassstructure
|
|
101
|
+
Layout/ClassStructure:
|
|
102
|
+
Description: Enforces a configured order of definitions within a class body.
|
|
103
|
+
StyleGuide: "#consistent-classes"
|
|
104
|
+
Enabled: true # was false
|
|
105
|
+
SafeAutoCorrect: false
|
|
106
|
+
VersionAdded: '0.52'
|
|
107
|
+
VersionChanged: '1.53'
|
|
108
|
+
Categories:
|
|
109
|
+
module_inclusion:
|
|
110
|
+
- include
|
|
111
|
+
- prepend
|
|
112
|
+
- extend
|
|
113
|
+
ExpectedOrder:
|
|
114
|
+
- module_inclusion
|
|
115
|
+
- constants
|
|
116
|
+
- public_class_methods
|
|
117
|
+
- initializer
|
|
118
|
+
- public_methods
|
|
119
|
+
- protected_methods
|
|
120
|
+
- private_methods
|
|
121
|
+
|
|
122
|
+
# Supports --autocorrect
|
|
123
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutclosingheredocindentation
|
|
124
|
+
Layout/ClosingHeredocIndentation:
|
|
125
|
+
Description: Checks the indentation of here document closings.
|
|
126
|
+
Enabled: true
|
|
127
|
+
VersionAdded: '0.57'
|
|
128
|
+
|
|
129
|
+
# Supports --autocorrect
|
|
130
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutclosingparenthesisindentation
|
|
131
|
+
Layout/ClosingParenthesisIndentation:
|
|
132
|
+
Description: Checks the indentation of hanging closing parentheses.
|
|
133
|
+
Enabled: true
|
|
134
|
+
VersionAdded: '0.49'
|
|
135
|
+
|
|
136
|
+
# Supports --autocorrect
|
|
137
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutcommentindentation
|
|
138
|
+
Layout/CommentIndentation:
|
|
139
|
+
Description: Indentation of comments.
|
|
140
|
+
Enabled: true
|
|
141
|
+
AllowForAlignment: false
|
|
142
|
+
VersionAdded: '0.49'
|
|
143
|
+
VersionChanged: '1.24'
|
|
144
|
+
|
|
145
|
+
# Supports --autocorrect
|
|
146
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutconditionposition
|
|
147
|
+
Layout/ConditionPosition:
|
|
148
|
+
Description: Checks for condition placed in a confusing position relative to the keyword.
|
|
149
|
+
StyleGuide: "#same-line-condition"
|
|
150
|
+
Enabled: true
|
|
151
|
+
VersionAdded: '0.53'
|
|
152
|
+
VersionChanged: '0.83'
|
|
153
|
+
|
|
154
|
+
# Supports --autocorrect
|
|
155
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutdefendalignment
|
|
156
|
+
Layout/DefEndAlignment:
|
|
157
|
+
Description: Align ends corresponding to defs correctly.
|
|
158
|
+
Enabled: true
|
|
159
|
+
VersionAdded: '0.53'
|
|
160
|
+
EnforcedStyleAlignWith: start_of_line
|
|
161
|
+
SupportedStylesAlignWith:
|
|
162
|
+
- start_of_line
|
|
163
|
+
- def
|
|
164
|
+
Severity: warning
|
|
165
|
+
|
|
166
|
+
# Supports --autocorrect
|
|
167
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutdotposition
|
|
168
|
+
Layout/DotPosition:
|
|
169
|
+
Description: Checks the position of the dot in multi-line method calls.
|
|
170
|
+
StyleGuide: "#consistent-multi-line-chains"
|
|
171
|
+
Enabled: true
|
|
172
|
+
VersionAdded: '0.49'
|
|
173
|
+
EnforcedStyle: leading
|
|
174
|
+
SupportedStyles:
|
|
175
|
+
- leading
|
|
176
|
+
- trailing
|
|
177
|
+
|
|
178
|
+
# Supports --autocorrect
|
|
179
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutelsealignment
|
|
180
|
+
Layout/ElseAlignment:
|
|
181
|
+
Description: Align elses and elsifs correctly.
|
|
182
|
+
Enabled: true
|
|
183
|
+
VersionAdded: '0.49'
|
|
184
|
+
|
|
185
|
+
# Supports --autocorrect
|
|
186
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptycomment
|
|
187
|
+
Layout/EmptyComment:
|
|
188
|
+
Description: Checks empty comment.
|
|
189
|
+
Enabled: true
|
|
190
|
+
AutoCorrect: contextual
|
|
191
|
+
VersionAdded: '0.53'
|
|
192
|
+
VersionChanged: '1.61'
|
|
193
|
+
AllowBorderComment: true
|
|
194
|
+
AllowMarginComment: true
|
|
195
|
+
|
|
196
|
+
# Supports --autocorrect
|
|
197
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylineafterguardclause
|
|
198
|
+
Layout/EmptyLineAfterGuardClause:
|
|
199
|
+
Description: Add empty line after guard clause.
|
|
200
|
+
Enabled: true
|
|
201
|
+
VersionAdded: '0.56'
|
|
202
|
+
VersionChanged: '0.59'
|
|
203
|
+
|
|
204
|
+
# Supports --autocorrect
|
|
205
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylineaftermagiccomment
|
|
206
|
+
Layout/EmptyLineAfterMagicComment:
|
|
207
|
+
Description: Add an empty line after magic comments to separate them from code.
|
|
208
|
+
StyleGuide: "#separate-magic-comments-from-code"
|
|
209
|
+
Enabled: true
|
|
210
|
+
VersionAdded: '0.49'
|
|
211
|
+
|
|
212
|
+
# Supports --autocorrect
|
|
213
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylineaftermultilinecondition
|
|
214
|
+
Layout/EmptyLineAfterMultilineCondition:
|
|
215
|
+
Description: Enforces empty line after multiline condition.
|
|
216
|
+
Enabled: true # was false
|
|
217
|
+
VersionAdded: '0.90'
|
|
218
|
+
References:
|
|
219
|
+
- https://github.com/airbnb/ruby#multiline-if-newline
|
|
220
|
+
|
|
221
|
+
# Supports --autocorrect
|
|
222
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinebetweendefs
|
|
223
|
+
Layout/EmptyLineBetweenDefs:
|
|
224
|
+
Description: Use empty lines between class/module/method defs.
|
|
225
|
+
StyleGuide: "#empty-lines-between-methods"
|
|
226
|
+
Enabled: true
|
|
227
|
+
VersionAdded: '0.49'
|
|
228
|
+
VersionChanged: '1.23'
|
|
229
|
+
EmptyLineBetweenMethodDefs: true
|
|
230
|
+
EmptyLineBetweenClassDefs: true
|
|
231
|
+
EmptyLineBetweenModuleDefs: true
|
|
232
|
+
DefLikeMacros: []
|
|
233
|
+
AllowAdjacentOneLineDefs: true
|
|
234
|
+
NumberOfEmptyLines: 1
|
|
235
|
+
|
|
236
|
+
# Supports --autocorrect
|
|
237
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylines
|
|
238
|
+
Layout/EmptyLines:
|
|
239
|
+
Description: Don't use several empty lines in a row.
|
|
240
|
+
StyleGuide: "#two-or-more-empty-lines"
|
|
241
|
+
Enabled: true
|
|
242
|
+
VersionAdded: '0.49'
|
|
243
|
+
|
|
244
|
+
# Supports --autocorrect
|
|
245
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaftermoduleinclusion
|
|
246
|
+
Layout/EmptyLinesAfterModuleInclusion:
|
|
247
|
+
Description: Keeps track of empty lines after module inclusion methods.
|
|
248
|
+
StyleGuide: "#empty-lines-after-module-inclusion"
|
|
249
|
+
Enabled: true # was pending
|
|
250
|
+
VersionAdded: '1.79'
|
|
251
|
+
|
|
252
|
+
# Supports --autocorrect
|
|
253
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaroundaccessmodifier
|
|
254
|
+
Layout/EmptyLinesAroundAccessModifier:
|
|
255
|
+
Description: Keep blank lines around access modifiers.
|
|
256
|
+
StyleGuide: "#empty-lines-around-access-modifier"
|
|
257
|
+
Enabled: true
|
|
258
|
+
VersionAdded: '0.49'
|
|
259
|
+
EnforcedStyle: around
|
|
260
|
+
SupportedStyles:
|
|
261
|
+
- around
|
|
262
|
+
- only_before
|
|
263
|
+
References:
|
|
264
|
+
- https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#follow-the-coding-conventions
|
|
265
|
+
|
|
266
|
+
# Supports --autocorrect
|
|
267
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaroundarguments
|
|
268
|
+
Layout/EmptyLinesAroundArguments:
|
|
269
|
+
Description: Keeps track of empty lines around method arguments.
|
|
270
|
+
Enabled: true
|
|
271
|
+
VersionAdded: '0.52'
|
|
272
|
+
|
|
273
|
+
# Supports --autocorrect
|
|
274
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaroundattributeaccessor
|
|
275
|
+
Layout/EmptyLinesAroundAttributeAccessor:
|
|
276
|
+
Description: Keep blank lines around attribute accessors.
|
|
277
|
+
StyleGuide: "#empty-lines-around-attribute-accessor"
|
|
278
|
+
Enabled: true
|
|
279
|
+
VersionAdded: '0.83'
|
|
280
|
+
VersionChanged: '0.84'
|
|
281
|
+
AllowAliasSyntax: true
|
|
282
|
+
AllowedMethods:
|
|
283
|
+
- alias_method
|
|
284
|
+
- public
|
|
285
|
+
- protected
|
|
286
|
+
- private
|
|
287
|
+
|
|
288
|
+
# Supports --autocorrect
|
|
289
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaroundbeginbody
|
|
290
|
+
Layout/EmptyLinesAroundBeginBody:
|
|
291
|
+
Description: Keeps track of empty lines around begin-end bodies.
|
|
292
|
+
StyleGuide: "#empty-lines-around-bodies"
|
|
293
|
+
Enabled: true
|
|
294
|
+
VersionAdded: '0.49'
|
|
295
|
+
|
|
296
|
+
# Supports --autocorrect
|
|
297
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaroundblockbody
|
|
298
|
+
Layout/EmptyLinesAroundBlockBody:
|
|
299
|
+
Description: Keeps track of empty lines around block bodies.
|
|
300
|
+
StyleGuide: "#empty-lines-around-bodies"
|
|
301
|
+
Enabled: true
|
|
302
|
+
VersionAdded: '0.49'
|
|
303
|
+
EnforcedStyle: no_empty_lines
|
|
304
|
+
SupportedStyles:
|
|
305
|
+
- empty_lines
|
|
306
|
+
- no_empty_lines
|
|
307
|
+
|
|
308
|
+
# Supports --autocorrect
|
|
309
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaroundclassbody
|
|
310
|
+
Layout/EmptyLinesAroundClassBody:
|
|
311
|
+
Description: Keeps track of empty lines around class bodies.
|
|
312
|
+
StyleGuide: "#empty-lines-around-bodies"
|
|
313
|
+
Enabled: true
|
|
314
|
+
VersionAdded: '0.49'
|
|
315
|
+
VersionChanged: '0.53'
|
|
316
|
+
EnforcedStyle: no_empty_lines
|
|
317
|
+
SupportedStyles:
|
|
318
|
+
- empty_lines
|
|
319
|
+
- empty_lines_except_namespace
|
|
320
|
+
- empty_lines_special
|
|
321
|
+
- no_empty_lines
|
|
322
|
+
- beginning_only
|
|
323
|
+
- ending_only
|
|
324
|
+
|
|
325
|
+
# Supports --autocorrect
|
|
326
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaroundexceptionhandlingkeywords
|
|
327
|
+
Layout/EmptyLinesAroundExceptionHandlingKeywords:
|
|
328
|
+
Description: Keeps track of empty lines around exception handling keywords.
|
|
329
|
+
StyleGuide: "#empty-lines-around-bodies"
|
|
330
|
+
Enabled: true
|
|
331
|
+
VersionAdded: '0.49'
|
|
332
|
+
|
|
333
|
+
# Supports --autocorrect
|
|
334
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaroundmethodbody
|
|
335
|
+
Layout/EmptyLinesAroundMethodBody:
|
|
336
|
+
Description: Keeps track of empty lines around method bodies.
|
|
337
|
+
StyleGuide: "#empty-lines-around-bodies"
|
|
338
|
+
Enabled: true
|
|
339
|
+
VersionAdded: '0.49'
|
|
340
|
+
|
|
341
|
+
# Supports --autocorrect
|
|
342
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaroundmodulebody
|
|
343
|
+
Layout/EmptyLinesAroundModuleBody:
|
|
344
|
+
Description: Keeps track of empty lines around module bodies.
|
|
345
|
+
StyleGuide: "#empty-lines-around-bodies"
|
|
346
|
+
Enabled: true
|
|
347
|
+
VersionAdded: '0.49'
|
|
348
|
+
EnforcedStyle: no_empty_lines
|
|
349
|
+
SupportedStyles:
|
|
350
|
+
- empty_lines
|
|
351
|
+
- empty_lines_except_namespace
|
|
352
|
+
- empty_lines_special
|
|
353
|
+
- no_empty_lines
|
|
354
|
+
|
|
355
|
+
# Supports --autocorrect
|
|
356
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutendalignment
|
|
357
|
+
Layout/EndAlignment:
|
|
358
|
+
Description: Align ends correctly.
|
|
359
|
+
Enabled: true
|
|
360
|
+
VersionAdded: '0.53'
|
|
361
|
+
EnforcedStyleAlignWith: keyword
|
|
362
|
+
SupportedStylesAlignWith:
|
|
363
|
+
- keyword
|
|
364
|
+
- variable
|
|
365
|
+
- start_of_line
|
|
366
|
+
Severity: warning
|
|
367
|
+
|
|
368
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutendofline
|
|
369
|
+
Layout/EndOfLine:
|
|
370
|
+
Description: Use Unix-style line endings.
|
|
371
|
+
StyleGuide: "#crlf"
|
|
372
|
+
Enabled: true
|
|
373
|
+
VersionAdded: '0.49'
|
|
374
|
+
EnforcedStyle: native
|
|
375
|
+
SupportedStyles:
|
|
376
|
+
- native
|
|
377
|
+
- lf
|
|
378
|
+
- crlf
|
|
379
|
+
|
|
380
|
+
# Supports --autocorrect
|
|
381
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutextraspacing
|
|
382
|
+
Layout/ExtraSpacing:
|
|
383
|
+
Description: Do not use unnecessary spacing.
|
|
384
|
+
Enabled: true
|
|
385
|
+
VersionAdded: '0.49'
|
|
386
|
+
AllowForAlignment: true
|
|
387
|
+
AllowBeforeTrailingComments: false
|
|
388
|
+
ForceEqualSignAlignment: false
|
|
389
|
+
|
|
390
|
+
# Supports --autocorrect
|
|
391
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirstargumentindentation
|
|
392
|
+
Layout/FirstArgumentIndentation:
|
|
393
|
+
Description: Checks the indentation of the first argument in a method call.
|
|
394
|
+
Enabled: true
|
|
395
|
+
VersionAdded: '0.68'
|
|
396
|
+
VersionChanged: '0.77'
|
|
397
|
+
EnforcedStyle: special_for_inner_method_call_in_parentheses
|
|
398
|
+
SupportedStyles:
|
|
399
|
+
- consistent
|
|
400
|
+
- consistent_relative_to_receiver
|
|
401
|
+
- special_for_inner_method_call
|
|
402
|
+
- special_for_inner_method_call_in_parentheses
|
|
403
|
+
IndentationWidth:
|
|
404
|
+
|
|
405
|
+
# Supports --autocorrect
|
|
406
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirstarrayelementindentation
|
|
407
|
+
Layout/FirstArrayElementIndentation:
|
|
408
|
+
Description: Checks the indentation of the first element in an array literal.
|
|
409
|
+
Enabled: true
|
|
410
|
+
VersionAdded: '0.68'
|
|
411
|
+
VersionChanged: '0.77'
|
|
412
|
+
EnforcedStyle: special_inside_parentheses
|
|
413
|
+
SupportedStyles:
|
|
414
|
+
- special_inside_parentheses
|
|
415
|
+
- consistent
|
|
416
|
+
- align_brackets
|
|
417
|
+
IndentationWidth:
|
|
418
|
+
|
|
419
|
+
# Supports --autocorrect
|
|
420
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirstarrayelementlinebreak
|
|
421
|
+
Layout/FirstArrayElementLineBreak:
|
|
422
|
+
Description: Checks for a line break before the first element in a multi-line array.
|
|
423
|
+
Enabled: true # was false
|
|
424
|
+
VersionAdded: '0.49'
|
|
425
|
+
AllowMultilineFinalElement: false
|
|
426
|
+
|
|
427
|
+
# Supports --autocorrect
|
|
428
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirsthashelementindentation
|
|
429
|
+
Layout/FirstHashElementIndentation:
|
|
430
|
+
Description: Checks the indentation of the first key in a hash literal.
|
|
431
|
+
Enabled: true
|
|
432
|
+
VersionAdded: '0.68'
|
|
433
|
+
VersionChanged: '0.77'
|
|
434
|
+
EnforcedStyle: special_inside_parentheses
|
|
435
|
+
SupportedStyles:
|
|
436
|
+
- special_inside_parentheses
|
|
437
|
+
- consistent
|
|
438
|
+
- align_braces
|
|
439
|
+
IndentationWidth:
|
|
440
|
+
|
|
441
|
+
# Supports --autocorrect
|
|
442
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirsthashelementlinebreak
|
|
443
|
+
Layout/FirstHashElementLineBreak:
|
|
444
|
+
Description: Checks for a line break before the first element in a multi-line hash.
|
|
445
|
+
Enabled: true # was false
|
|
446
|
+
VersionAdded: '0.49'
|
|
447
|
+
AllowMultilineFinalElement: false
|
|
448
|
+
|
|
449
|
+
# Supports --autocorrect
|
|
450
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirstmethodargumentlinebreak
|
|
451
|
+
Layout/FirstMethodArgumentLineBreak:
|
|
452
|
+
Description: Checks for a line break before the first argument in a multi-line method
|
|
453
|
+
call.
|
|
454
|
+
Enabled: true # was false
|
|
455
|
+
VersionAdded: '0.49'
|
|
456
|
+
AllowMultilineFinalElement: false
|
|
457
|
+
AllowedMethods: []
|
|
458
|
+
|
|
459
|
+
# Supports --autocorrect
|
|
460
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirstmethodparameterlinebreak
|
|
461
|
+
Layout/FirstMethodParameterLineBreak:
|
|
462
|
+
Description: Checks for a line break before the first parameter in a multi-line method
|
|
463
|
+
parameter definition.
|
|
464
|
+
Enabled: true # was false
|
|
465
|
+
VersionAdded: '0.49'
|
|
466
|
+
AllowMultilineFinalElement: false
|
|
467
|
+
|
|
468
|
+
# Supports --autocorrect
|
|
469
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirstparameterindentation
|
|
470
|
+
Layout/FirstParameterIndentation:
|
|
471
|
+
Description: Checks the indentation of the first parameter in a method definition.
|
|
472
|
+
Enabled: true
|
|
473
|
+
VersionAdded: '0.49'
|
|
474
|
+
VersionChanged: '0.77'
|
|
475
|
+
EnforcedStyle: consistent
|
|
476
|
+
SupportedStyles:
|
|
477
|
+
- consistent
|
|
478
|
+
- align_parentheses
|
|
479
|
+
IndentationWidth:
|
|
480
|
+
|
|
481
|
+
# Supports --autocorrect
|
|
482
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layouthashalignment
|
|
483
|
+
Layout/HashAlignment:
|
|
484
|
+
Description: Align the elements of a hash literal if they span more than one line.
|
|
485
|
+
Enabled: true
|
|
486
|
+
AllowMultipleStyles: true
|
|
487
|
+
VersionAdded: '0.49'
|
|
488
|
+
VersionChanged: '1.16'
|
|
489
|
+
EnforcedHashRocketStyle: key
|
|
490
|
+
SupportedHashRocketStyles:
|
|
491
|
+
- key
|
|
492
|
+
- separator
|
|
493
|
+
- table
|
|
494
|
+
EnforcedColonStyle: key
|
|
495
|
+
SupportedColonStyles:
|
|
496
|
+
- key
|
|
497
|
+
- separator
|
|
498
|
+
- table
|
|
499
|
+
EnforcedLastArgumentHashStyle: always_inspect
|
|
500
|
+
SupportedLastArgumentHashStyles:
|
|
501
|
+
- always_inspect
|
|
502
|
+
- always_ignore
|
|
503
|
+
- ignore_implicit
|
|
504
|
+
- ignore_explicit
|
|
505
|
+
|
|
506
|
+
# Supports --autocorrect
|
|
507
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutheredocargumentclosingparenthesis
|
|
508
|
+
Layout/HeredocArgumentClosingParenthesis:
|
|
509
|
+
Description: Checks for the placement of the closing parenthesis in a method call
|
|
510
|
+
that passes a HEREDOC string as an argument.
|
|
511
|
+
Enabled: true # was false
|
|
512
|
+
StyleGuide: "#heredoc-argument-closing-parentheses"
|
|
513
|
+
VersionAdded: '0.68'
|
|
514
|
+
|
|
515
|
+
# Supports --autocorrect
|
|
516
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutheredocindentation
|
|
517
|
+
Layout/HeredocIndentation:
|
|
518
|
+
Description: Checks the indentation of the here document bodies.
|
|
519
|
+
StyleGuide: "#squiggly-heredocs"
|
|
520
|
+
Enabled: true
|
|
521
|
+
VersionAdded: '0.49'
|
|
522
|
+
VersionChanged: '0.85'
|
|
523
|
+
|
|
524
|
+
# Supports --autocorrect
|
|
525
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutindentationconsistency
|
|
526
|
+
Layout/IndentationConsistency:
|
|
527
|
+
Description: Keep indentation straight.
|
|
528
|
+
StyleGuide: "#spaces-indentation"
|
|
529
|
+
Enabled: true
|
|
530
|
+
VersionAdded: '0.49'
|
|
531
|
+
EnforcedStyle: normal
|
|
532
|
+
SupportedStyles:
|
|
533
|
+
- normal
|
|
534
|
+
- indented_internal_methods
|
|
535
|
+
References:
|
|
536
|
+
- https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#follow-the-coding-conventions
|
|
537
|
+
|
|
538
|
+
# Supports --autocorrect
|
|
539
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutindentationstyle
|
|
540
|
+
Layout/IndentationStyle:
|
|
541
|
+
Description: Consistent indentation either with tabs only or spaces only.
|
|
542
|
+
StyleGuide: "#spaces-indentation"
|
|
543
|
+
Enabled: true
|
|
544
|
+
VersionAdded: '0.49'
|
|
545
|
+
VersionChanged: '0.82'
|
|
546
|
+
IndentationWidth:
|
|
547
|
+
EnforcedStyle: spaces
|
|
548
|
+
SupportedStyles:
|
|
549
|
+
- spaces
|
|
550
|
+
- tabs
|
|
551
|
+
|
|
552
|
+
# Supports --autocorrect
|
|
553
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutindentationwidth
|
|
554
|
+
Layout/IndentationWidth:
|
|
555
|
+
Description: Use 2 spaces for indentation.
|
|
556
|
+
StyleGuide: "#spaces-indentation"
|
|
557
|
+
Enabled: true
|
|
558
|
+
VersionAdded: '0.49'
|
|
559
|
+
Width: 2
|
|
560
|
+
AllowedPatterns: []
|
|
561
|
+
|
|
562
|
+
# Supports --autocorrect
|
|
563
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutinitialindentation
|
|
564
|
+
Layout/InitialIndentation:
|
|
565
|
+
Description: Checks the indentation of the first non-blank non-comment line in a file.
|
|
566
|
+
Enabled: true
|
|
567
|
+
VersionAdded: '0.49'
|
|
568
|
+
|
|
569
|
+
# Supports --autocorrect
|
|
570
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutleadingcommentspace
|
|
571
|
+
Layout/LeadingCommentSpace:
|
|
572
|
+
Description: Comments should start with a space.
|
|
573
|
+
StyleGuide: "#hash-space"
|
|
574
|
+
Enabled: true
|
|
575
|
+
VersionAdded: '0.49'
|
|
576
|
+
VersionChanged: '0.73'
|
|
577
|
+
AllowDoxygenCommentStyle: false
|
|
578
|
+
AllowGemfileRubyComment: false
|
|
579
|
+
AllowRBSInlineAnnotation: false
|
|
580
|
+
AllowSteepAnnotation: false
|
|
581
|
+
|
|
582
|
+
# Supports --autocorrect
|
|
583
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutleadingemptylines
|
|
584
|
+
Layout/LeadingEmptyLines:
|
|
585
|
+
Description: Checks for unnecessary blank lines at the beginning of a file.
|
|
586
|
+
Enabled: true
|
|
587
|
+
VersionAdded: '0.57'
|
|
588
|
+
VersionChanged: '0.77'
|
|
589
|
+
|
|
590
|
+
# Supports --autocorrect
|
|
591
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutlinecontinuationleadingspace
|
|
592
|
+
Layout/LineContinuationLeadingSpace:
|
|
593
|
+
Description: Use trailing spaces instead of leading spaces in strings broken over
|
|
594
|
+
multiple lines (by a backslash).
|
|
595
|
+
Enabled: true # was pending
|
|
596
|
+
VersionAdded: '1.31'
|
|
597
|
+
VersionChanged: '1.45'
|
|
598
|
+
EnforcedStyle: trailing
|
|
599
|
+
SupportedStyles:
|
|
600
|
+
- leading
|
|
601
|
+
- trailing
|
|
602
|
+
|
|
603
|
+
# Supports --autocorrect
|
|
604
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutlinecontinuationspacing
|
|
605
|
+
Layout/LineContinuationSpacing:
|
|
606
|
+
Description: Checks the spacing in front of backslash in line continuations.
|
|
607
|
+
Enabled: true # was pending
|
|
608
|
+
VersionAdded: '1.31'
|
|
609
|
+
EnforcedStyle: space
|
|
610
|
+
SupportedStyles:
|
|
611
|
+
- space
|
|
612
|
+
- no_space
|
|
613
|
+
|
|
614
|
+
# Supports --autocorrect
|
|
615
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutlineendstringconcatenationindentation
|
|
616
|
+
Layout/LineEndStringConcatenationIndentation:
|
|
617
|
+
Description: Checks the indentation of the next line after a line that ends with a
|
|
618
|
+
string literal and a backslash.
|
|
619
|
+
Enabled: true # was pending
|
|
620
|
+
VersionAdded: '1.18'
|
|
621
|
+
EnforcedStyle: aligned
|
|
622
|
+
SupportedStyles:
|
|
623
|
+
- aligned
|
|
624
|
+
- indented
|
|
625
|
+
IndentationWidth:
|
|
626
|
+
|
|
627
|
+
# Supports --autocorrect
|
|
628
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutlinelength
|
|
629
|
+
Layout/LineLength:
|
|
630
|
+
Description: Checks that line length does not exceed the configured limit.
|
|
631
|
+
StyleGuide: "#max-line-length"
|
|
632
|
+
Enabled: true
|
|
633
|
+
VersionAdded: '0.25'
|
|
634
|
+
VersionChanged: '1.69'
|
|
635
|
+
Max: 120
|
|
636
|
+
AllowHeredoc: true
|
|
637
|
+
AllowURI: true
|
|
638
|
+
AllowQualifiedName: true
|
|
639
|
+
URISchemes:
|
|
640
|
+
- http
|
|
641
|
+
- https
|
|
642
|
+
IgnoreCopDirectives: true
|
|
643
|
+
AllowedPatterns: []
|
|
644
|
+
SplitStrings: false
|
|
645
|
+
|
|
646
|
+
# Supports --autocorrect
|
|
647
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilinearraybracelayout
|
|
648
|
+
Layout/MultilineArrayBraceLayout:
|
|
649
|
+
Description: Checks that the closing brace in an array literal is either on the same
|
|
650
|
+
line as the last array element, or a new line.
|
|
651
|
+
Enabled: true
|
|
652
|
+
VersionAdded: '0.49'
|
|
653
|
+
EnforcedStyle: symmetrical
|
|
654
|
+
SupportedStyles:
|
|
655
|
+
- symmetrical
|
|
656
|
+
- new_line
|
|
657
|
+
- same_line
|
|
658
|
+
|
|
659
|
+
# Supports --autocorrect
|
|
660
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilinearraylinebreaks
|
|
661
|
+
Layout/MultilineArrayLineBreaks:
|
|
662
|
+
Description: Checks that each item in a multi-line array literal starts on a separate
|
|
663
|
+
line.
|
|
664
|
+
Enabled: true # was false
|
|
665
|
+
VersionAdded: '0.67'
|
|
666
|
+
AllowMultilineFinalElement: false
|
|
667
|
+
|
|
668
|
+
# Supports --autocorrect
|
|
669
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilineassignmentlayout
|
|
670
|
+
Layout/MultilineAssignmentLayout:
|
|
671
|
+
Description: Checks for a newline after the assignment operator in multi-line assignments.
|
|
672
|
+
StyleGuide: "#indent-conditional-assignment"
|
|
673
|
+
Enabled: true # was false
|
|
674
|
+
VersionAdded: '0.49'
|
|
675
|
+
SupportedTypes:
|
|
676
|
+
- block
|
|
677
|
+
- case
|
|
678
|
+
- class
|
|
679
|
+
- if
|
|
680
|
+
- kwbegin
|
|
681
|
+
- module
|
|
682
|
+
EnforcedStyle: new_line
|
|
683
|
+
SupportedStyles:
|
|
684
|
+
- same_line
|
|
685
|
+
- new_line
|
|
686
|
+
|
|
687
|
+
# Supports --autocorrect
|
|
688
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilineblocklayout
|
|
689
|
+
Layout/MultilineBlockLayout:
|
|
690
|
+
Description: Ensures newlines after multiline block do statements.
|
|
691
|
+
Enabled: true
|
|
692
|
+
VersionAdded: '0.49'
|
|
693
|
+
|
|
694
|
+
# Supports --autocorrect
|
|
695
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilinehashbracelayout
|
|
696
|
+
Layout/MultilineHashBraceLayout:
|
|
697
|
+
Description: Checks that the closing brace in a hash literal is either on the same
|
|
698
|
+
line as the last hash element, or a new line.
|
|
699
|
+
Enabled: true
|
|
700
|
+
VersionAdded: '0.49'
|
|
701
|
+
EnforcedStyle: symmetrical
|
|
702
|
+
SupportedStyles:
|
|
703
|
+
- symmetrical
|
|
704
|
+
- new_line
|
|
705
|
+
- same_line
|
|
706
|
+
|
|
707
|
+
# Supports --autocorrect
|
|
708
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilinehashkeylinebreaks
|
|
709
|
+
Layout/MultilineHashKeyLineBreaks:
|
|
710
|
+
Description: Checks that each item in a multi-line hash literal starts on a separate
|
|
711
|
+
line.
|
|
712
|
+
Enabled: true # was false
|
|
713
|
+
VersionAdded: '0.67'
|
|
714
|
+
AllowMultilineFinalElement: false
|
|
715
|
+
|
|
716
|
+
# Supports --autocorrect
|
|
717
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilinemethodargumentlinebreaks
|
|
718
|
+
Layout/MultilineMethodArgumentLineBreaks:
|
|
719
|
+
Description: Checks that each argument in a multi-line method call starts on a separate
|
|
720
|
+
line.
|
|
721
|
+
Enabled: true # was false
|
|
722
|
+
VersionAdded: '0.67'
|
|
723
|
+
AllowMultilineFinalElement: false
|
|
724
|
+
|
|
725
|
+
# Supports --autocorrect
|
|
726
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilinemethodcallbracelayout
|
|
727
|
+
Layout/MultilineMethodCallBraceLayout:
|
|
728
|
+
Description: Checks that the closing brace in a method call is either on the same
|
|
729
|
+
line as the last method argument, or a new line.
|
|
730
|
+
Enabled: true
|
|
731
|
+
VersionAdded: '0.49'
|
|
732
|
+
EnforcedStyle: symmetrical
|
|
733
|
+
SupportedStyles:
|
|
734
|
+
- symmetrical
|
|
735
|
+
- new_line
|
|
736
|
+
- same_line
|
|
737
|
+
|
|
738
|
+
# Supports --autocorrect
|
|
739
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilinemethodcallindentation
|
|
740
|
+
Layout/MultilineMethodCallIndentation:
|
|
741
|
+
Description: Checks indentation of method calls with the dot operator that span more
|
|
742
|
+
than one line.
|
|
743
|
+
Enabled: true
|
|
744
|
+
VersionAdded: '0.49'
|
|
745
|
+
EnforcedStyle: aligned
|
|
746
|
+
SupportedStyles:
|
|
747
|
+
- aligned
|
|
748
|
+
- indented
|
|
749
|
+
- indented_relative_to_receiver
|
|
750
|
+
IndentationWidth:
|
|
751
|
+
|
|
752
|
+
# Supports --autocorrect
|
|
753
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilinemethoddefinitionbracelayout
|
|
754
|
+
Layout/MultilineMethodDefinitionBraceLayout:
|
|
755
|
+
Description: Checks that the closing brace in a method definition is either on the
|
|
756
|
+
same line as the last method parameter, or a new line.
|
|
757
|
+
Enabled: true
|
|
758
|
+
VersionAdded: '0.49'
|
|
759
|
+
EnforcedStyle: symmetrical
|
|
760
|
+
SupportedStyles:
|
|
761
|
+
- symmetrical
|
|
762
|
+
- new_line
|
|
763
|
+
- same_line
|
|
764
|
+
|
|
765
|
+
# Supports --autocorrect
|
|
766
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilinemethodparameterlinebreaks
|
|
767
|
+
Layout/MultilineMethodParameterLineBreaks:
|
|
768
|
+
Description: Checks that each parameter in a multi-line method definition starts on
|
|
769
|
+
a separate line.
|
|
770
|
+
Enabled: true # was false
|
|
771
|
+
VersionAdded: '1.32'
|
|
772
|
+
AllowMultilineFinalElement: false
|
|
773
|
+
|
|
774
|
+
# Supports --autocorrect
|
|
775
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutmultilineoperationindentation
|
|
776
|
+
Layout/MultilineOperationIndentation:
|
|
777
|
+
Description: Checks indentation of binary operations that span more than one line.
|
|
778
|
+
Enabled: true
|
|
779
|
+
VersionAdded: '0.49'
|
|
780
|
+
EnforcedStyle: aligned
|
|
781
|
+
SupportedStyles:
|
|
782
|
+
- aligned
|
|
783
|
+
- indented
|
|
784
|
+
IndentationWidth:
|
|
785
|
+
|
|
786
|
+
# Supports --autocorrect
|
|
787
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutparameteralignment
|
|
788
|
+
Layout/ParameterAlignment:
|
|
789
|
+
Description: Align the parameters of a method definition if they span more than one
|
|
790
|
+
line.
|
|
791
|
+
StyleGuide: "#no-double-indent"
|
|
792
|
+
Enabled: true
|
|
793
|
+
VersionAdded: '0.49'
|
|
794
|
+
VersionChanged: '0.77'
|
|
795
|
+
EnforcedStyle: with_first_parameter
|
|
796
|
+
SupportedStyles:
|
|
797
|
+
- with_first_parameter
|
|
798
|
+
- with_fixed_indentation
|
|
799
|
+
IndentationWidth:
|
|
800
|
+
|
|
801
|
+
# Supports --autocorrect
|
|
802
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutredundantlinebreak
|
|
803
|
+
Layout/RedundantLineBreak:
|
|
804
|
+
Description: Do not break up an expression into multiple lines when it fits on a single
|
|
805
|
+
line.
|
|
806
|
+
Enabled: true # was false
|
|
807
|
+
InspectBlocks: false
|
|
808
|
+
VersionAdded: '1.13'
|
|
809
|
+
|
|
810
|
+
# Supports --autocorrect
|
|
811
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutrescueensurealignment
|
|
812
|
+
Layout/RescueEnsureAlignment:
|
|
813
|
+
Description: Align rescues and ensures correctly.
|
|
814
|
+
Enabled: true
|
|
815
|
+
VersionAdded: '0.49'
|
|
816
|
+
|
|
817
|
+
# Supports --autocorrect
|
|
818
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutsinglelineblockchain
|
|
819
|
+
Layout/SingleLineBlockChain:
|
|
820
|
+
Description: Put method call on a separate line if chained to a single line block.
|
|
821
|
+
Enabled: true # was false
|
|
822
|
+
VersionAdded: '1.14'
|
|
823
|
+
|
|
824
|
+
# Supports --autocorrect
|
|
825
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceaftercolon
|
|
826
|
+
Layout/SpaceAfterColon:
|
|
827
|
+
Description: Use spaces after colons.
|
|
828
|
+
StyleGuide: "#spaces-operators"
|
|
829
|
+
Enabled: true
|
|
830
|
+
VersionAdded: '0.49'
|
|
831
|
+
|
|
832
|
+
# Supports --autocorrect
|
|
833
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceaftercomma
|
|
834
|
+
Layout/SpaceAfterComma:
|
|
835
|
+
Description: Use spaces after commas.
|
|
836
|
+
StyleGuide: "#spaces-operators"
|
|
837
|
+
Enabled: true
|
|
838
|
+
VersionAdded: '0.49'
|
|
839
|
+
|
|
840
|
+
# Supports --autocorrect
|
|
841
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceaftermethodname
|
|
842
|
+
Layout/SpaceAfterMethodName:
|
|
843
|
+
Description: Do not put a space between a method name and the opening parenthesis
|
|
844
|
+
in a method definition.
|
|
845
|
+
StyleGuide: "#parens-no-spaces"
|
|
846
|
+
Enabled: true
|
|
847
|
+
VersionAdded: '0.49'
|
|
848
|
+
|
|
849
|
+
# Supports --autocorrect
|
|
850
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceafternot
|
|
851
|
+
Layout/SpaceAfterNot:
|
|
852
|
+
Description: Tracks redundant space after the ! operator.
|
|
853
|
+
StyleGuide: "#no-space-bang"
|
|
854
|
+
Enabled: true
|
|
855
|
+
VersionAdded: '0.49'
|
|
856
|
+
|
|
857
|
+
# Supports --autocorrect
|
|
858
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceaftersemicolon
|
|
859
|
+
Layout/SpaceAfterSemicolon:
|
|
860
|
+
Description: Use spaces after semicolons.
|
|
861
|
+
StyleGuide: "#spaces-operators"
|
|
862
|
+
Enabled: true
|
|
863
|
+
VersionAdded: '0.49'
|
|
864
|
+
|
|
865
|
+
# Supports --autocorrect
|
|
866
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacearoundblockparameters
|
|
867
|
+
Layout/SpaceAroundBlockParameters:
|
|
868
|
+
Description: Checks the spacing inside and after block parameters pipes.
|
|
869
|
+
Enabled: true
|
|
870
|
+
VersionAdded: '0.49'
|
|
871
|
+
EnforcedStyleInsidePipes: no_space
|
|
872
|
+
SupportedStylesInsidePipes:
|
|
873
|
+
- space
|
|
874
|
+
- no_space
|
|
875
|
+
|
|
876
|
+
# Supports --autocorrect
|
|
877
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacearoundequalsinparameterdefault
|
|
878
|
+
Layout/SpaceAroundEqualsInParameterDefault:
|
|
879
|
+
Description: Checks that the equals signs in parameter default assignments have or
|
|
880
|
+
don't have surrounding space depending on configuration.
|
|
881
|
+
StyleGuide: "#spaces-around-equals"
|
|
882
|
+
Enabled: true
|
|
883
|
+
VersionAdded: '0.49'
|
|
884
|
+
EnforcedStyle: space
|
|
885
|
+
SupportedStyles:
|
|
886
|
+
- space
|
|
887
|
+
- no_space
|
|
888
|
+
|
|
889
|
+
# Supports --autocorrect
|
|
890
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacearoundkeyword
|
|
891
|
+
Layout/SpaceAroundKeyword:
|
|
892
|
+
Description: Use a space around keywords if appropriate.
|
|
893
|
+
Enabled: true
|
|
894
|
+
VersionAdded: '0.49'
|
|
895
|
+
|
|
896
|
+
# Supports --autocorrect
|
|
897
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacearoundmethodcalloperator
|
|
898
|
+
Layout/SpaceAroundMethodCallOperator:
|
|
899
|
+
Description: Checks method call operators to not have spaces around them.
|
|
900
|
+
Enabled: true
|
|
901
|
+
VersionAdded: '0.82'
|
|
902
|
+
|
|
903
|
+
# Supports --autocorrect
|
|
904
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacearoundoperators
|
|
905
|
+
Layout/SpaceAroundOperators:
|
|
906
|
+
Description: Use a single space around operators.
|
|
907
|
+
StyleGuide: "#spaces-operators"
|
|
908
|
+
Enabled: true
|
|
909
|
+
VersionAdded: '0.49'
|
|
910
|
+
AllowForAlignment: true
|
|
911
|
+
EnforcedStyleForExponentOperator: no_space
|
|
912
|
+
SupportedStylesForExponentOperator:
|
|
913
|
+
- space
|
|
914
|
+
- no_space
|
|
915
|
+
EnforcedStyleForRationalLiterals: no_space
|
|
916
|
+
SupportedStylesForRationalLiterals:
|
|
917
|
+
- space
|
|
918
|
+
- no_space
|
|
919
|
+
|
|
920
|
+
# Supports --autocorrect
|
|
921
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacebeforeblockbraces
|
|
922
|
+
Layout/SpaceBeforeBlockBraces:
|
|
923
|
+
Description: Checks that the left block brace has or doesn't have space before it.
|
|
924
|
+
Enabled: true
|
|
925
|
+
VersionAdded: '0.49'
|
|
926
|
+
EnforcedStyle: space
|
|
927
|
+
SupportedStyles:
|
|
928
|
+
- space
|
|
929
|
+
- no_space
|
|
930
|
+
EnforcedStyleForEmptyBraces: space
|
|
931
|
+
SupportedStylesForEmptyBraces:
|
|
932
|
+
- space
|
|
933
|
+
- no_space
|
|
934
|
+
VersionChanged: '0.52'
|
|
935
|
+
|
|
936
|
+
# Supports --autocorrect
|
|
937
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacebeforebrackets
|
|
938
|
+
Layout/SpaceBeforeBrackets:
|
|
939
|
+
Description: Checks for receiver with a space before the opening brackets.
|
|
940
|
+
StyleGuide: "#space-in-brackets-access"
|
|
941
|
+
Enabled: true # was pending
|
|
942
|
+
VersionAdded: '1.7'
|
|
943
|
+
|
|
944
|
+
# Supports --autocorrect
|
|
945
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacebeforecomma
|
|
946
|
+
Layout/SpaceBeforeComma:
|
|
947
|
+
Description: No spaces before commas.
|
|
948
|
+
Enabled: true
|
|
949
|
+
VersionAdded: '0.49'
|
|
950
|
+
|
|
951
|
+
# Supports --autocorrect
|
|
952
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacebeforecomment
|
|
953
|
+
Layout/SpaceBeforeComment:
|
|
954
|
+
Description: Checks for missing space between code and a comment on the same line.
|
|
955
|
+
Enabled: true
|
|
956
|
+
VersionAdded: '0.49'
|
|
957
|
+
|
|
958
|
+
# Supports --autocorrect
|
|
959
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacebeforefirstarg
|
|
960
|
+
Layout/SpaceBeforeFirstArg:
|
|
961
|
+
Description: Checks that exactly one space is used between a method name and the first
|
|
962
|
+
argument for method calls without parentheses.
|
|
963
|
+
Enabled: true
|
|
964
|
+
VersionAdded: '0.49'
|
|
965
|
+
AllowForAlignment: true
|
|
966
|
+
|
|
967
|
+
# Supports --autocorrect
|
|
968
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacebeforesemicolon
|
|
969
|
+
Layout/SpaceBeforeSemicolon:
|
|
970
|
+
Description: No spaces before semicolons.
|
|
971
|
+
Enabled: true
|
|
972
|
+
VersionAdded: '0.49'
|
|
973
|
+
|
|
974
|
+
# Supports --autocorrect
|
|
975
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceinlambdaliteral
|
|
976
|
+
Layout/SpaceInLambdaLiteral:
|
|
977
|
+
Description: Checks for spaces in lambda literals.
|
|
978
|
+
Enabled: true
|
|
979
|
+
VersionAdded: '0.49'
|
|
980
|
+
EnforcedStyle: require_no_space
|
|
981
|
+
SupportedStyles:
|
|
982
|
+
- require_no_space
|
|
983
|
+
- require_space
|
|
984
|
+
|
|
985
|
+
# Supports --autocorrect
|
|
986
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceinsidearrayliteralbrackets
|
|
987
|
+
Layout/SpaceInsideArrayLiteralBrackets:
|
|
988
|
+
Description: Checks the spacing inside array literal brackets.
|
|
989
|
+
Enabled: true
|
|
990
|
+
VersionAdded: '0.52'
|
|
991
|
+
EnforcedStyle: no_space
|
|
992
|
+
SupportedStyles:
|
|
993
|
+
- space
|
|
994
|
+
- no_space
|
|
995
|
+
- compact
|
|
996
|
+
EnforcedStyleForEmptyBrackets: no_space
|
|
997
|
+
SupportedStylesForEmptyBrackets:
|
|
998
|
+
- space
|
|
999
|
+
- no_space
|
|
1000
|
+
|
|
1001
|
+
# Supports --autocorrect
|
|
1002
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceinsidearraypercentliteral
|
|
1003
|
+
Layout/SpaceInsideArrayPercentLiteral:
|
|
1004
|
+
Description: No unnecessary additional spaces between elements in %i/%w literals.
|
|
1005
|
+
Enabled: true
|
|
1006
|
+
VersionAdded: '0.49'
|
|
1007
|
+
|
|
1008
|
+
# Supports --autocorrect
|
|
1009
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceinsideblockbraces
|
|
1010
|
+
Layout/SpaceInsideBlockBraces:
|
|
1011
|
+
Description: Checks that block braces have or don't have surrounding space. For blocks
|
|
1012
|
+
taking parameters, checks that the left brace has or doesn't have trailing space.
|
|
1013
|
+
Enabled: true
|
|
1014
|
+
VersionAdded: '0.49'
|
|
1015
|
+
EnforcedStyle: space
|
|
1016
|
+
SupportedStyles:
|
|
1017
|
+
- space
|
|
1018
|
+
- no_space
|
|
1019
|
+
EnforcedStyleForEmptyBraces: no_space
|
|
1020
|
+
SupportedStylesForEmptyBraces:
|
|
1021
|
+
- space
|
|
1022
|
+
- no_space
|
|
1023
|
+
SpaceBeforeBlockParameters: true
|
|
1024
|
+
|
|
1025
|
+
# Supports --autocorrect
|
|
1026
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceinsidehashliteralbraces
|
|
1027
|
+
Layout/SpaceInsideHashLiteralBraces:
|
|
1028
|
+
Description: Use spaces inside hash literal braces - or don't.
|
|
1029
|
+
StyleGuide: "#spaces-braces"
|
|
1030
|
+
Enabled: true
|
|
1031
|
+
VersionAdded: '0.49'
|
|
1032
|
+
EnforcedStyle: space
|
|
1033
|
+
SupportedStyles:
|
|
1034
|
+
- space
|
|
1035
|
+
- no_space
|
|
1036
|
+
- compact
|
|
1037
|
+
EnforcedStyleForEmptyBraces: no_space
|
|
1038
|
+
SupportedStylesForEmptyBraces:
|
|
1039
|
+
- space
|
|
1040
|
+
- no_space
|
|
1041
|
+
|
|
1042
|
+
# Supports --autocorrect
|
|
1043
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceinsideparens
|
|
1044
|
+
Layout/SpaceInsideParens:
|
|
1045
|
+
Description: No spaces after ( or before ).
|
|
1046
|
+
StyleGuide: "#spaces-braces"
|
|
1047
|
+
Enabled: true
|
|
1048
|
+
VersionAdded: '0.49'
|
|
1049
|
+
VersionChanged: '1.22'
|
|
1050
|
+
EnforcedStyle: no_space
|
|
1051
|
+
SupportedStyles:
|
|
1052
|
+
- space
|
|
1053
|
+
- compact
|
|
1054
|
+
- no_space
|
|
1055
|
+
|
|
1056
|
+
# Supports --autocorrect
|
|
1057
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceinsidepercentliteraldelimiters
|
|
1058
|
+
Layout/SpaceInsidePercentLiteralDelimiters:
|
|
1059
|
+
Description: No unnecessary spaces inside delimiters of %i/%w/%x literals.
|
|
1060
|
+
Enabled: true
|
|
1061
|
+
VersionAdded: '0.49'
|
|
1062
|
+
|
|
1063
|
+
# Supports --autocorrect
|
|
1064
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceinsiderangeliteral
|
|
1065
|
+
Layout/SpaceInsideRangeLiteral:
|
|
1066
|
+
Description: No spaces inside range literals.
|
|
1067
|
+
StyleGuide: "#no-space-inside-range-literals"
|
|
1068
|
+
Enabled: true
|
|
1069
|
+
VersionAdded: '0.49'
|
|
1070
|
+
|
|
1071
|
+
# Supports --autocorrect
|
|
1072
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceinsidereferencebrackets
|
|
1073
|
+
Layout/SpaceInsideReferenceBrackets:
|
|
1074
|
+
Description: Checks the spacing inside referential brackets.
|
|
1075
|
+
Enabled: true
|
|
1076
|
+
VersionAdded: '0.52'
|
|
1077
|
+
VersionChanged: '0.53'
|
|
1078
|
+
EnforcedStyle: no_space
|
|
1079
|
+
SupportedStyles:
|
|
1080
|
+
- space
|
|
1081
|
+
- no_space
|
|
1082
|
+
EnforcedStyleForEmptyBrackets: no_space
|
|
1083
|
+
SupportedStylesForEmptyBrackets:
|
|
1084
|
+
- space
|
|
1085
|
+
- no_space
|
|
1086
|
+
|
|
1087
|
+
# Supports --autocorrect
|
|
1088
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutspaceinsidestringinterpolation
|
|
1089
|
+
Layout/SpaceInsideStringInterpolation:
|
|
1090
|
+
Description: Checks for padding/surrounding spaces inside string interpolation.
|
|
1091
|
+
StyleGuide: "#string-interpolation"
|
|
1092
|
+
Enabled: true
|
|
1093
|
+
VersionAdded: '0.49'
|
|
1094
|
+
EnforcedStyle: no_space
|
|
1095
|
+
SupportedStyles:
|
|
1096
|
+
- space
|
|
1097
|
+
- no_space
|
|
1098
|
+
|
|
1099
|
+
# Supports --autocorrect
|
|
1100
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layouttrailingemptylines
|
|
1101
|
+
Layout/TrailingEmptyLines:
|
|
1102
|
+
Description: Checks trailing blank lines and final newline.
|
|
1103
|
+
StyleGuide: "#newline-eof"
|
|
1104
|
+
Enabled: true
|
|
1105
|
+
VersionAdded: '0.49'
|
|
1106
|
+
VersionChanged: '0.77'
|
|
1107
|
+
EnforcedStyle: final_newline
|
|
1108
|
+
SupportedStyles:
|
|
1109
|
+
- final_newline
|
|
1110
|
+
- final_blank_line
|
|
1111
|
+
|
|
1112
|
+
# Supports --autocorrect
|
|
1113
|
+
# https://docs.rubocop.org/rubocop/cops_layout.html#layouttrailingwhitespace
|
|
1114
|
+
Layout/TrailingWhitespace:
|
|
1115
|
+
Description: Avoid trailing whitespace.
|
|
1116
|
+
StyleGuide: "#no-trailing-whitespace"
|
|
1117
|
+
Enabled: true
|
|
1118
|
+
VersionAdded: '0.49'
|
|
1119
|
+
VersionChanged: '1.0'
|
|
1120
|
+
AllowInHeredoc: false
|
|
1121
|
+
|