Skip to content

Commit f25628b

Browse files
committed
style: Add .editorconfig file to enforce code style
1 parent 25b1e52 commit f25628b

File tree

1 file changed

+280
-0
lines changed

1 file changed

+280
-0
lines changed

.editorconfig

Lines changed: 280 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,280 @@
1+
# Remove the line below if you want to inherit .editorconfig settings from higher directories
2+
root = true
3+
4+
# C# files
5+
[*.cs]
6+
7+
#### Core EditorConfig Options ####
8+
9+
# Indentation and spacing
10+
indent_size = 4
11+
indent_style = tab
12+
tab_width = 4
13+
14+
# New line preferences
15+
end_of_line = crlf
16+
insert_final_newline = false
17+
18+
#### .NET Coding Conventions ####
19+
20+
# Organize usings
21+
dotnet_separate_import_directive_groups = false
22+
dotnet_sort_system_directives_first = true
23+
file_header_template = unset
24+
25+
# this. and Me. preferences
26+
dotnet_style_qualification_for_event = false
27+
dotnet_style_qualification_for_field = false
28+
dotnet_style_qualification_for_method = false
29+
dotnet_style_qualification_for_property = false
30+
31+
# Language keywords vs BCL types preferences
32+
dotnet_style_predefined_type_for_locals_parameters_members = true
33+
dotnet_style_predefined_type_for_member_access = true
34+
35+
# Parentheses preferences
36+
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity
37+
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity
38+
dotnet_style_parentheses_in_other_operators = never_if_unnecessary
39+
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity
40+
41+
# Modifier preferences
42+
dotnet_style_require_accessibility_modifiers = for_non_interface_members
43+
44+
# Expression-level preferences
45+
dotnet_style_coalesce_expression = true
46+
dotnet_style_collection_initializer = true
47+
dotnet_style_explicit_tuple_names = true
48+
dotnet_style_namespace_match_folder = true
49+
dotnet_style_null_propagation = true
50+
dotnet_style_object_initializer = true
51+
dotnet_style_operator_placement_when_wrapping = beginning_of_line
52+
dotnet_style_prefer_auto_properties = true
53+
dotnet_style_prefer_compound_assignment = true
54+
dotnet_style_prefer_conditional_expression_over_assignment = true
55+
dotnet_style_prefer_conditional_expression_over_return = true
56+
dotnet_style_prefer_inferred_anonymous_type_member_names = true
57+
dotnet_style_prefer_inferred_tuple_names = true
58+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true
59+
dotnet_style_prefer_simplified_boolean_expressions = true
60+
dotnet_style_prefer_simplified_interpolation = true
61+
62+
# Field preferences
63+
dotnet_style_readonly_field = true
64+
65+
# Parameter preferences
66+
dotnet_code_quality_unused_parameters = all
67+
68+
# Suppression preferences
69+
dotnet_remove_unnecessary_suppression_exclusions = none
70+
71+
# New line preferences
72+
dotnet_style_allow_multiple_blank_lines_experimental = true
73+
dotnet_style_allow_statement_immediately_after_block_experimental = true
74+
75+
#### C# Coding Conventions ####
76+
77+
# var preferences
78+
csharp_style_var_elsewhere = false:silent
79+
csharp_style_var_for_built_in_types = false:silent
80+
csharp_style_var_when_type_is_apparent = false:silent
81+
82+
# Expression-bodied members
83+
csharp_style_expression_bodied_accessors = true:silent
84+
csharp_style_expression_bodied_constructors = false:silent
85+
csharp_style_expression_bodied_indexers = true:silent
86+
csharp_style_expression_bodied_lambdas = true:silent
87+
csharp_style_expression_bodied_local_functions = false:silent
88+
csharp_style_expression_bodied_methods = false:silent
89+
csharp_style_expression_bodied_operators = false:silent
90+
csharp_style_expression_bodied_properties = true:silent
91+
92+
# Pattern matching preferences
93+
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
94+
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
95+
csharp_style_prefer_extended_property_pattern = true:suggestion
96+
csharp_style_prefer_not_pattern = true:suggestion
97+
csharp_style_prefer_pattern_matching = true:silent
98+
csharp_style_prefer_switch_expression = true:suggestion
99+
100+
# Null-checking preferences
101+
csharp_style_conditional_delegate_call = true:suggestion
102+
csharp_style_prefer_parameter_null_checking = true:suggestion
103+
104+
# Modifier preferences
105+
csharp_prefer_static_local_function = true:suggestion
106+
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async
107+
108+
# Code-block preferences
109+
csharp_prefer_braces = true:silent
110+
csharp_prefer_simple_using_statement = true:suggestion
111+
csharp_style_namespace_declarations = block_scoped:silent
112+
csharp_style_prefer_method_group_conversion = true:silent
113+
114+
# Expression-level preferences
115+
csharp_prefer_simple_default_expression = true:suggestion
116+
csharp_style_deconstructed_variable_declaration = true:suggestion
117+
csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion
118+
csharp_style_inlined_variable_declaration = true:suggestion
119+
csharp_style_prefer_index_operator = true:suggestion
120+
csharp_style_prefer_local_over_anonymous_function = true:suggestion
121+
csharp_style_prefer_null_check_over_type_check = true:suggestion
122+
csharp_style_prefer_range_operator = true:suggestion
123+
csharp_style_prefer_tuple_swap = true:suggestion
124+
csharp_style_throw_expression = true:suggestion
125+
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
126+
csharp_style_unused_value_expression_statement_preference = discard_variable:silent
127+
128+
# 'using' directive preferences
129+
csharp_using_directive_placement = outside_namespace:silent
130+
131+
# New line preferences
132+
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true:silent
133+
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true:silent
134+
csharp_style_allow_embedded_statements_on_same_line_experimental = true:silent
135+
136+
#### C# Formatting Rules ####
137+
138+
# New line preferences
139+
csharp_new_line_before_catch = true
140+
csharp_new_line_before_else = true
141+
csharp_new_line_before_finally = true
142+
csharp_new_line_before_members_in_anonymous_types = true
143+
csharp_new_line_before_members_in_object_initializers = true
144+
csharp_new_line_before_open_brace = all
145+
csharp_new_line_between_query_expression_clauses = true
146+
147+
# Indentation preferences
148+
csharp_indent_block_contents = true
149+
csharp_indent_braces = false
150+
csharp_indent_case_contents = true
151+
csharp_indent_case_contents_when_block = true
152+
csharp_indent_labels = one_less_than_current
153+
csharp_indent_switch_labels = true
154+
155+
# Space preferences
156+
csharp_space_after_cast = false
157+
csharp_space_after_colon_in_inheritance_clause = true
158+
csharp_space_after_comma = true
159+
csharp_space_after_dot = false
160+
csharp_space_after_keywords_in_control_flow_statements = true
161+
csharp_space_after_semicolon_in_for_statement = true
162+
csharp_space_around_binary_operators = before_and_after
163+
csharp_space_around_declaration_statements = false
164+
csharp_space_before_colon_in_inheritance_clause = true
165+
csharp_space_before_comma = false
166+
csharp_space_before_dot = false
167+
csharp_space_before_open_square_brackets = false
168+
csharp_space_before_semicolon_in_for_statement = false
169+
csharp_space_between_empty_square_brackets = false
170+
csharp_space_between_method_call_empty_parameter_list_parentheses = false
171+
csharp_space_between_method_call_name_and_opening_parenthesis = false
172+
csharp_space_between_method_call_parameter_list_parentheses = false
173+
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
174+
csharp_space_between_method_declaration_name_and_open_parenthesis = false
175+
csharp_space_between_method_declaration_parameter_list_parentheses = false
176+
csharp_space_between_parentheses = false
177+
csharp_space_between_square_brackets = false
178+
179+
# Wrapping preferences
180+
csharp_preserve_single_line_blocks = true
181+
csharp_preserve_single_line_statements = true
182+
183+
#### Naming styles ####
184+
185+
# Naming rules
186+
187+
dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
188+
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
189+
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
190+
191+
dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
192+
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
193+
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
194+
195+
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
196+
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
197+
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
198+
199+
# Symbol specifications
200+
201+
dotnet_naming_symbols.interface.applicable_kinds = interface
202+
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
203+
dotnet_naming_symbols.interface.required_modifiers =
204+
205+
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
206+
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
207+
dotnet_naming_symbols.types.required_modifiers =
208+
209+
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
210+
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
211+
dotnet_naming_symbols.non_field_members.required_modifiers =
212+
213+
# Naming styles
214+
215+
dotnet_naming_style.pascal_case.required_prefix =
216+
dotnet_naming_style.pascal_case.required_suffix =
217+
dotnet_naming_style.pascal_case.word_separator =
218+
dotnet_naming_style.pascal_case.capitalization = pascal_case
219+
220+
dotnet_naming_style.begins_with_i.required_prefix = I
221+
dotnet_naming_style.begins_with_i.required_suffix =
222+
dotnet_naming_style.begins_with_i.word_separator =
223+
dotnet_naming_style.begins_with_i.capitalization = pascal_case
224+
225+
[*.{cs,vb}]
226+
dotnet_style_operator_placement_when_wrapping = beginning_of_line
227+
tab_width = 4
228+
indent_size = 4
229+
end_of_line = crlf
230+
dotnet_style_coalesce_expression = true:suggestion
231+
dotnet_style_null_propagation = true:suggestion
232+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
233+
dotnet_style_prefer_auto_properties = true:silent
234+
dotnet_style_object_initializer = true:suggestion
235+
dotnet_style_collection_initializer = true:suggestion
236+
dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
237+
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
238+
dotnet_style_prefer_conditional_expression_over_return = true:silent
239+
dotnet_style_explicit_tuple_names = true:suggestion
240+
dotnet_style_prefer_inferred_tuple_names = true:suggestion
241+
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
242+
dotnet_style_prefer_compound_assignment = true:suggestion
243+
dotnet_style_namespace_match_folder = true:suggestion
244+
dotnet_style_prefer_simplified_interpolation = true:suggestion
245+
dotnet_style_readonly_field = true:suggestion
246+
dotnet_style_predefined_type_for_locals_parameters_members = true:silent
247+
dotnet_style_predefined_type_for_member_access = true:silent
248+
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
249+
dotnet_style_allow_multiple_blank_lines_experimental = true:silent
250+
dotnet_style_allow_statement_immediately_after_block_experimental = true:silent
251+
dotnet_code_quality_unused_parameters = all:suggestion
252+
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
253+
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
254+
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
255+
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
256+
dotnet_style_qualification_for_field = false:silent
257+
dotnet_style_qualification_for_property = false:silent
258+
dotnet_style_qualification_for_method = false:silent
259+
dotnet_style_qualification_for_event = false:silent
260+
261+
[*.xaml]
262+
indent_style = tab
263+
indent_size = 4
264+
trim_trailing_whitespace = true
265+
266+
[*.csproj]
267+
indent_style = tab
268+
tab_width = 2
269+
indent_size = 2
270+
271+
[{*.yml, *.yaml}]
272+
indent_style = space
273+
274+
[*.md]
275+
indent_style = space
276+
277+
[**.{cpp,h,idl}]
278+
indent_style = tab
279+
indent_size = 4
280+
trim_trailing_whitespace = true

0 commit comments

Comments
 (0)