From 0cb8b9f4b800ad1f3234a50403d25bd91ab3a602 Mon Sep 17 00:00:00 2001 From: Oli Sturm Date: Thu, 28 May 2026 15:52:42 +0100 Subject: [PATCH] chore: add editorconfig --- .editorconfig | 270 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 270 insertions(+) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..cf7b65b --- /dev/null +++ b/.editorconfig @@ -0,0 +1,270 @@ +# Remove the line below if you want to inherit .editorconfig settings from higher directories +root = true + +# C# files +[*.cs] + +#### Core EditorConfig Options #### + +# Indentation and spacing +indent_size = 2 +indent_style = space +tab_width = 4 + +# New line preferences +end_of_line = crlf +insert_final_newline = false + +#### .NET Coding Conventions #### + +# Organize usings +dotnet_separate_import_directive_groups = false +dotnet_sort_system_directives_first = false + +# this. and Me. preferences +dotnet_style_qualification_for_event = false:silent +dotnet_style_qualification_for_field = false:silent +dotnet_style_qualification_for_method = false:silent +dotnet_style_qualification_for_property = false:silent + +# Language keywords vs BCL types preferences +dotnet_style_predefined_type_for_locals_parameters_members = true:silent +dotnet_style_predefined_type_for_member_access = true:silent + +# Parentheses preferences +dotnet_style_parentheses_in_arithmetic_binary_operators = never_if_unnecessary:silent +dotnet_style_parentheses_in_other_binary_operators = never_if_unnecessary:silent +dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent +dotnet_style_parentheses_in_relational_binary_operators = never_if_unnecessary:silent + +# Modifier preferences +dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent + +# Expression-level preferences +dotnet_style_coalesce_expression = true:silent +dotnet_style_collection_initializer = true:silent +dotnet_style_explicit_tuple_names = true:silent +dotnet_style_null_propagation = true:silent +dotnet_style_object_initializer = true:silent +dotnet_style_prefer_auto_properties = true:silent +dotnet_style_prefer_compound_assignment = true:silent +dotnet_style_prefer_conditional_expression_over_assignment = true:silent +dotnet_style_prefer_conditional_expression_over_return = true:silent +dotnet_style_prefer_inferred_anonymous_type_member_names = true:silent +dotnet_style_prefer_inferred_tuple_names = true:silent +dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent + +# Field preferences +dotnet_style_readonly_field = true:silent + +# Parameter preferences +dotnet_code_quality_unused_parameters = all:silent + +#### C# Coding Conventions #### + +# var preferences +csharp_style_var_elsewhere = false:silent +csharp_style_var_for_built_in_types = false:silent +csharp_style_var_when_type_is_apparent = false:silent + +# Expression-bodied members +csharp_style_expression_bodied_accessors = true:silent +csharp_style_expression_bodied_constructors = false:silent +csharp_style_expression_bodied_indexers = true:silent +csharp_style_expression_bodied_lambdas = true:silent +csharp_style_expression_bodied_local_functions = true:silent +csharp_style_expression_bodied_methods = false:silent +csharp_style_expression_bodied_operators = false:silent +csharp_style_expression_bodied_properties = true:silent + +# Pattern matching preferences +csharp_style_pattern_matching_over_as_with_null_check = true:silent +csharp_style_pattern_matching_over_is_with_cast_check = true:silent +csharp_style_prefer_switch_expression = true:silent + +# Null-checking preferences +csharp_style_conditional_delegate_call = true:silent + +# Modifier preferences +csharp_prefer_static_local_function = true:silent +csharp_preferred_modifier_order = public, private, protected, internal, static, extern, new, virtual, abstract, sealed, override, readonly, unsafe, volatile, async + +# Code-block preferences +csharp_prefer_braces = true:silent +csharp_prefer_simple_using_statement = false:silent + +# Expression-level preferences +csharp_prefer_simple_default_expression = true:silent +csharp_style_deconstructed_variable_declaration = true:silent +csharp_style_inlined_variable_declaration = true:silent +csharp_style_pattern_local_over_anonymous_function = true:silent +csharp_style_prefer_index_operator = true:silent +csharp_style_prefer_range_operator = true:silent +csharp_style_throw_expression = true:silent +csharp_style_unused_value_assignment_preference = discard_variable:silent +csharp_style_unused_value_expression_statement_preference = discard_variable:silent + +# 'using' directive preferences +csharp_using_directive_placement = outside_namespace: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 = false +# Oli - need the following for proper formatting of +# switch expressions with property patterns. +# See https://github.com/dotnet/docs/issues/24018 +csharp_new_line_before_open_brace = none +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 = silent +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 = silent +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 = silent +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 + +# Following lots of settings for JetBrains, who have apparently messed up their support +# for standard .editorconfig in such a way that standard rules are no longer observed. + +#### Braces (Rider/ReSharper dialect — overrides Roslyn key) #### +# K&R everywhere... +csharp_type_declaration_braces = end_of_line +csharp_invocable_declaration_braces = end_of_line +csharp_anonymous_method_declaration_braces = end_of_line +csharp_accessor_owner_declaration_braces = end_of_line +csharp_accessor_declaration_braces = end_of_line +csharp_case_block_braces = end_of_line +csharp_empty_block_style = together_same_line +# ...except initializers / switch expressions / property patterns +csharp_initializer_braces = end_of_line + +#### Blank lines (Rider/ReSharper dialect) #### +# Preserve-existing controls — limit consecutive blanks the formatter keeps +csharp_keep_blank_lines_in_declarations = 1 +csharp_keep_blank_lines_in_code = 1 +csharp_remove_blank_lines_near_braces_in_declarations = true +csharp_remove_blank_lines_near_braces_in_code = true + +# Force-inserted blanks around members +csharp_blank_lines_around_namespace = 1 +csharp_blank_lines_around_type = 1 +csharp_blank_lines_around_invocable = 1 +csharp_blank_lines_around_property = 1 +csharp_blank_lines_around_auto_property = 1 +csharp_blank_lines_around_field = 0 +csharp_blank_lines_around_single_line_invocable = 1 +csharp_blank_lines_around_single_line_property = 0 +csharp_blank_lines_around_single_line_auto_property = 0 +csharp_blank_lines_around_single_line_field = 0 +csharp_blank_lines_after_using_list = 1 +csharp_blank_lines_after_file_scoped_namespace_directive = 1 +csharp_blank_lines_around_region = 1 +csharp_blank_lines_inside_region = 1 + +# These are the usual culprits for "blank lines appearing where I didn't put them" +csharp_blank_lines_before_control_transfer_statements = 0 +csharp_blank_lines_after_control_transfer_statements = 0 +csharp_blank_lines_before_block_statements = 0 +csharp_blank_lines_after_block_statements = 0 +csharp_blank_lines_before_multiline_statements = 0 +csharp_blank_lines_after_multiline_statements = 0 +csharp_blank_lines_around_block_case_section = 0 +csharp_blank_lines_before_single_line_comment = 0 + +csharp_blank_lines_around_single_line_type = 0 +csharp_blank_lines_around_single_line_invocable = 0 +csharp_blank_lines_around_single_line_accessor = 0 +csharp_blank_lines_around_single_line_local_method = 0 + +csharp_blank_lines_around_type = 1 +csharp_blank_lines_around_invocable = 0 +csharp_blank_lines_around_property = 0 +csharp_blank_lines_around_auto_property = 0 +csharp_blank_lines_around_field = 0 + +csharp_wrap_chained_method_calls = chop_if_long +max_line_length = 90 +csharp_wrap_object_and_collection_initializer_style = chop_if_long +csharp_wrap_array_initializer_style = chop_if_long +csharp_wrap_collection_expression_style = chop_if_long +csharp_keep_existing_initializer_arrangement = false +csharp_place_simple_initializer_on_single_line = true +csharp_max_initializer_elements_on_line = 100 +csharp_wrap_collection_expression_style = chop_if_long +csharp_max_collection_expression_elements_on_line = 100 \ No newline at end of file