-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
.editorconfig
450 lines (342 loc) · 15.8 KB
/
.editorconfig
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
# editorconfig.org
# top-most EditorConfig file
root = true
# Default settings:
# A newline ending every file
# Use 4 spaces as indentation
[*]
insert_final_newline = true
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
[project.json]
indent_size = 2
[*.txt]
insert_final_newline = false
# C# files
[*.cs]
# New line preferences
csharp_new_line_before_open_brace = all
csharp_new_line_before_else = true
csharp_new_line_before_catch = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_between_query_expression_clauses = true
# Indentation preferences
csharp_indent_block_contents = true
csharp_indent_braces = false
csharp_indent_case_contents = true
csharp_indent_case_contents_when_block = true
csharp_indent_switch_labels = true
csharp_indent_labels = one_less_than_current
# Modifier preferences
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
# avoid this. unless absolutely necessary
dotnet_style_qualification_for_field = false:suggestion
dotnet_style_qualification_for_property = false:suggestion
dotnet_style_qualification_for_method = false:suggestion
dotnet_style_qualification_for_event = false:suggestion
# Types: use keywords instead of BCL types, and permit var only when the type is clear
csharp_style_var_for_built_in_types = false:suggestion
csharp_style_var_when_type_is_apparent = false:none
csharp_style_var_elsewhere = false:suggestion
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
dotnet_style_predefined_type_for_member_access = true:suggestion
# name all constant fields using PascalCase
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
dotnet_naming_symbols.constant_fields.applicable_kinds = field
dotnet_naming_symbols.constant_fields.required_modifiers = const
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
# static fields should have s_ prefix
dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields
dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style
dotnet_naming_symbols.static_fields.applicable_kinds = field
dotnet_naming_symbols.static_fields.required_modifiers = static
dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
dotnet_naming_style.static_prefix_style.required_prefix = s_
dotnet_naming_style.static_prefix_style.capitalization = camel_case
# internal and private fields should be _camelCase
dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion
dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields
dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style
dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
dotnet_naming_style.camel_case_underscore_style.required_prefix = _
dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
# Code style defaults
csharp_using_directive_placement = outside_namespace:suggestion
dotnet_sort_system_directives_first = true
csharp_prefer_braces = true:silent
csharp_preserve_single_line_blocks = true:none
csharp_preserve_single_line_statements = false:none
csharp_prefer_static_local_function = true:suggestion
csharp_prefer_simple_using_statement = false:none
csharp_style_prefer_switch_expression = true:suggestion
# Code quality
dotnet_style_readonly_field = true:suggestion
dotnet_code_quality_unused_parameters = non_public:suggestion
# Expression-level preferences
dotnet_style_object_initializer = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_auto_properties = true:suggestion
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
csharp_prefer_simple_default_expression = true:suggestion
# Expression-bodied members
csharp_style_expression_bodied_methods = true:silent
csharp_style_expression_bodied_constructors = true:silent
csharp_style_expression_bodied_operators = true:silent
csharp_style_expression_bodied_properties = true:silent
csharp_style_expression_bodied_indexers = true:silent
csharp_style_expression_bodied_accessors = true:silent
csharp_style_expression_bodied_lambdas = true:silent
csharp_style_expression_bodied_local_functions = true:silent
# Pattern matching
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
# Null checking preferences
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion
# Other features
csharp_style_prefer_index_operator = false:none
csharp_style_prefer_range_operator = false:none
csharp_style_pattern_local_over_anonymous_function = false:none
# Space preferences
csharp_space_after_cast = false
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_after_comma = true
csharp_space_after_dot = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_after_semicolon_in_for_statement = true
csharp_space_around_binary_operators = before_and_after
csharp_space_around_declaration_statements = do_not_ignore
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_before_comma = false
csharp_space_before_dot = false
csharp_space_before_open_square_brackets = false
csharp_space_before_semicolon_in_for_statement = false
csharp_space_between_empty_square_brackets = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_method_declaration_name_and_open_parenthesis = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
csharp_space_between_square_brackets = false
# Analyzers
dotnet_code_quality.ca1802.api_surface = private, internal
dotnet_code_quality.ca2208.api_surface = public
# CA1852: Seal internal types
dotnet_diagnostic.ca1852.severity = warning
# CA2000: Dispose objects before losing scope
dotnet_diagnostic.ca2000.severity = error
# RS0037: Enable tracking of nullability of reference types in the declared API
# Our API is not annotated but new classes get nullable enabled so disable this.
# We'd be happy if everything was annotated and this could be removed.
dotnet_diagnostic.RS0037.severity = none
# License header
file_header_template = Licensed to the .NET Foundation under one or more agreements.\nThe .NET Foundation licenses this file to you under the MIT license.
# C++ Files
[*.{cpp,h,in}]
curly_bracket_next_line = true
indent_brace_style = Allman
# Xml project files
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}]
indent_size = 2
[*.{csproj,vbproj,proj,nativeproj,locproj}]
charset = utf-8
# Xml build files
[*.builds]
indent_size = 2
# Xml files
[*.{xml,stylecop,resx,ruleset}]
indent_size = 2
# Xml config files
[*.{props,targets,config,nuspec}]
indent_size = 2
# YAML config files
[*.{yml,yaml}]
indent_size = 2
# Shell scripts
[*.sh]
end_of_line = lf
[*.{cmd, bat}]
end_of_line = crlf
[src/**/*.{cs,vb}]
# Code style checks
dotnet_analyzer_diagnostic.category-Style.severity = warning
# Cast is redundant
dotnet_diagnostic.IDE0004.severity = suggestion
# IDE0005: Remove unnecessary usings/imports
dotnet_diagnostic.IDE0005.severity = none
# Use explicit type instead of 'var'
dotnet_diagnostic.IDE0008.severity = suggestion
# Populate switch
dotnet_diagnostic.IDE0010.severity = suggestion
# Null check can be simplified
dotnet_diagnostic.IDE0016.severity = suggestion
# Object initialization can be simplified
dotnet_diagnostic.IDE0017.severity = suggestion
# Variable declaration can be inlined
dotnet_diagnostic.IDE0018.severity = suggestion
# Use pattern matching
dotnet_diagnostic.IDE0019.severity = suggestion
dotnet_diagnostic.IDE0020.severity = suggestion
# Use expression body for constructor
dotnet_diagnostic.IDE0021.severity = suggestion
# Use expression body for method
dotnet_diagnostic.IDE0022.severity = suggestion
# Use expression body for conversion operator
dotnet_diagnostic.IDE0023.severity = suggestion
# Use block body for operator
dotnet_diagnostic.IDE0024.severity = suggestion
# Use expression body for property
dotnet_diagnostic.IDE0025.severity = suggestion
# Use expression body for indexer
dotnet_diagnostic.IDE0026.severity = suggestion
# Use expression body for accessor
dotnet_diagnostic.IDE0027.severity = suggestion
# Collection initialization can be simplified
dotnet_diagnostic.IDE0028.severity = suggestion
# Null check can be simplified
dotnet_diagnostic.IDE0031.severity = suggestion
# Use auto property
dotnet_diagnostic.IDE0032.severity = suggestion
# 'default' expression can be simplified
dotnet_diagnostic.IDE0034.severity = suggestion
# Member name can be simplified
dotnet_diagnostic.IDE0037.severity = suggestion
# Use local function
dotnet_diagnostic.IDE0039.severity = suggestion
# Null check can be simplified
dotnet_diagnostic.IDE0041.severity = suggestion
# Variable declaration can be deconstructed
dotnet_diagnostic.IDE0042.severity = suggestion
# Made field readonly
dotnet_diagnostic.IDE0044.severity = suggestion
# 'if' statement can be simplified
dotnet_diagnostic.IDE0045.severity = suggestion
dotnet_diagnostic.IDE0046.severity = suggestion
# Parentheses can be removed
dotnet_diagnostic.IDE0047.severity = suggestion
# Parentheses should be added for clarity
dotnet_diagnostic.IDE0048.severity = suggestion
# Member name can be simplified
dotnet_diagnostic.IDE0049.severity = suggestion
# Use compound assignment
dotnet_diagnostic.IDE0054.severity = suggestion
# Fix formatting
dotnet_diagnostic.IDE0055.severity = suggestion
# Indexing can be simplified
dotnet_diagnostic.IDE0056.severity = suggestion
# Slice can be simplified
dotnet_diagnostic.IDE0057.severity = suggestion
# Expression value is never used
dotnet_diagnostic.IDE0058.severity = suggestion
# Unnecessary assignment of a value
dotnet_diagnostic.IDE0059.severity = suggestion
# Remove unused parameter
dotnet_diagnostic.IDE0060.severity = suggestion
# Use expression body for a local function
dotnet_diagnostic.IDE0061.severity = suggestion
# Local function can be made static
dotnet_diagnostic.IDE0062.severity = suggestion
# Using directives must be placed outside of a namespace declaration
dotnet_diagnostic.IDE0065.severity = suggestion
# Use 'switch' expression
dotnet_diagnostic.IDE0066.severity = suggestion
# 'GetHashCode' implementation can be simplified
dotnet_diagnostic.IDE0070.severity = suggestion
# Interpolation can be simplified
dotnet_diagnostic.IDE0071.severity = suggestion
# Populate switch
dotnet_diagnostic.IDE0072.severity = suggestion
# Use compound assignment
dotnet_diagnostic.IDE0074.severity = suggestion
# Conditional expression can be simplified
dotnet_diagnostic.IDE0075.severity = suggestion
# Use pattern matching
dotnet_diagnostic.IDE0078.severity = suggestion
dotnet_diagnostic.IDE0083.severity = suggestion
# 'typeof' can be converted to 'nameof'
dotnet_diagnostic.IDE0082.severity = suggestion
# 'new' expression can be simplified
dotnet_diagnostic.IDE0090.severity = suggestion
# Simplify LINQ expression
dotnet_diagnostic.IDE0120.severity = suggestion
# namespace does not match folder structure
dotnet_diagnostic.IDE0130.severity = suggestion
# Null check can be clarified
dotnet_diagnostic.IDE0150.severity = suggestion
# Convert to block scoped namespaces
dotnet_diagnostic.IDE0160.severity = suggestion
# Simplify property pattern
dotnet_diagnostic.IDE0170.severity = suggestion
# Use tuple to swap values
dotnet_diagnostic.IDE0180.severity = suggestion
# Use tuple to swap values
dotnet_diagnostic.IDE0180.severity = suggestion
# Lambda expression can be removed
dotnet_diagnostic.IDE0200.severity = suggestion
# Convert to top-level statements
dotnet_diagnostic.IDE0210.severity = suggestion
# 'foreach' statement implicitly converts
dotnet_diagnostic.IDE0220.severity = suggestion
# Use UTF-8 string literal
dotnet_diagnostic.IDE0230.severity = suggestion
# Nullable directives
dotnet_diagnostic.IDE0240.severity = suggestion
dotnet_diagnostic.IDE0241.severity = suggestion
# Struct can be made 'readonly'
dotnet_diagnostic.IDE0250.severity = suggestion
# Struct methods can be made 'readonly'
dotnet_diagnostic.IDE0251.severity = suggestion
# Null check can be simplified
dotnet_diagnostic.IDE0270.severity = suggestion
# naming rule violation
dotnet_diagnostic.IDE1006.severity = suggestion
# Use primary constructor
dotnet_diagnostic.IDE0290.severity = suggestion
# Collection initialization can be simplified
dotnet_diagnostic.IDE0300.severity = suggestion
dotnet_diagnostic.IDE0303.severity = suggestion
dotnet_diagnostic.IDE0301.severity = suggestion
dotnet_diagnostic.IDE0305.severity = suggestion
dotnet_diagnostic.IDE0306.severity = suggestion
# Temporarily disable SA1010 "Opening square brackets should not be preceded by a space" until https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3687 is fixed
dotnet_diagnostic.SA1010.severity = none
# Remove unnecessary equality operator IDE0100 (https://learn.microsoft.com/en-gb/dotnet/fundamentals/code-analysis/style-rules/ide0100)
# Making it a suggestion to have a flexibility for future
dotnet_diagnostic.IDE0100.severity = suggestion
# File header should match the template, making it error since couple of files met in the code base without any header
dotnet_diagnostic.IDE0073.severity = error
# Use 'System.Threading.Lock'
dotnet_diagnostic.IDE0330.severity = suggestion
# Value types are incompatible with null values. https://xunit.net/xunit.analyzers/rules/xUnit1012
dotnet_diagnostic.xUnit1012.severity = warning
# Use Assert.Fail() instead of Assert.True(false) or Assert.False(true)
dotnet_diagnostic.xUnit2020.severity = warning
# Use Assert.DoesNotContain instead of Assert.Empty on filtered collections
dotnet_diagnostic.xUnit2029.severity = warning
# Do not use blocking task operations in test method. https://xunit.net/xunit.analyzers/rules/xUnit1031
# The parallelization is disabled in https://github.com/dotnet/msbuild/blob/371d00f5c10a15b0858c411aafa11aac74596b06/src/Shared/UnitTests/xunit.runner.json#L6-L7
# Issue to consider enabling parallelization: https://github.com/dotnet/msbuild/issues/10640
dotnet_diagnostic.xUnit1031.severity = none
# Do not use equality check to check for collection size. https://xunit.net/xunit.analyzers/rules/xUnit2013
# To fix the warning for empty collection we can use Assert.Empty() instead of Assert.Equal(0, collection.Count)
# However to fix the warning for collections with 1 elements we should use Assert.Single() instead of Assert.Equal(1, collection.Count)
# The latter brings incosistency in the codebase and some times in one test case.
# So we are disabling this rule with respect to the above mentioned reasons.
dotnet_diagnostic.xUnit2013.severity = none