-
Notifications
You must be signed in to change notification settings - Fork 5
/
.editorconfig
319 lines (261 loc) · 17.1 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
# Version 20240405 - C# 12
# Origin: see https://github.com/Applicita/Modern.CSharp.Templates/blob/main/Editorconfig.md
# This file does not inherit .editorconfig settings from higher directories - where possible, place it at the root of the repository
# It is recommended to include below settings in all .csproj files that are in or below the folder that contains this .editorconfig file:
# <PropertyGroup>
# <Nullable>enable</Nullable>
# <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
# <AnalysisLevel>preview-All</AnalysisLevel>
# <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
# </PropertyGroup>
# Note that for .NET 8 the above AnalysisLevel setting is necessary for command-line builds to respect the severity settings in this .editorconfig. In .NET 9+ these are always respected.
# References:
# - To learn more about .editorconfig see https://aka.ms/editorconfigdocs
# - Set rule severity https://docs.microsoft.com/en-us/visualstudio/code-quality/use-roslyn-analyzers?view=vs-2019#set-rule-severity-in-an-editorconfig-file
# - Configure analyzer rules https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md
# Note that choices to deviate from the default are governed by these goals:
# 1) Remove noise
# 2) Increase conciseness
# Comments "# Default: <default value>" indicate where values are changed from the default
root = true
# All files
[*]
charset = utf-8-bom # Default: not specified
indent_style = space
end_of_line = lf # Default: crlf. Line endings are different from Visual Studio for Windows .editorconfig template defaults; see comments in EOL.gitattributes for rationale
# Note that on save VS 2022 17.9.5 adds some keys in this section that are also specified in the [*.cs] section (with the same values) - see https://github.com/dotnet/roslyn/issues/59325
# These duplicate key-values dont hurt but they can be removed from this section
# C# project files
[*.csproj]
# Indentation and spacing
indent_size = 2
tab_width = 2
# C# files
[*.cs]
#### Core EditorConfig Options ####
# Indentation and spacing
indent_size = 4
tab_width = 4
# New line preferences
insert_final_newline = true # Default: false
#### .NET Coding Conventions ####
# Organize usings
dotnet_separate_import_directive_groups = false
dotnet_sort_system_directives_first = true # Default: false
file_header_template = unset
# this. and Me. preferences
dotnet_style_qualification_for_event = false:warning # Default: false
dotnet_style_qualification_for_field = false:warning # Default: false
dotnet_style_qualification_for_method = false:warning # Default: false
dotnet_style_qualification_for_property = false:warning # Default: false
# Language keywords vs BCL types preferences
dotnet_style_predefined_type_for_locals_parameters_members = true:warning # Default: true
dotnet_style_predefined_type_for_member_access = true:warning # Default: true
# Parentheses preferences
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
# Modifier preferences
dotnet_style_require_accessibility_modifiers = omit_if_default:warning # Default: for_non_interface_members
# Expression-level preferences
dotnet_style_coalesce_expression = true:warning # Default: true:suggestion
dotnet_style_collection_initializer = true:warning # Default: true:suggestion
dotnet_style_explicit_tuple_names = true:warning # Default: true:suggestion
dotnet_style_namespace_match_folder = false:silent # Default: true - can be deviated from to prevent overstructuring
dotnet_style_null_propagation = true:warning # Default: true:suggestion
dotnet_style_object_initializer = true:warning # Default: true:suggestion
dotnet_style_operator_placement_when_wrapping = beginning_of_line
dotnet_style_prefer_auto_properties = true:warning # Default: true
dotnet_style_prefer_collection_expression = when_types_loosely_match:warning # Default: when_types_loosely_match:suggestion
dotnet_style_prefer_compound_assignment = true:warning # Default: true
dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion # Default: true
dotnet_style_prefer_conditional_expression_over_return = true:suggestion # Default: true
dotnet_style_prefer_foreach_explicit_cast_in_source = when_strongly_typed
dotnet_style_prefer_inferred_anonymous_type_member_names = true:warning # Default: true
dotnet_style_prefer_inferred_tuple_names = true:warning # Default: true
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning # Default: true
dotnet_style_prefer_simplified_boolean_expressions = true:warning # Default: true
dotnet_style_prefer_simplified_interpolation = true:warning # Default: true
# Field preferences
dotnet_style_readonly_field = true:warning # Default: true
# Parameter preferences
dotnet_code_quality_unused_parameters = all:warning # Default: all
# Suppression preferences
dotnet_remove_unnecessary_suppression_exclusions = none
# New line preferences
dotnet_style_allow_multiple_blank_lines_experimental = true:silent
dotnet_style_allow_statement_immediately_after_block_experimental = true:silent
#### C# Coding Conventions ####
# var preferences
csharp_style_var_elsewhere = true:warning # Default: false:silent
csharp_style_var_for_built_in_types = false:warning # Default: false:silent
csharp_style_var_when_type_is_apparent = true:warning # Default: false:silent
# Expression-bodied members
csharp_style_expression_bodied_accessors = true:warning # Default: true:silent
csharp_style_expression_bodied_constructors = true:warning # Default: false:silent
csharp_style_expression_bodied_indexers = true:warning # Default: true:silent
csharp_style_expression_bodied_lambdas = true:warning # Default: true:silent
csharp_style_expression_bodied_local_functions = true:warning # Default: false:silent
csharp_style_expression_bodied_methods = true:warning # Default: false:silent
csharp_style_expression_bodied_operators = true:warning # Default: false:silent
csharp_style_expression_bodied_properties = true:warning # Default: true:silent
# Pattern matching preferences
csharp_style_pattern_matching_over_as_with_null_check = true:warning # Default: true:suggestion
csharp_style_pattern_matching_over_is_with_cast_check = true:warning # Default: true:suggestion
csharp_style_prefer_extended_property_pattern = true:warning # Default: true
csharp_style_prefer_not_pattern = true:warning # Default: true:suggestion
csharp_style_prefer_pattern_matching = true:warning # Default: true:silent
csharp_style_prefer_switch_expression = true:warning # Default: true:suggestion
# Null-checking preferences
csharp_style_conditional_delegate_call = true:warning # Default: true:suggestion
# Modifier preferences
csharp_prefer_static_local_function = true:warning # Default: true:suggestion
csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async
csharp_style_prefer_readonly_struct = true:warning # Default: true:suggestion
csharp_style_prefer_readonly_struct_member = true:warning # Default: true:suggestion
# Code-block preferences
csharp_prefer_braces = when_multiline:warning # Default: true:silent
csharp_prefer_simple_using_statement = true:warning # Default: true:suggestion
csharp_style_namespace_declarations = file_scoped:warning # Default: block_scoped:silent
csharp_style_prefer_method_group_conversion = true:warning # Default: true:silent
csharp_style_prefer_primary_constructors = true:warning # Default: true:suggestion
csharp_style_prefer_top_level_statements = true:silent
# Expression-level preferences
csharp_prefer_simple_default_expression = true:warning # Default: true:suggestion
csharp_style_deconstructed_variable_declaration = true:warning # Default: true:suggestion
csharp_style_implicit_object_creation_when_type_is_apparent = true:warning # Default: true:suggestion
csharp_style_inlined_variable_declaration = true:warning # Default: true:suggestion
csharp_style_prefer_index_operator = true:warning # Default: true:suggestion
csharp_style_prefer_local_over_anonymous_function = true:warning # Default: true:suggestion
csharp_style_prefer_null_check_over_type_check = true:warning # Default: true:suggestion
csharp_style_prefer_range_operator = true:warning # Default: true:suggestion
csharp_style_prefer_tuple_swap = true:warning # Default: true:suggestion
csharp_style_prefer_utf8_string_literals = true:suggestion
csharp_style_throw_expression = true:warning # Default: true:suggestion
csharp_style_unused_value_assignment_preference = discard_variable:warning # Default: discard_variable:suggestion
csharp_style_unused_value_expression_statement_preference = discard_variable:warning # Default: discard_variable:silent
# 'using' directive preferences
csharp_using_directive_placement = outside_namespace:warning # Default: outside_namespace:silent
# Placing usings outside namespaces lets the closest parent namespace control type name match
# It can also make attribute usage more concise
# See https://stackoverflow.com/questions/125319/should-using-directives-be-inside-or-outside-the-namespace
# New line preferences
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true:silent
csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true:silent
csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true:silent
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true:silent
csharp_style_allow_embedded_statements_on_same_line_experimental = true:silent
#### C# Formatting Rules ####
# New line preferences
csharp_new_line_before_catch = true
csharp_new_line_before_else = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_open_brace = all
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_labels = one_less_than_current
csharp_indent_switch_labels = true
# 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 = false
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
# Wrapping preferences
csharp_preserve_single_line_blocks = true
csharp_preserve_single_line_statements = true
#### Naming styles ####
# Naming rules
dotnet_naming_rule.interface_should_be_begins_with_i.severity = warning
# Default: suggestion
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
dotnet_naming_rule.types_should_be_pascal_case.severity = warning
# Default: suggestion
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = warning
# Default: suggestion
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
# Symbol specifications
dotnet_naming_symbols.interface.applicable_kinds = interface
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.interface.required_modifiers =
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.types.required_modifiers =
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.non_field_members.required_modifiers =
# Naming styles
dotnet_naming_style.pascal_case.required_prefix =
dotnet_naming_style.pascal_case.required_suffix =
dotnet_naming_style.pascal_case.word_separator =
dotnet_naming_style.pascal_case.capitalization = pascal_case
dotnet_naming_style.begins_with_i.required_prefix = I
dotnet_naming_style.begins_with_i.required_suffix =
dotnet_naming_style.begins_with_i.word_separator =
dotnet_naming_style.begins_with_i.capitalization = pascal_case
# Use PascalCase for constant fields (as per https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/identifier-names)
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = warning
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case
dotnet_naming_symbols.constant_fields.applicable_kinds = field
dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
dotnet_naming_symbols.constant_fields.required_modifiers = const
# Start of NO underscore prefix on private fields
# Define the 'private_fields' symbol group:
dotnet_naming_symbols.private_fields.applicable_kinds = field
dotnet_naming_symbols.private_fields.applicable_accessibilities = private
# Define the 'notunderscored' naming style
dotnet_naming_style.notunderscored.capitalization = camel_case
dotnet_naming_style.notunderscored.required_prefix =
# Define the 'private_fields_notunderscored' naming rule
dotnet_naming_rule.private_fields_notunderscored.symbols = private_fields
dotnet_naming_rule.private_fields_notunderscored.style = notunderscored
dotnet_naming_rule.private_fields_notunderscored.severity = error
# End of No underscore prefix on private fields
# Severity changes from Default
dotnet_analyzer_diagnostic.severity = error
dotnet_diagnostic.CA1034.severity = suggestion
# changed from warning because using namespaces as alternative to nested types for logical grouping or for avoiding name collisions,
# as the rule states, either adds noise (repeated local namespace usings) or does not prevent collisions (global namespace usings)
# see https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/CA1034
dotnet_diagnostic.CA1708.severity = none # CA1708 is not relevant because we do not design binary API's for other languages than C#. See https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1708
dotnet_diagnostic.CA1716.severity = none # CA1716 is not relevant because we do not design binary API's for other languages than C#. See https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1716
dotnet_diagnostic.CA1812.severity = suggestion # changed from warning because too many false positives where external libraries create instances (e.g. DI)
dotnet_diagnostic.CA1848.severity = suggestion # Not every logging statement needs to be optimized for performance
dotnet_diagnostic.CA2225.severity = none # is not relevant because we do not design binary API's for other languages than C#. See https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2225
dotnet_diagnostic.IDE0055.severity = silent # Nonstandard whitespace formatting can be used to improve readability
dotnet_diagnostic.IDE0072.severity = suggestion
# Populate switch: switch options should be exhaustive for all expected functionality including expected errors,
# while truly unexpected returns should throw an exception. Since switch automatically throws a SwitchExpressionException,
# it is valid to not explicitly code cases that throw an exception to indicate the return is truly unexpected.
dotnet_diagnostic.IDE0130.severity = suggestion # IDE0130 "Namespace does not match folder structure" can be deviated from to prevent overstructuring
# Solution-specific settings
dotnet_diagnostic.ORLEANS0010.severity = none # adding an alias to every grain contract type and member adds too much noise. This rule should be triggered only during refactoring