337 lines
16 KiB
INI
337 lines
16 KiB
INI
|
|
root = true
|
||
|
|
|
||
|
|
#### Core EditorConfig Options ####
|
||
|
|
|
||
|
|
[*]
|
||
|
|
# Indentation and spacing
|
||
|
|
indent_size = 4
|
||
|
|
indent_style = space
|
||
|
|
tab_width = 4
|
||
|
|
|
||
|
|
# New line preferences
|
||
|
|
end_of_line = lf
|
||
|
|
insert_final_newline = true
|
||
|
|
dotnet_style_operator_placement_when_wrapping = end_of_line
|
||
|
|
dotnet_style_coalesce_expression = true:suggestion
|
||
|
|
dotnet_style_explicit_tuple_names = true:suggestion
|
||
|
|
dotnet_style_prefer_simplified_interpolation = true:suggestion
|
||
|
|
dotnet_style_prefer_collection_expression = when_types_loosely_match:suggestion
|
||
|
|
dotnet_style_namespace_match_folder = true:suggestion
|
||
|
|
dotnet_style_allow_multiple_blank_lines_experimental = true:silent
|
||
|
|
dotnet_style_allow_statement_immediately_after_block_experimental = true:silent
|
||
|
|
dotnet_style_null_propagation = true:warning
|
||
|
|
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning
|
||
|
|
dotnet_style_prefer_auto_properties = true:suggestion
|
||
|
|
dotnet_style_object_initializer = true:suggestion
|
||
|
|
|
||
|
|
# Development files
|
||
|
|
[*.{cs,csx,cshtml,csproj,razor,sln,props,targets,json,md,yml,gitignore,}]
|
||
|
|
charset = utf-8
|
||
|
|
|
||
|
|
#### .NET Coding Conventions ####
|
||
|
|
[*.cs]
|
||
|
|
|
||
|
|
# 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:warning
|
||
|
|
dotnet_style_predefined_type_for_member_access = true:warning
|
||
|
|
|
||
|
|
# Parentheses preferences
|
||
|
|
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:suggestion
|
||
|
|
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:suggestion
|
||
|
|
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
|
||
|
|
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:suggestion
|
||
|
|
|
||
|
|
# Modifier preferences
|
||
|
|
dotnet_style_require_accessibility_modifiers = for_non_interface_members:warning
|
||
|
|
|
||
|
|
# Expression-level preferences
|
||
|
|
csharp_style_deconstructed_variable_declaration = true:suggestion
|
||
|
|
csharp_style_inlined_variable_declaration = true:suggestion
|
||
|
|
csharp_style_throw_expression = true:suggestion
|
||
|
|
dotnet_style_collection_initializer = true:suggestion
|
||
|
|
dotnet_style_explicit_tuple_names = true:suggestion
|
||
|
|
dotnet_style_null_propagation = true:warning
|
||
|
|
dotnet_style_object_initializer = true:suggestion
|
||
|
|
dotnet_style_prefer_auto_properties = true:suggestion
|
||
|
|
dotnet_style_prefer_compound_assignment = true:suggestion
|
||
|
|
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:suggestion
|
||
|
|
dotnet_style_prefer_inferred_tuple_names = true:suggestion
|
||
|
|
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning
|
||
|
|
dotnet_style_prefer_simplified_boolean_expressions = true:refactoring
|
||
|
|
|
||
|
|
# Field preferences
|
||
|
|
dotnet_style_readonly_field = true:error
|
||
|
|
|
||
|
|
# Parameter preferences
|
||
|
|
dotnet_code_quality_unused_parameters = all:suggestion
|
||
|
|
|
||
|
|
# Strings
|
||
|
|
csharp_style_prefer_string_interpolation = true:suggestion
|
||
|
|
|
||
|
|
#### C# Coding Conventions ####
|
||
|
|
|
||
|
|
# var preferences
|
||
|
|
csharp_style_var_elsewhere = false:error # var should only be used with anonymous types, and target-typed new expression is encouraged
|
||
|
|
csharp_style_var_for_built_in_types = false:error
|
||
|
|
csharp_style_var_when_type_is_apparent = false:error
|
||
|
|
|
||
|
|
# Expression-bodied members
|
||
|
|
csharp_style_expression_bodied_accessors = false:error
|
||
|
|
csharp_style_expression_bodied_constructors = false:error
|
||
|
|
csharp_style_expression_bodied_indexers = false:error
|
||
|
|
csharp_style_expression_bodied_lambdas = true:suggestion # lamdas don't always require block bodies and explicit return
|
||
|
|
csharp_style_expression_bodied_local_functions = false:error
|
||
|
|
csharp_style_expression_bodied_methods = false:error
|
||
|
|
csharp_style_expression_bodied_operators = false:error
|
||
|
|
csharp_style_expression_bodied_properties = when_on_single_line:suggestion # domain error properties are allowed to have this style
|
||
|
|
|
||
|
|
# Pattern Matching
|
||
|
|
csharp_style_pattern_matching_over_as_with_null_check = true:warning
|
||
|
|
csharp_style_pattern_matching_over_is_with_cast_check = true:warning
|
||
|
|
|
||
|
|
|
||
|
|
# "Null" checking preferences
|
||
|
|
csharp_style_conditional_delegate_call = true:warning
|
||
|
|
|
||
|
|
# Modifier preferences
|
||
|
|
csharp_prefer_static_local_function = true:suggestion
|
||
|
|
csharp_preferred_modifier_order = public, private, protected, internal, static, extern, new, virtual, abstract, sealed, override, readonly, unsafe, volatile, async:error
|
||
|
|
|
||
|
|
# Code-block preferences
|
||
|
|
csharp_prefer_braces = false:error # vertical scope space is vital for code readability, single conditional and iterative expressions waste it up
|
||
|
|
csharp_prefer_simple_using_statement = false:error # explicit using blocks provide clearer scope control and consistent disposal timing in local scope
|
||
|
|
|
||
|
|
# Expression-level preferences
|
||
|
|
csharp_prefer_simple_default_expression = true:suggestion
|
||
|
|
csharp_style_pattern_local_over_anonymous_function = true:suggestion
|
||
|
|
csharp_style_prefer_index_operator = true:suggestion
|
||
|
|
csharp_style_prefer_range_operator = true:suggestion
|
||
|
|
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
|
||
|
|
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 = 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 = false
|
||
|
|
|
||
|
|
#### Naming styles ####
|
||
|
|
|
||
|
|
# Naming rules
|
||
|
|
|
||
|
|
# Interfaces should begin with an I and be PascalCase
|
||
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.severity = error
|
||
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
|
||
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.style = interface_style
|
||
|
|
|
||
|
|
dotnet_naming_symbols.interface.applicable_kinds = interface
|
||
|
|
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal
|
||
|
|
dotnet_naming_symbols.interface.required_modifiers =
|
||
|
|
|
||
|
|
dotnet_naming_style.interface_style.required_prefix = I
|
||
|
|
dotnet_naming_style.interface_style.required_suffix =
|
||
|
|
dotnet_naming_style.interface_style.word_separator =
|
||
|
|
dotnet_naming_style.interface_style.capitalization = pascal_case
|
||
|
|
|
||
|
|
# Types should be PascalCase
|
||
|
|
dotnet_naming_rule.types_should_be_pascal_case.severity = error
|
||
|
|
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
|
||
|
|
dotnet_naming_rule.types_should_be_pascal_case.style = non_private_static_field_style
|
||
|
|
|
||
|
|
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
|
||
|
|
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal
|
||
|
|
dotnet_naming_symbols.types.required_modifiers =
|
||
|
|
|
||
|
|
dotnet_naming_style.types_style.capitalization = pascal_case
|
||
|
|
|
||
|
|
# Non Field members should be PascalCase
|
||
|
|
dotnet_naming_rule.non_field_members_should_be_camel_case.severity = error
|
||
|
|
dotnet_naming_rule.non_field_members_should_be_camel_case.symbols = non_field_members
|
||
|
|
dotnet_naming_rule.non_field_members_should_be_camel_case.style = non_private_static_field_style
|
||
|
|
|
||
|
|
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
|
||
|
|
dotnet_naming_symbols.non_field_members.required_modifiers =
|
||
|
|
|
||
|
|
dotnet_naming_style.non_field_members_style.capitalization = pascal_case
|
||
|
|
|
||
|
|
# Non-private static fields are camel_case
|
||
|
|
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = error
|
||
|
|
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields
|
||
|
|
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style
|
||
|
|
|
||
|
|
dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field
|
||
|
|
dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected internal, private protected
|
||
|
|
dotnet_naming_symbols.non_private_static_fields.required_modifiers = static
|
||
|
|
|
||
|
|
dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case
|
||
|
|
|
||
|
|
# Constants are UPPER_CASE
|
||
|
|
dotnet_naming_rule.constants_should_be_pascal_case.severity = error
|
||
|
|
dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants
|
||
|
|
dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style
|
||
|
|
|
||
|
|
dotnet_naming_symbols.constants.applicable_kinds = field, local
|
||
|
|
dotnet_naming_symbols.constants.required_modifiers = const
|
||
|
|
|
||
|
|
dotnet_naming_style.constant_style.capitalization = all_upper
|
||
|
|
dotnet_naming_style.constant_style.word_separator = _
|
||
|
|
|
||
|
|
# Static fields are PascalCase and start with s_
|
||
|
|
dotnet_naming_rule.static_fields_should_be_pascal_case.severity = error
|
||
|
|
dotnet_naming_rule.static_fields_should_be_pascal_case.symbols = static_fields
|
||
|
|
dotnet_naming_rule.static_fields_should_be_pascal_case.style = static_field_style
|
||
|
|
|
||
|
|
dotnet_naming_symbols.static_fields.applicable_kinds = field
|
||
|
|
dotnet_naming_symbols.static_fields.required_modifiers = static
|
||
|
|
|
||
|
|
dotnet_naming_style.static_field_style.capitalization = pascal_case
|
||
|
|
dotnet_naming_style.static_field_style.required_prefix = s_ # static members should immediately distinguish themselves from other members
|
||
|
|
|
||
|
|
# Local variables should be camelCase
|
||
|
|
dotnet_naming_rule.camel_case_for_local_variables.severity = error
|
||
|
|
dotnet_naming_rule.camel_case_for_local_variables.symbols = local_variables
|
||
|
|
dotnet_naming_rule.camel_case_for_local_variables.style = parameter_style
|
||
|
|
|
||
|
|
dotnet_naming_symbols.local_variables.applicable_kinds = local
|
||
|
|
|
||
|
|
dotnet_naming_style.local_variables_style.capitalization = camel_case
|
||
|
|
|
||
|
|
# Parameters should be camelCase
|
||
|
|
dotnet_naming_rule.parameters_should_be_prefixed.severity = error
|
||
|
|
dotnet_naming_rule.parameters_should_be_prefixed.symbols = parameters
|
||
|
|
dotnet_naming_rule.parameters_should_be_prefixed.style = parameter_style
|
||
|
|
|
||
|
|
dotnet_naming_symbols.parameters.applicable_kinds = parameter
|
||
|
|
|
||
|
|
dotnet_naming_style.parameter_style.capitalization = camel_case
|
||
|
|
|
||
|
|
# Local functions are PascalCase
|
||
|
|
dotnet_naming_rule.local_functions_should_be_pascal_case.severity = error
|
||
|
|
dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions
|
||
|
|
dotnet_naming_rule.local_functions_should_be_pascal_case.style = non_private_static_field_style
|
||
|
|
|
||
|
|
dotnet_naming_symbols.local_functions.applicable_kinds = local_function
|
||
|
|
|
||
|
|
dotnet_naming_style.local_function_style.capitalization = pascal_case
|
||
|
|
|
||
|
|
# readonly instance fields are camelCase and begin with underscore
|
||
|
|
dotnet_naming_symbols.readonly_instance_fields.applicable_kinds = field
|
||
|
|
dotnet_naming_symbols.readonly_instance_fields.required_modifiers = readonly
|
||
|
|
dotnet_naming_symbols.readonly_instance_fields.applicable_accessibilities = private
|
||
|
|
|
||
|
|
dotnet_naming_style.underscore_camel_case_style.capitalization = camel_case
|
||
|
|
dotnet_naming_style.underscore_camel_case_style.required_prefix = _
|
||
|
|
|
||
|
|
dotnet_naming_rule.readonly_instance_fields_should_be_underscore_camel_case.symbols = readonly_instance_fields
|
||
|
|
dotnet_naming_rule.readonly_instance_fields_should_be_underscore_camel_case.style = underscore_camel_case_style
|
||
|
|
dotnet_naming_rule.readonly_instance_fields_should_be_underscore_camel_case.severity = warning
|
||
|
|
|
||
|
|
# readonly instance fields are camelCase and begin with underscore
|
||
|
|
dotnet_naming_rule.instance_fields_should_be_camel_case.severity = none
|
||
|
|
dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields
|
||
|
|
dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style
|
||
|
|
|
||
|
|
dotnet_naming_symbols.instance_fields.applicable_kinds = field
|
||
|
|
|
||
|
|
dotnet_naming_style.instance_field_style.capitalization = camel_case
|
||
|
|
dotnet_naming_style.instance_field_style.required_prefix = _
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
# static readonly fields start with s_ and use camelCase
|
||
|
|
dotnet_naming_symbols.static_readonly_fields.applicable_kinds = field
|
||
|
|
dotnet_naming_symbols.static_readonly_fields.required_modifiers = static, readonly
|
||
|
|
|
||
|
|
dotnet_naming_style.s_prefix_camel_case_style.capitalization = camel_case
|
||
|
|
dotnet_naming_style.s_prefix_camel_case_style.required_prefix = s_
|
||
|
|
|
||
|
|
dotnet_naming_rule.static_readonly_fields_should_be_s_prefix_camel_case.symbols = static_readonly_fields
|
||
|
|
dotnet_naming_rule.static_readonly_fields_should_be_s_prefix_camel_case.style = s_prefix_camel_case_style
|
||
|
|
dotnet_naming_rule.static_readonly_fields_should_be_s_prefix_camel_case.severity = warning
|
||
|
|
|
||
|
|
# Additional C# style preferences
|
||
|
|
csharp_style_namespace_declarations = file_scoped:error # no need for an extra indentation for namespace, when a single type per file rule is enforced.
|
||
|
|
csharp_style_prefer_method_group_conversion = false:none # more explicit style is preferred
|
||
|
|
csharp_style_prefer_top_level_statements = false:error # this abomination needs to die!
|
||
|
|
csharp_style_prefer_primary_constructors = false:error # primary constructors don't inject into readonly fields, immutability is much more important than conciseness
|
||
|
|
csharp_style_prefer_null_check_over_type_check = true:suggestion
|
||
|
|
csharp_style_prefer_local_over_anonymous_function = true:suggestion
|
||
|
|
csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion
|
||
|
|
csharp_style_prefer_tuple_swap = true:suggestion
|
||
|
|
csharp_style_prefer_utf8_string_literals = true:suggestion
|
||
|
|
csharp_prefer_static_anonymous_function = true:suggestion
|
||
|
|
csharp_style_prefer_readonly_struct = true:suggestion
|
||
|
|
csharp_style_prefer_readonly_struct_member = true:suggestion
|
||
|
|
csharp_style_allow_embedded_statements_on_same_line_experimental = true:silent
|
||
|
|
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true:silent
|
||
|
|
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true:silent
|
||
|
|
csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true:silent
|
||
|
|
csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true:silent
|
||
|
|
csharp_style_prefer_switch_expression = true:suggestion
|
||
|
|
csharp_style_prefer_pattern_matching = true:silent
|
||
|
|
csharp_style_prefer_not_pattern = true:suggestion
|
||
|
|
csharp_style_prefer_extended_property_pattern = true:suggestion
|
||
|
|
|
||
|
|
# JS
|
||
|
|
dotnet_diagnostic.TS6385.severity = none
|
||
|
|
|
||
|
|
# IDE0001: Simplify Names
|
||
|
|
dotnet_diagnostic.IDE0001.severity = refactoring
|