Created
September 16, 2023 14:17
-
-
Save Draugor/026aff0a316cfa8ee8af783e8680f686 to your computer and use it in GitHub Desktop.
Basic C# naming and code style conventions as a .editorconfig
This file contains 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
# Remove the line below if you want to inherit .editorconfig settings from higher directories | |
root = true | |
#### this file was exported via Visual Studio 2022, after configurating VS using | |
#### https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions | |
#### and https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/coding-style.md | |
#### additionally it disables the basic IDExxx Analyzer to only show Roslynator ones (see section 'Analyzer configurations' to change that) | |
# C# files | |
[*.cs] | |
#### Core EditorConfig Options #### | |
# Indentation and spacing | |
indent_size = 4 | |
indent_style = space | |
tab_width = 4 | |
# New line preferences | |
end_of_line = crlf | |
insert_final_newline = false | |
#### Analyzer configurations #### | |
# Remove unnecessary blank line | |
dotnet_diagnostic.rcs1036.severity = none | |
# Remove redundant parenthesis | |
dotnet_diagnostic.rcs1032.severity = none | |
# Declare inside namespace | |
dotnet_diagnostic.rcs1110.severity = warning | |
# disable IDExxxx messages | |
dotnet_analyzer_diagnostic.category-CodeQuality.severity = none | |
dotnet_analyzer_diagnostic.category-Style.severity = none | |
# allow Roslynator messages | |
dotnet_analyzer_diagnostic.category-roslynator.severity = default|none|silent|suggestion|warning|error | |
#### .NET Coding Conventions #### | |
# Organize usings | |
dotnet_separate_import_directive_groups = false | |
dotnet_sort_system_directives_first = false | |
file_header_template = unset | |
# this. and Me. preferences | |
dotnet_style_qualification_for_event = false | |
dotnet_style_qualification_for_field = false | |
dotnet_style_qualification_for_method = false | |
dotnet_style_qualification_for_property = false | |
# Language keywords vs BCL types preferences | |
dotnet_style_predefined_type_for_locals_parameters_members = true | |
dotnet_style_predefined_type_for_member_access = true | |
# Parentheses preferences | |
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity | |
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity | |
dotnet_style_parentheses_in_other_operators = never_if_unnecessary | |
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity | |
# Modifier preferences | |
dotnet_style_require_accessibility_modifiers = for_non_interface_members | |
# Expression-level preferences | |
dotnet_style_coalesce_expression = true | |
dotnet_style_collection_initializer = true | |
dotnet_style_explicit_tuple_names = true | |
dotnet_style_namespace_match_folder = true | |
dotnet_style_null_propagation = true | |
dotnet_style_object_initializer = true | |
dotnet_style_operator_placement_when_wrapping = beginning_of_line | |
dotnet_style_prefer_auto_properties = true:suggestion | |
dotnet_style_prefer_compound_assignment = true | |
dotnet_style_prefer_conditional_expression_over_assignment = true | |
dotnet_style_prefer_conditional_expression_over_return = true | |
dotnet_style_prefer_foreach_explicit_cast_in_source = when_strongly_typed | |
dotnet_style_prefer_inferred_anonymous_type_member_names = true | |
dotnet_style_prefer_inferred_tuple_names = true | |
dotnet_style_prefer_is_null_check_over_reference_equality_method = true | |
dotnet_style_prefer_simplified_boolean_expressions = true | |
dotnet_style_prefer_simplified_interpolation = true | |
# Field preferences | |
dotnet_style_readonly_field = true | |
# Parameter preferences | |
dotnet_code_quality_unused_parameters = all | |
# Suppression preferences | |
dotnet_remove_unnecessary_suppression_exclusions = none | |
# New line preferences | |
dotnet_style_allow_multiple_blank_lines_experimental = false | |
dotnet_style_allow_statement_immediately_after_block_experimental = true | |
#### C# Coding Conventions #### | |
# var preferences | |
csharp_style_var_elsewhere = false | |
csharp_style_var_for_built_in_types = false | |
csharp_style_var_when_type_is_apparent = true | |
# Expression-bodied members | |
csharp_style_expression_bodied_accessors = true | |
csharp_style_expression_bodied_constructors = when_on_single_line | |
csharp_style_expression_bodied_indexers = true | |
csharp_style_expression_bodied_lambdas = true | |
csharp_style_expression_bodied_local_functions = false | |
csharp_style_expression_bodied_methods = when_on_single_line | |
csharp_style_expression_bodied_operators = false | |
csharp_style_expression_bodied_properties = true | |
# Pattern matching preferences | |
csharp_style_pattern_matching_over_as_with_null_check = true | |
csharp_style_pattern_matching_over_is_with_cast_check = true | |
csharp_style_prefer_extended_property_pattern = true | |
csharp_style_prefer_not_pattern = true | |
csharp_style_prefer_pattern_matching = true | |
csharp_style_prefer_switch_expression = true | |
# Null-checking preferences | |
csharp_style_conditional_delegate_call = true | |
# Modifier preferences | |
csharp_prefer_static_local_function = true | |
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 | |
# Code-block preferences | |
csharp_prefer_braces = when_multiline | |
csharp_prefer_simple_using_statement = true | |
csharp_style_namespace_declarations = file_scoped:suggestion | |
csharp_style_prefer_method_group_conversion = false | |
csharp_style_prefer_top_level_statements = true | |
# Expression-level preferences | |
csharp_prefer_simple_default_expression = true | |
csharp_style_deconstructed_variable_declaration = true | |
csharp_style_implicit_object_creation_when_type_is_apparent = true | |
csharp_style_inlined_variable_declaration = true | |
csharp_style_prefer_index_operator = true | |
csharp_style_prefer_local_over_anonymous_function = true | |
csharp_style_prefer_null_check_over_type_check = true | |
csharp_style_prefer_range_operator = true | |
csharp_style_prefer_tuple_swap = true | |
csharp_style_prefer_utf8_string_literals = true | |
csharp_style_throw_expression = true | |
csharp_style_unused_value_assignment_preference = discard_variable | |
csharp_style_unused_value_expression_statement_preference = discard_variable | |
# 'using' directive preferences | |
csharp_using_directive_placement = outside_namespace | |
# New line preferences | |
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true | |
csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = false | |
csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = false | |
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true | |
csharp_style_allow_embedded_statements_on_same_line_experimental = true | |
#### 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 = false | |
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 | |
dotnet_naming_rule.interface_should_be_i_pascal_case.severity = warning | |
dotnet_naming_rule.interface_should_be_i_pascal_case.symbols = interface | |
dotnet_naming_rule.interface_should_be_i_pascal_case.style = i_pascal_case | |
dotnet_naming_rule.types_namespace_methods_should_be_pascal_case.severity = suggestion | |
dotnet_naming_rule.types_namespace_methods_should_be_pascal_case.symbols = types_namespace_methods | |
dotnet_naming_rule.types_namespace_methods_should_be_pascal_case.style = pascal_case | |
dotnet_naming_rule.public_protected_internal_prot_properties_and_fields_should_be_pascal_case.severity = suggestion | |
dotnet_naming_rule.public_protected_internal_prot_properties_and_fields_should_be_pascal_case.symbols = public_protected_internal_prot_properties_and_fields | |
dotnet_naming_rule.public_protected_internal_prot_properties_and_fields_should_be_pascal_case.style = pascal_case | |
dotnet_naming_rule.private_or_internal_field_should_be___camel_case.severity = suggestion | |
dotnet_naming_rule.private_or_internal_field_should_be___camel_case.symbols = private_or_internal_field | |
dotnet_naming_rule.private_or_internal_field_should_be___camel_case.style = __camel_case | |
dotnet_naming_rule.private_or_internal_static_field_should_be_s__camel_case.severity = suggestion | |
dotnet_naming_rule.private_or_internal_static_field_should_be_s__camel_case.symbols = private_or_internal_static_field | |
dotnet_naming_rule.private_or_internal_static_field_should_be_s__camel_case.style = s__camel_case | |
dotnet_naming_rule.method_parameter_should_be_camal_case.severity = suggestion | |
dotnet_naming_rule.method_parameter_should_be_camal_case.symbols = method_parameter | |
dotnet_naming_rule.method_parameter_should_be_camal_case.style = camal_case | |
dotnet_naming_rule.async_methods_should_be_pascal_case_async.severity = suggestion | |
dotnet_naming_rule.async_methods_should_be_pascal_case_async.symbols = async_methods | |
dotnet_naming_rule.async_methods_should_be_pascal_case_async.style = pascal_case_async | |
dotnet_naming_rule.type_parameter_should_be_t_pascal_case.severity = suggestion | |
dotnet_naming_rule.type_parameter_should_be_t_pascal_case.symbols = type_parameter | |
dotnet_naming_rule.type_parameter_should_be_t_pascal_case.style = t_pascal_case | |
dotnet_naming_rule.local_should_be_camal_case.severity = suggestion | |
dotnet_naming_rule.local_should_be_camal_case.symbols = local | |
dotnet_naming_rule.local_should_be_camal_case.style = camal_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.private_or_internal_field.applicable_kinds = field | |
dotnet_naming_symbols.private_or_internal_field.applicable_accessibilities = internal, private, private_protected | |
dotnet_naming_symbols.private_or_internal_field.required_modifiers = | |
dotnet_naming_symbols.private_or_internal_static_field.applicable_kinds = field | |
dotnet_naming_symbols.private_or_internal_static_field.applicable_accessibilities = internal, private, private_protected | |
dotnet_naming_symbols.private_or_internal_static_field.required_modifiers = static | |
dotnet_naming_symbols.types_namespace_methods.applicable_kinds = namespace, class, struct, interface, enum, method, local_function | |
dotnet_naming_symbols.types_namespace_methods.applicable_accessibilities = * | |
dotnet_naming_symbols.types_namespace_methods.required_modifiers = | |
dotnet_naming_symbols.public_protected_internal_prot_properties_and_fields.applicable_kinds = property, field, event, local, method, local_function | |
dotnet_naming_symbols.public_protected_internal_prot_properties_and_fields.applicable_accessibilities = public, protected, protected_internal | |
dotnet_naming_symbols.public_protected_internal_prot_properties_and_fields.required_modifiers = | |
dotnet_naming_symbols.method_parameter.applicable_kinds = parameter | |
dotnet_naming_symbols.method_parameter.applicable_accessibilities = * | |
dotnet_naming_symbols.method_parameter.required_modifiers = | |
dotnet_naming_symbols.async_methods.applicable_kinds = method, local_function | |
dotnet_naming_symbols.async_methods.applicable_accessibilities = * | |
dotnet_naming_symbols.async_methods.required_modifiers = async | |
dotnet_naming_symbols.type_parameter.applicable_kinds = type_parameter | |
dotnet_naming_symbols.type_parameter.applicable_accessibilities = * | |
dotnet_naming_symbols.type_parameter.required_modifiers = | |
dotnet_naming_symbols.local.applicable_kinds = local | |
dotnet_naming_symbols.local.applicable_accessibilities = local | |
dotnet_naming_symbols.local.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.i_pascal_case.required_prefix = I | |
dotnet_naming_style.i_pascal_case.required_suffix = | |
dotnet_naming_style.i_pascal_case.word_separator = | |
dotnet_naming_style.i_pascal_case.capitalization = pascal_case | |
dotnet_naming_style.camal_case.required_prefix = | |
dotnet_naming_style.camal_case.required_suffix = | |
dotnet_naming_style.camal_case.word_separator = | |
dotnet_naming_style.camal_case.capitalization = camel_case | |
dotnet_naming_style.__camel_case.required_prefix = _ | |
dotnet_naming_style.__camel_case.required_suffix = | |
dotnet_naming_style.__camel_case.word_separator = | |
dotnet_naming_style.__camel_case.capitalization = camel_case | |
dotnet_naming_style.s__camel_case.required_prefix = s_ | |
dotnet_naming_style.s__camel_case.required_suffix = | |
dotnet_naming_style.s__camel_case.word_separator = | |
dotnet_naming_style.s__camel_case.capitalization = camel_case | |
dotnet_naming_style.pascal_case_async.required_prefix = | |
dotnet_naming_style.pascal_case_async.required_suffix = Async | |
dotnet_naming_style.pascal_case_async.word_separator = | |
dotnet_naming_style.pascal_case_async.capitalization = pascal_case | |
dotnet_naming_style.t_pascal_case.required_prefix = T | |
dotnet_naming_style.t_pascal_case.required_suffix = | |
dotnet_naming_style.t_pascal_case.word_separator = | |
dotnet_naming_style.t_pascal_case.capitalization = pascal_case |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment