-
Notifications
You must be signed in to change notification settings - Fork 26
/
default.yml
256 lines (221 loc) · 6.4 KB
/
default.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
inherit_mode:
merge:
- Exclude
Sorbet/AllowIncompatibleOverride:
Description: 'Disallows using `.override(allow_incompatible: true)`.'
Enabled: true
VersionAdded: 0.2.0
Sorbet/BindingConstantWithoutTypeAlias:
Description: >-
Disallows binding the return value of `T.any`, `T.all`, `T.enum`
to a constant directly. To bind the value, one must use `T.type_alias`.
Enabled: true
VersionAdded: 0.2.0
Sorbet/CallbackConditionalsBinding:
Description: 'Ensures callback conditionals are bound to the right type.'
Enabled: false
Safe: false
VersionAdded: 0.7.0
Sorbet/CheckedTrueInSignature:
Description: 'Disallows the usage of `checked(true)` in signatures.'
Enabled: true
VersionAdded: 0.2.0
Sorbet/EmptyLineAfterSig:
Description: 'Ensures that there are no blank lines after signatures'
Enabled: true
VersionAdded: 0.7.0
Sorbet/ConstantsFromStrings:
Description: >-
Forbids constant access through meta-programming.
For example, things like `constantize` or `const_get`
are forbidden.
Enabled: true
VersionAdded: 0.2.0
Sorbet/EnforceSigilOrder:
Description: 'Ensures that Sorbet sigil comes first in a file.'
Enabled: true
VersionAdded: 0.3.4
Sorbet/EnforceSingleSigil:
Description: 'Ensures that there is only one Sorbet sigil in a file.'
Enabled: true
VersionAdded: 0.7.0
Sorbet/EnforceSignatures:
Description: 'Ensures all methods have a valid signature.'
Enabled: false
VersionAdded: 0.3.4
Sorbet/FalseSigil:
Description: 'All files must be at least at strictness `false`.'
Enabled: true
VersionAdded: 0.3.3
SuggestedStrictness: "false"
Include:
- "**/*.{rb,rbi,rake,ru}"
Exclude:
- bin/**/*
- db/**/*.rb
- script/**/*
Sorbet/FetchWhenMust:
Description: >-
Checks for `T.must(object[key])` and recommends `object.fetch(key)` instead.
While usually safe, false positives are possible if `object` does not respond to `fetch`,
or if `Hash#default_proc` (or similar) is being used.
Enabled: pending
VersionAdded: '<<next>>'
Safe: false
SafeAutoCorrect: false
Sorbet/ForbidExtendTSigHelpersInShims:
Description: 'Forbid the use of `extend T::Sig` and `extend T::Helpers` in RBI shims'
Enabled: true
VersionAdded: '0.6.0'
Include:
- "**/*.rbi"
Sorbet/ForbidRBIOutsideOfAllowedPaths:
Description: 'Forbids RBI files outside of the allowed paths'
Enabled: true
VersionAdded: 0.6.1
AllowedPaths:
- "rbi/**"
- "sorbet/rbi/**"
Include:
- "**/*.rbi"
Sorbet/ForbidIncludeConstLiteral:
Description: 'Forbids include of non-literal constants.'
Enabled: false
VersionAdded: 0.2.0
VersionChanged: 0.5.0
Sorbet/ForbidSuperclassConstLiteral:
Description: 'Forbid superclasses which are non-literal constants.'
Enabled: false
VersionAdded: 0.2.0
VersionChanged: 0.6.1
Exclude:
- db/migrate/*.rb
Sorbet/ForbidTUnsafe:
Description: 'Forbid usage of T.unsafe.'
Enabled: false
VersionAdded: 0.7.0
VersionChanged: 0.7.0
Sorbet/ForbidTUntyped:
Description: 'Forbid usage of T.untyped'
Enabled: false
VersionAdded: 0.6.9
VersionChanged: 0.7.0
Sorbet/ForbidUntypedStructProps:
Description: >-
Disallows use of `T.untyped` or `T.nilable(T.untyped)` as a
prop type for `T::Struct` subclasses.
Enabled: true
VersionAdded: 0.4.0
Sorbet/HasSigil:
Description: 'Makes the Sorbet typed sigil mandatory in all files.'
Enabled: false
SuggestedStrictness: "false"
MinimumStrictness: "false"
VersionAdded: 0.3.3
Include:
- "**/*.{rb,rbi,rake,ru}"
Exclude:
- bin/**/*
- db/**/*.rb
- script/**/*
Sorbet/IgnoreSigil:
Description: 'All files must be at least at strictness `ignore`.'
Enabled: false
SuggestedStrictness: "ignore"
VersionAdded: 0.3.3
Include:
- "**/*.{rb,rbi,rake,ru}"
Exclude:
- bin/**/*
- db/**/*.rb
- script/**/*
Sorbet/KeywordArgumentOrdering:
Description: >-
Enforces a compatible keyword arguments with Sorbet.
All keyword arguments must be at the end of the parameters
list, and all keyword arguments with a default value must be
after those without default values.
Enabled: true
VersionAdded: 0.2.0
Sorbet/OneAncestorPerLine:
Description: 'Enforces one ancestor per call to requires_ancestor'
Enabled: false
VersionAdded: '0.6.0'
Sorbet/RedundantExtendTSig:
Description: >-
Forbid the usage of redundant `extend T::Sig`.
Only for use in applications that monkey patch `Module.include(T::Sig)` directly,
where it is useful to reduce noise.
Enabled: false
Safe: false
VersionAdded: 0.7.0
Sorbet/SignatureBuildOrder:
Description: >-
Enforces the order of parts in a signature.
The order is first inheritance related builders,
then params, then return and finally the modifier
such as: `abstract.params(...).returns(...).soft`.'
Enabled: true
VersionAdded: 0.3.0
Sorbet/SingleLineRbiClassModuleDefinitions:
Description: 'Empty class and module definitions in RBI must be on a single line.'
Enabled: false
VersionAdded: '0.6.0'
Include:
- "**/*.rbi"
Sorbet/StrictSigil:
Description: 'All files must be at least at strictness `strict`.'
Enabled: false
SuggestedStrictness: "strict"
VersionAdded: 0.3.3
Include:
- "**/*.{rb,rbi,rake,ru}"
Exclude:
- bin/**/*
- db/**/*.rb
- script/**/*
Sorbet/StrongSigil:
Description: 'All files must be at least at strictness `strong`.'
Enabled: false
SuggestedStrictness: "strong"
VersionAdded: 0.3.3
Include:
- "**/*.{rb,rbi,rake,ru}"
Exclude:
- bin/**/*
- db/**/*.rb
- script/**/*
Sorbet/TrueSigil:
Description: 'All files must be at least at strictness `true`.'
Enabled: false
SuggestedStrictness: "true"
VersionAdded: 0.3.3
Include:
- "**/*.{rb,rbi,rake,ru}"
Exclude:
- bin/**/*
- db/**/*.rb
- script/**/*
Sorbet/TypeAliasName:
Description: 'Type alias constant names must be in CamelCase.'
Enabled: true
VersionAdded: 0.6.6
Include:
- "**/*.{rb,rbi,rake,ru}"
Exclude:
- bin/**/*
- db/**/*.rb
- script/**/*
Sorbet/ValidSigil:
Description: 'All files must have a valid sigil.'
Enabled: true
RequireSigilOnAllFiles: false
SuggestedStrictness: "false"
MinimumStrictness: "false"
VersionAdded: 0.3.3
Include:
- "**/*.{rb,rbi,rake,ru}"
Exclude:
- bin/**/*
- db/**/*.rb
- script/**/*