aboutsummaryrefslogtreecommitdiffstats
path: root/Library/.rubocop.yml
blob: cb065a1a4b569e263c3445cfc93f78aa7688dc1e (plain)
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
AllCops:
  TargetRubyVersion: 2.0
  Exclude:
    - '**/Casks/**/*'
    - '**/vendor/**/*'

require: ./Homebrew/rubocops.rb

FormulaAudit:
  Enabled: true

FormulaAuditStrict:
  Enabled: true

NewFormulaAudit:
  Enabled: false

# `system` is a special case and aligns on second argument
Layout/AlignParameters:
  Enabled: false

Layout/CaseIndentation:
  EnforcedStyle: end

Layout/EmptyLineBetweenDefs:
  AllowAdjacentOneLineDefs: true

Layout/IndentArray:
  EnforcedStyle: special_inside_parentheses

Layout/IndentHeredoc:
  EnforcedStyle: unindent

# conflicts with DSL-style path concatenation with `/`
Layout/SpaceAroundOperators:
  Enabled: false

# favor parens-less DSL-style arguments
Lint/AmbiguousOperator:
  Enabled: false

# so many of these in formulae and can't be autocorrected
Lint/AmbiguousRegexpLiteral:
  Enabled: false

# favor parens-less DSL-style arguments
Lint/AmbiguousBlockAssociation:
  Enabled: false

# assignment in conditions are useful sometimes
Lint/AssignmentInCondition:
  Enabled: false

Lint/EndAlignment:
  EnforcedStyleAlignWith: variable

# so many of these in formulae and can't be autocorrected
Lint/ParenthesesAsGroupedExpression:
  Enabled: false

# TODO: try to bring down all metrics maximums
Metrics/AbcSize:
  Max: 250

Metrics/BlockLength:
  Max: 1250

Metrics/ClassLength:
  Max: 1500

Metrics/CyclomaticComplexity:
  Max: 75

Metrics/LineLength:
  Max: 400

Metrics/MethodLength:
  Max: 250

Metrics/ModuleLength:
  CountComments: false
  Exclude:
    - '**/bin/**/*'
    - '**/cmd/**/*'
    - '**/lib/**/*'

Metrics/PerceivedComplexity:
  Max: 100

# makes code less readable for minor performance increases
Performance/Caller:
  Enabled: false

Style/Alias:
  EnforcedStyle: prefer_alias

Style/AutoResourceCleanup:
  Enabled: true

Style/BarePercentLiterals:
  EnforcedStyle: percent_q

Style/BlockDelimiters:
  EnforcedStyle: line_count_based

Style/ClassAndModuleChildren:
  EnforcedStyle: nested

# our current conditional style is established, clear and
# requiring users to change that now would be confusing.
Style/ConditionalAssignment:
  Enabled: false

# most of our APIs are internal so don't require docs
Style/Documentation:
 Enabled: false

Style/Encoding:
  Enabled: true

# dashes in filenames are typical
Style/FileName:
  Regex: !ruby/regexp /^[\w\@\-\+\.]+(\.rb)?$/

# falsely flags e.g. curl formatting arguments as format strings
Style/FormatStringToken:
  Enabled: false

# so many of these in formulae and can't be autocorrected
Style/GuardClause:
  Enabled: false

# depends_on a: :b looks weird in formulae.
Style/HashSyntax:
  EnforcedStyle: hash_rockets
  Exclude:
    - '**/bin/**/*'
    - '**/cmd/**/*'
    - '**/lib/**/*'
    - '**/spec/**/*'

# only for numbers >= 1_000_000
Style/NumericLiterals:
  MinDigits: 7

# zero-prefixed octal literals are just too widely used (and mostly understood)
Style/NumericLiteralPrefix:
  EnforcedOctalStyle: zero_only

# consistency and readability when faced with string interpolation
Style/PercentLiteralDelimiters:
  PreferredDelimiters:
    '%':  '()'
    '%i': '()'
    '%q': '()'
    '%Q': '()'
    '%r': '{}'
    '%s': '()'
    '%w': '[]'
    '%W': '[]'
    '%x': '()'

Style/RaiseArgs:
  EnforcedStyle: exploded

# paths abound, easy escape
Style/RegexpLiteral:
  EnforcedStyle: slashes

# ruby style guide favorite
Style/StringLiterals:
  EnforcedStyle: double_quotes

# consistency with above
Style/StringLiteralsInInterpolation:
  EnforcedStyle: double_quotes

Style/SymbolArray:
  EnforcedStyle: brackets

Style/TernaryParentheses:
  EnforcedStyle: require_parentheses_when_complex

# makes diffs nicer
Style/TrailingCommaInLiteral:
  EnforcedStyleForMultiline: comma

Style/TrailingCommaInArguments:
  EnforcedStyleForMultiline: comma

# we have too many variables like sha256 where this harms readability
Style/VariableNumber:
  Enabled: false

Style/WordArray:
  MinSize: 4