-
Notifications
You must be signed in to change notification settings - Fork 0
/
.rubocop.yml
304 lines (241 loc) · 8.79 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
# target_version:
# rubocop v0.36.0 # TODO: update rubocop version
# 自動生成されるものはチェック対象から除外する
AllCops:
DisplayCopNames: true
Exclude:
- bin/**/*
- config/**/*
- db/**/*
- logs_db/**/*
- spec/*_helper.rb
- tmp/**/*
- vendor/**/*
- node_modules/node-sass/src/libsass/**/*
TargetRubyVersion: 2.5
##################### Style ##################################
PercentLiteralDelimiters:
PreferredDelimiters:
default: ()
'%i': '[]'
'%I': '[]'
'%r': '{}'
'%w': '[]'
'%W': '[]'
# レキシカルスコープの扱いが alias_method の方が自然。
# https://ernie.io/2014/10/23/in-defense-of-alias/ のように
# 問題になる場合は自分で緩める。
Style/Alias:
EnforcedStyle: prefer_alias_method
# redirect_to xxx and return のイディオムを維持したい
Style/AndOr:
EnforcedStyle: conditionals
# 日本語のコメントを許可する
Style/AsciiComments:
Enabled: false
# do .. end から更にメソッドチェーンすると見づらいので
# auto-correct せず、自分で修正する
# spec 内は見た目が綺麗になるので許可
Style/BlockDelimiters:
AutoCorrect: false
Exclude:
- "spec/**/*"
# option 等、明示的にハッシュにした方が分かりやすい場合もある
Style/BracesAroundHashParameters:
Enabled: false
# scope が違うとか親 module の存在確認が必要とかデメリットはあるが、
# namespace 付きのクラスはかなり頻繁に作るので簡単に書きたい。
Style/ClassAndModuleChildren:
Enabled: false
# Style/CollectionMethods 自体は無効になっているのだが、
# https://github.com/bbatsov/rubocop/issues/1084
# https://github.com/bbatsov/rubocop/issues/1334
# Performance/Detect がこの設定値を見るので PreferredMethods だけ変更しておく。
#
# デフォルト値から変えたのは
# find -> detect
# ActiveRecord の find と間違えやすいため
# reduce -> inject
# detect, reject, select と並べたときに韻を踏んでいるため。
# collect -> map を維持しているのは文字数が圧倒的に少ないため。
Style/CollectionMethods:
PreferredMethods:
detect: "detect"
find: "detect"
inject: "inject"
reduce: "inject"
# ドキュメントの無い public class を許可する
Style/Documentation:
Enabled: false
# !! のイディオムは積極的に使う
Style/DoubleNegation:
Enabled: false
# 明示的に else で nil を返すのは分かりやすいので許可する
Style/EmptyElse:
EnforcedStyle: empty
# いずれかに揃えるのならば `sprintf` や `format` より String#% が好きです
Style/FormatString:
EnforcedStyle: percent
Style/FrozenStringLiteralComment:
Enabled: always
# if 文の中に 3 行程度のブロックを書くぐらいは許容した方が現実的
# NOTE: https://github.com/bbatsov/rubocop/commit/29945958034db13af9e8ff385ec58cb9eb464596
# の影響で、if 文の中身が 1 行の場合に警告されるようになっている。
# Style/IfUnlessModifier の設定見てくれないかなぁ? (v0.36.0)
Style/GuardClause:
MinBodyLength: 5
# rake タスクの順序の hash は rocket を許可する
Style/HashSyntax:
Exclude:
- "**/*.rake"
- "Rakefile"
# 平たくしてしまうと条件のグルーピングが脳内モデルとズレやすい
Style/IfInsideElse:
Enabled: false
# 条件式の方を意識させたい場合には後置の if/unless を使わない方が分かりやすい
Style/IfUnlessModifier:
Enabled: false
# end.some_method とチェインするのはダサい
# Style/BlockDelimiters と相性が悪いけど、頑張ってコードを修正してください
Style/MethodCalledOnDoEndBlock:
Enabled: true
# 1_000_000 と区切り文字が 2 個以上必要になる場合のみ _ 区切りを必須にする
Style/NumericLiterals:
MinDigits: 7
# 正規表現にマッチさせた時の特殊変数の置き換えは Regex.last_match ではなく
# 名前付きキャプチャを使って参照したいので auto-correct しない
Style/PerlBackrefs:
AutoCorrect: false
# 特に model 内において、ローカル変数とメソッド呼び出しの区別をつけた方が分かりやすい場合が多い
Style/RedundantSelf:
Enabled: false
# Exception.new(arg) を渡す raise を許可
Style/RaiseArgs:
Enabled: false
# 受け取り側で multiple assignment しろというのを明示
Style/RedundantReturn:
AllowMultipleReturnValues: true
# spec 内は見た目が綺麗になるので許可
Style/Semicolon:
Exclude:
- "spec/**/*"
# 式展開しないときにはsingleを使う
Style/StringLiterals:
EnforcedStyle: single_quotes
# auto-correct 時に Style/StringLiterals とカニバって無限ループになる (v0.28.0)
Style/StringLiteralsInInterpolation:
Enabled: false
# いくらなんでも inject { |a, e| } は短すぎるので分かりやすい名前をつけたい
Style/SingleLineBlockParams:
Enabled: false
# fail/raiseを使い分けなくてもよい
Style/SignalException:
Enabled: false
Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: comma
Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: comma
# scope 等は複数行でも lambda ではなく ->{} で揃えた方が見た目が綺麗
Style/Lambda:
EnforcedStyle: literal
##################### Lint ##################################
# * 同名のメソッドがある場合にローカル変数に `_` を付ける
# * 一時変数として `_` を付ける
# というテクニックは頻出する
Lint/UnderscorePrefixedVariableName:
Enabled: false
# 子クラスで実装させるつもりのメソッドで引っかかるので
Lint/UnusedMethodArgument:
Enabled: false
# 何もしないrescueを許可
Lint/HandleExceptions:
Enabled: false
# 条件文の中での代入を許可
Lint/AssignmentInCondition:
Enabled: false
##################### Metrics ##################################
# 30まではギリギリ許せる範囲だったけど
# リリースごとに 3 ずつぐらい下げていきます。20まで下げたい。
Metrics/AbcSize:
Max: 30
# 6 は強すぎるので緩める
Metrics/CyclomaticComplexity:
Max: 10
# * 警告 120文字
# * 禁止 160文字
# のイメージ
Metrics/LineLength:
Max: 160
Exclude:
- "db/migrate/*.rb"
# 20 行超えるのは migration ファイル以外滅多に無い
Metrics/MethodLength:
Max: 20
Exclude:
- "db/migrate/*.rb"
# 分岐の数。ガード句を多用しているとデフォルト 7 だと厳しい
Metrics/PerceivedComplexity:
Max: 8
# FIXME: この設定はprogramモデルのリファクタリングを実施する際に削除する
Metrics/ClassLength:
Enabled: false
# Gemfile, Guardfile は DSL 的で基本的に複雑にはならないので除外
# routes は巨大な block 不可避なので除外
Metrics/BlockLength:
Exclude:
- "**/*.rake"
- "config/routes.rb"
- "Gemfile"
- "Rakefile"
- "spec/**/*.rb"
- "lib/capistrano/tasks/unicorn.rb"
Metrics/ParameterLists:
Max: 6
##################### Layout #################################
# special_inside_parentheses (default) と比べて
# * 横に長くなりづらい
# * メソッド名の長さが変わったときに diff が少ない
Layout/IndentArray:
EnforcedStyle: consistent
# ({ と hash を開始した場合に ( の位置にインデントさせる
# そもそも {} が必要ない可能性が高いが Style/BracesAroundHashParameters はチェックしないことにしたので
Layout/IndentHash:
EnforcedStyle: consistent
Layout/DotPosition:
EnforcedStyle: leading
# メソッド呼び出しの行から1段階インデントする
Layout/AlignParameters:
EnforcedStyle: with_fixed_indentation
# private/protected は一段深くインデントする
Layout/IndentationConsistency:
Enabled: false
# メソッドチェインする場合のインデント設定
Layout/MultilineMethodCallIndentation:
EnforcedStyle: indented
# ブロックの直前にはスペースを入れる
Layout/SpaceBeforeBlockBraces:
EnforcedStyle: space
Style/EmptyMethod:
EnforcedStyle: expanded
##################### Naming #################################
# has_ から始まるメソッドは許可する
Naming/PredicateName:
NamePrefixBlacklist:
- "is_"
- "have_"
NamePrefix:
- "is_"
- "have_"
##################### Rails ##################################
Rails:
Enabled: true
# Date.today, Date#to_time はtimezoneを考慮しないので使わない
# current, yesterday, tomorrow は許可
Rails/Date:
EnforcedStyle: flexible
# validates_xxx_of を許可
Rails/Validation:
Enabled: false
# update_all や update_attributeなどのvalidationをskipするメソッドを許可
Rails/SkipsModelValidations:
Enabled: false