Last active
April 8, 2025 10:49
-
-
Save cezarlamann/299050fbdaca2005c2e9bbb1c349cb00 to your computer and use it in GitHub Desktop.
Default EditorConfig for new csharp/web projects
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Top-most EditorConfig file | |
| root = true | |
| # Default settings for all files | |
| [*] | |
| charset = utf-8 | |
| end_of_line = lf | |
| insert_final_newline = false | |
| indent_size = 4 | |
| tab_width = 4 | |
| indent_style = space | |
| max_line_length = 120 | |
| # Indentation for other file types | |
| [*.cshtml] | |
| indent_style = space | |
| indent_size = 2 | |
| tab_width = 2 | |
| [*.xml] | |
| indent_size = 2 | |
| indent_style = space | |
| tab_width = 2 | |
| [*.js] | |
| indent_style = space | |
| indent_size = 2 | |
| tab_width = 2 | |
| [*.ts] | |
| indent_style = space | |
| indent_size = 2 | |
| tab_width = 2 | |
| [*.jsx] | |
| indent_style = space | |
| indent_size = 2 | |
| tab_width = 2 | |
| [*.tsx] | |
| indent_style = space | |
| indent_size = 2 | |
| tab_width = 2 | |
| [*.html] | |
| indent_style = space | |
| indent_size = 2 | |
| tab_width = 2 | |
| [*.css] | |
| indent_style = space | |
| indent_size = 2 | |
| tab_width = 2 | |
| [*.sql] | |
| indent_style = space | |
| indent_size = 4 | |
| tab_width = 4 | |
| # Default indentation for specific file types | |
| [*.cs] | |
| indent_style = space | |
| indent_size = 4 | |
| tab_width = 4 | |
| # Apply global severity settings | |
| dotnet_analyzer_diagnostic.severity = error | |
| dotnet_analyzer_diagnostic.category-StyleCop.severity = error | |
| # === File header enforcement (StyleCop) === | |
| dotnet_diagnostic.SA1633.severity = warning | |
| file_header_template = // Copyright (c) 2025 MyCompany. All rights reserved. | |
| # Enforce block-scoped namespaces | |
| csharp_style_namespace_declarations = block_scoped:error | |
| # System usings first | |
| dotnet_sort_system_directives_first = true:error | |
| # Separate import directive groups (System, third-party, project) | |
| dotnet_separate_import_directive_groups = true | |
| # Usings must be inside the namespace | |
| dotnet_style_qualification_for_namespace = true | |
| dotnet_style_prefer_usings_inside_namespace = true:error | |
| # Warn on unused parameters and variables | |
| dotnet_diagnostic.CS0168.severity = warning # variable declared but never used | |
| dotnet_diagnostic.CS0219.severity = warning # variable assigned but never used | |
| # === Enforce _camelCase for private fields and properties (StyleCop / Roslynator) === | |
| dotnet_naming_rule.private_fields_should_be__camelcase.severity = error | |
| dotnet_naming_rule.private_fields_should_be__camelcase.symbols = private_fields | |
| dotnet_naming_rule.private_fields_should_be__camelcase.style = _camelcase | |
| dotnet_naming_symbols.private_fields.applicable_kinds = field | |
| dotnet_naming_symbols.private_fields.applicable_accessibilities = private | |
| dotnet_naming_symbols.private_fields.required_modifiers = | |
| # === Enforce readonly for constructor-injected fields (Roslynator / custom rule) === | |
| dotnet_diagnostic.RCS1213.severity = error # RCS1213: Remove unused member declaration | |
| dotnet_diagnostic.RCS1118.severity = error # Mark field as readonly (Roslynator) | |
| # 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 | |
| dotnet_diagnostic.IDE0290.severity = none | |
| dotnet_diagnostic.IDE0005.severity = warning | |
| dotnet_diagnostic.IDE0035.severity = warning | |
| dotnet_diagnostic.IDE0040.severity = warning | |
| dotnet_diagnostic.IDE0044.severity = warning | |
| dotnet_diagnostic.IDE0280.severity = warning | |
| # 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: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 = for_non_interface_members:warning | |
| # Expression-level preferences | |
| dotnet_style_coalesce_expression = true:suggestion | |
| dotnet_style_collection_initializer = true:suggestion | |
| dotnet_style_explicit_tuple_names = true:suggestion | |
| dotnet_style_null_propagation = true:suggestion | |
| dotnet_style_object_initializer = true:suggestion | |
| dotnet_style_operator_placement_when_wrapping = beginning_of_line | |
| dotnet_style_prefer_auto_properties = true:suggestion | |
| dotnet_style_prefer_compound_assignment = true:suggestion | |
| dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion | |
| dotnet_style_prefer_conditional_expression_over_return = true:suggestion | |
| 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:suggestion | |
| dotnet_style_prefer_simplified_boolean_expressions = true:suggestion | |
| dotnet_style_prefer_simplified_interpolation = true:suggestion | |
| # Field preferences | |
| dotnet_style_readonly_field = true:warning | |
| # Parameter preferences | |
| dotnet_code_quality_unused_parameters = all:suggestion | |
| # Suppression preferences | |
| dotnet_remove_unnecessary_suppression_exclusions = none | |
| # Avoid primary constructors | |
| csharp_style_prefer_primary_constructors = false | |
| # 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:suggestion | |
| csharp_style_expression_bodied_local_functions = false: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:suggestion | |
| csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion | |
| csharp_style_prefer_not_pattern = true:suggestion | |
| csharp_style_prefer_pattern_matching = true:silent | |
| csharp_style_prefer_switch_expression = true:suggestion | |
| # Null-checking preferences | |
| csharp_style_conditional_delegate_call = true:suggestion | |
| # Modifier preferences | |
| csharp_prefer_static_local_function = true:warning | |
| csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:silent | |
| # Code-block preferences | |
| csharp_prefer_braces = true:silent | |
| csharp_prefer_simple_using_statement = true:suggestion | |
| # Expression-level preferences | |
| csharp_prefer_simple_default_expression = true:suggestion | |
| csharp_style_deconstructed_variable_declaration = true:suggestion | |
| csharp_style_inlined_variable_declaration = 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_throw_expression = 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 = inside_namespace:warning | |
| #### 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 rules | |
| dotnet_naming_rule.types_and_namespaces_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.types_and_namespaces_should_be_pascalcase.symbols = types_and_namespaces | |
| dotnet_naming_rule.types_and_namespaces_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.interfaces_should_be_ipascalcase.severity = suggestion | |
| dotnet_naming_rule.interfaces_should_be_ipascalcase.symbols = interfaces | |
| dotnet_naming_rule.interfaces_should_be_ipascalcase.style = ipascalcase | |
| dotnet_naming_rule.type_parameters_should_be_tpascalcase.severity = suggestion | |
| dotnet_naming_rule.type_parameters_should_be_tpascalcase.symbols = type_parameters | |
| dotnet_naming_rule.type_parameters_should_be_tpascalcase.style = tpascalcase | |
| dotnet_naming_rule.methods_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.methods_should_be_pascalcase.symbols = methods | |
| dotnet_naming_rule.methods_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.properties_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.properties_should_be_pascalcase.symbols = properties | |
| dotnet_naming_rule.properties_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.events_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.events_should_be_pascalcase.symbols = events | |
| dotnet_naming_rule.events_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.local_variables_should_be_camelcase.severity = suggestion | |
| dotnet_naming_rule.local_variables_should_be_camelcase.symbols = local_variables | |
| dotnet_naming_rule.local_variables_should_be_camelcase.style = camelcase | |
| dotnet_naming_rule.local_constants_should_be_camelcase.severity = suggestion | |
| dotnet_naming_rule.local_constants_should_be_camelcase.symbols = local_constants | |
| dotnet_naming_rule.local_constants_should_be_camelcase.style = camelcase | |
| dotnet_naming_rule.parameters_should_be_camelcase.severity = suggestion | |
| dotnet_naming_rule.parameters_should_be_camelcase.symbols = parameters | |
| dotnet_naming_rule.parameters_should_be_camelcase.style = camelcase | |
| dotnet_naming_rule.public_fields_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.public_fields_should_be_pascalcase.symbols = public_fields | |
| dotnet_naming_rule.public_fields_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.private_static_fields_should_be_s_camelcase.severity = suggestion | |
| dotnet_naming_rule.private_static_fields_should_be_s_camelcase.symbols = private_static_fields | |
| dotnet_naming_rule.private_static_fields_should_be_s_camelcase.style = s_camelcase | |
| dotnet_naming_rule.public_constant_fields_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.public_constant_fields_should_be_pascalcase.symbols = public_constant_fields | |
| dotnet_naming_rule.public_constant_fields_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.private_constant_fields_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.private_constant_fields_should_be_pascalcase.symbols = private_constant_fields | |
| dotnet_naming_rule.private_constant_fields_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.public_static_readonly_fields_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.public_static_readonly_fields_should_be_pascalcase.symbols = public_static_readonly_fields | |
| dotnet_naming_rule.public_static_readonly_fields_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.private_static_readonly_fields_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.private_static_readonly_fields_should_be_pascalcase.symbols = private_static_readonly_fields | |
| dotnet_naming_rule.private_static_readonly_fields_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.enums_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.enums_should_be_pascalcase.symbols = enums | |
| dotnet_naming_rule.enums_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.local_functions_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.local_functions_should_be_pascalcase.symbols = local_functions | |
| dotnet_naming_rule.local_functions_should_be_pascalcase.style = pascalcase | |
| dotnet_naming_rule.non_field_members_should_be_pascalcase.severity = suggestion | |
| dotnet_naming_rule.non_field_members_should_be_pascalcase.symbols = non_field_members | |
| dotnet_naming_rule.non_field_members_should_be_pascalcase.style = pascalcase | |
| # Symbol specifications | |
| dotnet_naming_symbols.interfaces.applicable_kinds = interface | |
| dotnet_naming_symbols.interfaces.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected | |
| dotnet_naming_symbols.interfaces.required_modifiers = | |
| dotnet_naming_symbols.enums.applicable_kinds = enum | |
| dotnet_naming_symbols.enums.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected | |
| dotnet_naming_symbols.enums.required_modifiers = | |
| dotnet_naming_symbols.events.applicable_kinds = event | |
| dotnet_naming_symbols.events.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected | |
| dotnet_naming_symbols.events.required_modifiers = | |
| dotnet_naming_symbols.methods.applicable_kinds = method | |
| dotnet_naming_symbols.methods.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected | |
| dotnet_naming_symbols.methods.required_modifiers = | |
| dotnet_naming_symbols.properties.applicable_kinds = property | |
| dotnet_naming_symbols.properties.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected | |
| dotnet_naming_symbols.properties.required_modifiers = | |
| dotnet_naming_symbols.public_fields.applicable_kinds = field | |
| dotnet_naming_symbols.public_fields.applicable_accessibilities = public, internal | |
| dotnet_naming_symbols.public_fields.required_modifiers = | |
| dotnet_naming_symbols.private_fields.applicable_kinds = field | |
| dotnet_naming_symbols.private_fields.applicable_accessibilities = private, protected, protected_internal, private_protected | |
| dotnet_naming_symbols.private_fields.required_modifiers = | |
| dotnet_naming_symbols.private_static_fields.applicable_kinds = field | |
| dotnet_naming_symbols.private_static_fields.applicable_accessibilities = private, protected, protected_internal, private_protected | |
| dotnet_naming_symbols.private_static_fields.required_modifiers = static | |
| dotnet_naming_symbols.types_and_namespaces.applicable_kinds = namespace, class, struct, interface, enum | |
| dotnet_naming_symbols.types_and_namespaces.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected | |
| dotnet_naming_symbols.types_and_namespaces.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 = | |
| dotnet_naming_symbols.type_parameters.applicable_kinds = namespace | |
| dotnet_naming_symbols.type_parameters.applicable_accessibilities = * | |
| dotnet_naming_symbols.type_parameters.required_modifiers = | |
| dotnet_naming_symbols.private_constant_fields.applicable_kinds = field | |
| dotnet_naming_symbols.private_constant_fields.applicable_accessibilities = private, protected, protected_internal, private_protected | |
| dotnet_naming_symbols.private_constant_fields.required_modifiers = const | |
| dotnet_naming_symbols.local_variables.applicable_kinds = local | |
| dotnet_naming_symbols.local_variables.applicable_accessibilities = local | |
| dotnet_naming_symbols.local_variables.required_modifiers = | |
| dotnet_naming_symbols.local_constants.applicable_kinds = local | |
| dotnet_naming_symbols.local_constants.applicable_accessibilities = local | |
| dotnet_naming_symbols.local_constants.required_modifiers = const | |
| dotnet_naming_symbols.parameters.applicable_kinds = parameter | |
| dotnet_naming_symbols.parameters.applicable_accessibilities = * | |
| dotnet_naming_symbols.parameters.required_modifiers = | |
| dotnet_naming_symbols.public_constant_fields.applicable_kinds = field | |
| dotnet_naming_symbols.public_constant_fields.applicable_accessibilities = public, internal | |
| dotnet_naming_symbols.public_constant_fields.required_modifiers = const | |
| dotnet_naming_symbols.public_static_readonly_fields.applicable_kinds = field | |
| dotnet_naming_symbols.public_static_readonly_fields.applicable_accessibilities = public, internal | |
| dotnet_naming_symbols.public_static_readonly_fields.required_modifiers = readonly, static | |
| dotnet_naming_symbols.private_static_readonly_fields.applicable_kinds = field | |
| dotnet_naming_symbols.private_static_readonly_fields.applicable_accessibilities = private, protected, protected_internal, private_protected | |
| dotnet_naming_symbols.private_static_readonly_fields.required_modifiers = readonly, static | |
| dotnet_naming_symbols.local_functions.applicable_kinds = local_function | |
| dotnet_naming_symbols.local_functions.applicable_accessibilities = * | |
| dotnet_naming_symbols.local_functions.required_modifiers = | |
| # Naming styles | |
| dotnet_naming_style.pascalcase.required_prefix = | |
| dotnet_naming_style.pascalcase.required_suffix = | |
| dotnet_naming_style.pascalcase.word_separator = | |
| dotnet_naming_style.pascalcase.capitalization = pascal_case | |
| dotnet_naming_style.ipascalcase.required_prefix = I | |
| dotnet_naming_style.ipascalcase.required_suffix = | |
| dotnet_naming_style.ipascalcase.word_separator = | |
| dotnet_naming_style.ipascalcase.capitalization = pascal_case | |
| dotnet_naming_style.tpascalcase.required_prefix = T | |
| dotnet_naming_style.tpascalcase.required_suffix = | |
| dotnet_naming_style.tpascalcase.word_separator = | |
| dotnet_naming_style.tpascalcase.capitalization = pascal_case | |
| dotnet_naming_style._camelcase.required_prefix = _ | |
| dotnet_naming_style._camelcase.required_suffix = | |
| dotnet_naming_style._camelcase.word_separator = | |
| dotnet_naming_style._camelcase.capitalization = camel_case | |
| dotnet_naming_style.camelcase.required_prefix = | |
| dotnet_naming_style.camelcase.required_suffix = | |
| dotnet_naming_style.camelcase.word_separator = | |
| dotnet_naming_style.camelcase.capitalization = camel_case | |
| dotnet_naming_style.s_camelcase.required_prefix = s_ | |
| dotnet_naming_style.s_camelcase.required_suffix = | |
| dotnet_naming_style.s_camelcase.word_separator = | |
| dotnet_naming_style.s_camelcase.capitalization = camel_case |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment