appsignal-ruby/.rubocop.yml at b53c2110b7209e924c6bac7a3d395f21d9550e6b · appsignal/appsignal-ruby · GitHub

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
AllCops:
  TargetRubyVersion: 2.7
  NewCops: enable
  Include:
    - "**/*.rb"
    - "**/*.cap"
    - "**/*.rake"
    - "**/Gemfile"
    - "**/Rakefile"
    - "appsignal.gemspec"
  Exclude:
    - "*.rbs"
    - "*.rbi"
    - "pkg/**/*"
    - "tmp/**/*"
    - "vendor/**/*"
    - "spec/integration/diagnose/**/*"
  DisplayCopNames: true
  UseCache: true
  CacheRootDirectory: ./tmp

Style/RescueStandardError:
  Enabled: false

Style/Documentation:
  Enabled: false

Style/StringLiterals:
  EnforcedStyle: double_quotes

Style/StringLiteralsInInterpolation:
  EnforcedStyle: double_quotes

Style/HashSyntax:
  EnforcedStyle: hash_rockets

Style/EmptyMethod:
  EnforcedStyle: expanded

Style/MissingRespondToMissing:
  Exclude:
    - "lib/appsignal/extension.rb"
    - "lib/appsignal/transaction.rb"

Style/TrailingUnderscoreVariable:
  Enabled: false

Style/Lambda:
  EnforcedStyle: lambda

Style/WordArray:
  Enabled: false

Style/FrozenStringLiteralComment:
  Enabled: true
  Exclude:
    - "spec/**/*.rb"

Style/NumericPredicate:
  Enabled: false

Style/SymbolArray:
  EnforcedStyle: brackets

Style/RedundantConstantBase:
  Enabled: false

# Keep the detection but never autocorrect: removing the `\` after a `%()`
# literal silently breaks adjacent-string concatenation, turning the joined
# string into dead code. Let it flag for a human instead of rewriting.
Style/RedundantLineContinuation:
  AutoCorrect: false

# We rescue Exception only in deliberate, reviewed places: integrations that
# record the error and re-raise it, and a spec helper that retries on RSpec
# expectation failures (ExpectationNotMetError subclasses Exception). The cop
# can't tell these from a careless rescue, so we disable it rather than scatter
# inline disables.
Lint/RescueException:
  Enabled: false

Lint/ConstantDefinitionInBlock:
  Exclude:
    - "spec/**/*.rb"

Lint/EmptyClass:
  Exclude:
    - "spec/**/*.rb"

Lint/EmptyFile:
  Exclude:
    - "spec/**/*.rb"

Layout/HashAlignment:
  EnforcedLastArgumentHashStyle: ignore_implicit

Layout/ArgumentAlignment:
  EnforcedStyle: with_fixed_indentation

Layout/LineContinuationLeadingSpace:
  Enabled: false

Layout/FirstArrayElementIndentation:
  EnforcedStyle: consistent

Layout/LineEndStringConcatenationIndentation:
  EnforcedStyle: indented

Layout/ParameterAlignment:
  EnforcedStyle: with_fixed_indentation

Layout/MultilineMethodCallIndentation:
  EnforcedStyle: indented

Layout/MultilineOperationIndentation:
  EnforcedStyle: indented

Layout/LineLength:
  Max: 100

Naming/FileName:
  Exclude:
    - "ext/Rakefile"

# Our API mirrors the agent's set_*/get_* method names, a convention used
# throughout the gem and the extension. We follow it deliberately, so disable
# the cop instead of scattering excludes and inline disables for it.
Naming/AccessorMethodName:
  Enabled: false

# Several command methods return a boolean status (abort_installation,
# Demo.transmit). The cop wants them renamed with a `?`, which would wrongly
# read them as queries, so we don't run it.
Naming/PredicateMethod:
  Enabled: false

Naming/RescuedExceptionsVariableName:
  Enabled: false

Naming/VariableNumber:
  Enabled: false

# Complexity and length metrics were never enforced here: their thresholds
# floated for years through `rubocop --auto-gen-config` and the remaining hits
# were silenced inline. They flag a style we deliberately accept, so instead of
# tracking an ever-changing Max we don't run them.
Metrics/AbcSize:
  Enabled: false

Metrics/BlockLength:
  Enabled: false

Metrics/ClassLength:
  Enabled: false

Metrics/CyclomaticComplexity:
  Enabled: false

Metrics/MethodLength:
  Enabled: false

Metrics/ModuleLength:
  Enabled: false

Metrics/PerceivedComplexity:
  Enabled: false

Gemspec/DevelopmentDependencies:
  Enabled: false