-
Notifications
You must be signed in to change notification settings - Fork 0
/
.swiftlint.yml
245 lines (233 loc) · 7.18 KB
/
.swiftlint.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
included:
- Sources
- Tests
excluded:
- Tests/DecimalTests/Generated
- Tests/DecimalTests/Intel - generated
- Tests/DecimalTests/Speleotrove - generated
# Try to stay below 80
line_length:
warning: 100
error: 120
# We will list all of the SwiftLint rules deciding on a case-by-case basis
# whether we want to enable them or not. Otherwise people with newer SwiftLint
# version may be flooded with errors from rules that we have not checked against.
only_rules:
# =============
# === Rules ===
# =============
# Here we are listing all of the non-optional rules.
# If some rule should be disabled then the line should be commented.
- block_based_kvo
- class_delegate_protocol
- closing_brace
- closure_parameter_position
- comma
- comment_spacing
- compiler_protocol_init
- computed_accessors_order
- control_statement
- custom_rules
- deployment_target
- discouraged_direct_init
- duplicate_enum_cases
- duplicate_imports
- dynamic_inline
- empty_enum_arguments
- empty_parameters
- empty_parentheses_with_trailing_closure
- for_where
- force_cast
- force_try
- generic_type_name
- implicit_getter
- inclusive_language
- inert_defer
- is_disjoint
- leading_whitespace
- legacy_cggeometry_functions
- legacy_constant
- legacy_constructor
- legacy_hashing
- legacy_nsgeometry_functions
- line_length
- mark
- multiple_closures_with_trailing_closure
- nesting
- no_fallthrough_only
- no_space_in_method_call
- notification_center_detachment
- nsobject_prefer_isequal
- opening_brace
- operator_whitespace
- orphaned_doc_comment
- private_over_fileprivate
- private_unit_test
- protocol_property_accessors_order
- reduce_boolean
- redundant_discardable_let
- redundant_objc_attribute
- redundant_optional_initialization
- redundant_set_access_control
- redundant_string_enum_value
- redundant_void_return
- return_arrow_whitespace
- shorthand_operator
- statement_position
- superfluous_disable_command
- switch_case_alignment
- syntactic_sugar
- todo
- trailing_newline
- trailing_semicolon
- trailing_whitespace
- unneeded_break_in_switch
- unused_capture_list
- unused_closure_parameter
- unused_control_flow_label
- unused_enumerated
- unused_optional_binding
- unused_setter_value
- valid_ibinspectable
- vertical_parameter_alignment
- vertical_whitespace
- void_return
- weak_delegate
- xctfail_message
# ==============================
# === Enabled optional rules ===
# ==============================
# This may seem like a lot, but basically we enable all of the optional rules
# that do not break existing code.
- anyobject_protocol
- array_init
- attributes
- closure_body_length
- closure_end_indentation
- closure_spacing
- collection_alignment
- contains_over_filter_count
- contains_over_filter_is_empty
- contains_over_first_not_nil
- contains_over_range_nil_comparison
- convenience_type
- discouraged_assert
- discouraged_object_literal
- discouraged_optional_boolean
- discouraged_optional_collection
- empty_collection_literal
- empty_count
- empty_string
- empty_xctest_method
- enum_case_associated_values_count
- explicit_init
- explicit_self
- fallthrough
- fatal_error_message
- file_header
- first_where
- flatmap_over_map_reduce
- force_unwrapping
- function_default_parameter_at_end
- identical_operands
- implicitly_unwrapped_optional
- joined_default_parameter
- last_where
- legacy_multiple
- legacy_objc_type # we don't use Objective-C, but why not?
- legacy_random
- let_var_whitespace
- literal_expression_end_indentation
- lower_acl_than_parent
- modifier_order
- multiline_arguments
- multiline_arguments_brackets # we sometimes put '(' at the same line as call
- multiline_function_chains
- multiline_literal_brackets
- multiline_parameters
- multiline_parameters_brackets # we sometimes put '(' at the same line as 'func' declaration
- nimble_operator
- no_extension_access_modifier
- object_literal
- operator_usage_whitespace
- optional_enum_case_matching
- overridden_super_call
- override_in_extension
- pattern_matching_keywords
- prefer_self_type_over_type_of_self
- prefer_zero_over_explicit_init
- private_action
- private_outlet
- prohibited_interface_builder
- prohibited_super_call
- quick_discouraged_call
- quick_discouraged_focused_test
- quick_discouraged_pending_test
- raw_value_for_camel_cased_codable_enum # we don't use 'Codable', but why not
- reduce_into
- redundant_nil_coalescing
- redundant_type_annotation
- required_enum_case
- single_test_class
- sorted_first_last
- static_operator
- toggle_bool
- trailing_closure
- unavailable_function
- unneeded_parentheses_in_closure_argument
- unowned_variable_capture
- untyped_error_in_catch
- unused_declaration
- unused_import
- vertical_parameter_alignment_on_call
- vertical_whitespace_closing_braces
- xct_specific_matcher
- yoda_condition
# ===================
# === Maybe later ===
# ===================
# - missing_docs
# ===============================
# === Disabled optional rules ===
# ===============================
# - balanced_xctest_lifecycle # this does not make sense for us
# - colon # align properties
# - conditional_returns_on_newline # Very often we do 'if X { return Y }'
# - cyclomatic_complexity # too annoying
# - discarded_notification_center_observer # we do not use NotificationCenter
# - expiring_todo # just use TODO, we do not have deadlines
# - explicit_acl # we don't need acl in tests
# - explicit_enum_raw_value # 'String' enums do not need explicit value
# - explicit_top_level_acl # this one requires us to put acl before 'extension XXX'
# - explicit_type_interface # this is weird
# - extension_access_modifier
# - file_length # too limiting
# - file_name # we heavily use extensions for single type
# - file_name_no_space # we have tons of those
# - file_types_order # declare helper type near usage
# - function_body_length # too limiting
# - function_parameter_count # too limiting
# - ibinspectable_in_extension # only for iOS
# - identifier_name # annoying
# - implicit_return # Cool for properties, not cool for functions
# - indentation_width # breaks when we have arguments/parameters in multiple lines
# - large_tuple
# - no_grouping_extension
# - nslocalizedstring_key # only for iOS
# - nslocalizedstring_require_bundle # only for iOS
# - number_separator # We have SwiftFormat for this
# - prefer_nimble # We are using 'XCTAssert'
# - prefixed_toplevel_constant
# - private_subject # we do not use 'Combine'
# - required_deinit
# - sorted_imports # use 'Scripts/sort_swift_imports'
# - strict_fileprivate # this one does not work properly?
# - strong_iboutlet # only for iOS
# - switch_case_on_newline # 'case let .error(e): return .error(e)' is an Violet idiom
# - test_case_accessibility # We sometimes create class hierarchy
# - trailing_comma # avoid git blame when adding new value
# - type_body_length # too limiting
# - type_contents_order
# - type_name
# - vertical_whitespace_between_cases
# - vertical_whitespace_opening_braces