Last active
December 19, 2018 14:36
-
-
Save mitch-b/1cffd4a4133148e943bd75b21ee816ba to your computer and use it in GitHub Desktop.
C# Projects .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
# editorconfig.org | |
root = true | |
[*] | |
indent_style = space | |
indent_size = 2 | |
end_of_line = lf | |
charset = utf-8 | |
trim_trailing_whitespace = true | |
insert_final_newline = true | |
[*.cs] | |
indent_size = 4 | |
end_of_line = crlf | |
# "This." and "Me." qualifiers: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#this_and_me | |
dotnet_style_qualification_for_field = true:warning | |
dotnet_style_qualification_for_property = true:warning | |
dotnet_style_qualification_for_method = true:suggestion | |
dotnet_style_qualification_for_event = true:warning | |
# Language keywords instead of framework type names for type references: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#language_keywords | |
dotnet_style_predefined_type_for_locals_parameters_members = true:warning | |
dotnet_style_predefined_type_for_member_access = true:warning | |
# Modifier preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#normalize_modifiers | |
dotnet_style_require_accessibility_modifiers = always:suggestion | |
dotnet_style_readonly_field = true:warning | |
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion | |
# Expression-level preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#expression_level | |
dotnet_style_object_initializer = true:warning | |
dotnet_style_collection_initializer = true:warning | |
dotnet_style_explicit_tuple_names = true:warning | |
dotnet_style_prefer_inferred_tuple_names = true:suggestion | |
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion | |
dotnet_style_prefer_auto_properties = true:warning | |
dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion | |
dotnet_style_prefer_conditional_expression_over_return = true:suggestion | |
# Null-checking preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#null_checking | |
dotnet_style_coalesce_expression = true:warning | |
dotnet_style_null_propagation = true:warning | |
# Implicit and explicit types: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#var | |
csharp_style_var_for_built_in_types = true:warning | |
csharp_style_var_when_type_is_apparent = true:warning | |
csharp_style_var_elsewhere = false:warning | |
# Expression-bodied members: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#expression_bodied_members | |
csharp_style_expression_bodied_methods = when_on_single_line:warning | |
csharp_style_expression_bodied_constructor = when_on_single_line:suggestion | |
csharp_style_expression_bodied_operators = when_on_single_line:warning | |
csharp_style_expression_bodied_properties = when_on_single_line:warning | |
csharp_style_expression_bodied_indexers = when_on_single_line:warning | |
csharp_style_expression_bodied_accessors = when_on_single_line:warning | |
# Pattern matching: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#pattern_matching | |
csharp_style_pattern_matching_over_is_with_cast_check = true:warning | |
csharp_style_pattern_matching_over_as_with_null_check = true:warning | |
# Inlined variable declarations: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#inlined_variable_declarations | |
csharp_style_inlined_variable_declaration = true:warning | |
# Expression-level preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#expression_level_csharp | |
csharp_prefer_simple_default_expression = true:warning | |
csharp_style_deconstructed_variable_declaration = true:warning | |
csharp_style_pattern_local_over_anonymous_function = true:warning | |
# "Null" checking preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#null_checking_csharp | |
csharp_style_throw_expression = true:warning | |
csharp_style_conditional_delegate_call = true:warning | |
# Code block preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#code_block | |
csharp_prefer_braces = true:warning | |
# Organize usings: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#net-formatting-settings | |
dotnet_sort_system_directives_first = true | |
# C# formatting settings: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#c-formatting-settings | |
csharp_new_line_before_open_brace = all | |
csharp_new_line_before_else = true | |
csharp_new_line_before_catch = true | |
csharp_new_line_before_finally = true | |
csharp_new_line_before_members_in_object_initializers = true | |
csharp_new_line_before_members_in_anonymous_types = true | |
csharp_new_line_between_query_expression_clauses = true | |
# Indentation options: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#indent | |
csharp_indent_case_contents = true | |
csharp_indent_switch_labels = true | |
csharp_indent_labels = one_less_than_current | |
# Spacing options: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#spacing | |
csharp_space_after_cast = false | |
csharp_space_after_keywords_in_control_flow_statements = true | |
csharp_space_between_method_declaration_parameter_list_parentheses = false | |
csharp_space_between_method_call_parameter_list_parentheses = false | |
csharp_space_between_parentheses = false | |
csharp_space_before_colon_in_inheritance_clause = true | |
csharp_space_after_colon_in_inheritance_clause = true | |
csharp_space_around_binary_operators = before_and_after | |
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false | |
csharp_space_between_method_call_name_and_opening_parenthesis = false | |
csharp_space_between_method_call_empty_parameter_list_parentheses = false | |
# Wrapping options: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#wrapping | |
csharp_preserve_single_line_statements = false | |
csharp_preserve_single_line_blocks = true | |
############################### | |
# Naming Conventions: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-naming-conventions | |
############################### | |
# Style Definitions | |
dotnet_naming_style.pascal_case_style.capitalization = pascal_case | |
dotnet_naming_style.camel_case_style.capitalization = camel_case | |
dotnet_naming_style.I_prefix_style.required_prefix = I | |
dotnet_naming_style.I_prefix_style.capitalization = pascal_case | |
dotnet_naming_style.underscore_prefix_style.required_prefix = _ | |
dotnet_naming_style.underscore_prefix_style.capitalization = camel_case | |
# Use PascalCase for constant fields | |
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = warning | |
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields | |
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style | |
dotnet_naming_symbols.constant_fields.applicable_kinds = field | |
dotnet_naming_symbols.constant_fields.applicable_accessibilities = * | |
dotnet_naming_symbols.constant_fields.required_modifiers = const | |
# Use PascalCase for public fields | |
dotnet_naming_rule.pascal_case_for_public_fields.severity = warning | |
dotnet_naming_rule.pascal_case_for_public_fields.symbols = public_fields | |
dotnet_naming_rule.pascal_case_for_public_fields.style = pascal_case_style | |
dotnet_naming_symbols.public_fields.applicable_kinds = field | |
dotnet_naming_symbols.public_fields.applicable_accessibilities = public | |
# Interfaces must be PascalCase and have an I prefix | |
dotnet_naming_rule.interfaces_start_with_I.severity = warning | |
dotnet_naming_rule.interfaces_start_with_I.symbols = any_interface | |
dotnet_naming_rule.interfaces_start_with_I.style = I_prefix_style | |
dotnet_naming_symbols.any_interface.applicable_accessibilities = * | |
dotnet_naming_symbols.any_interface.applicable_kinds = interface | |
# Private fields must be prefixed with an _ (underscore) | |
dotnet_naming_rule.private_internal_fields_start_with_underscore.severity = warning | |
dotnet_naming_rule.private_internal_fields_start_with_underscore.symbols = private_internal_fields | |
dotnet_naming_rule.private_internal_fields_start_with_underscore.style = underscore_prefix_style | |
dotnet_naming_symbols.private_internal_fields.applicable_kinds = field | |
dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal | |
# Classes, structs, methods, enums, events, properties, namespaces, delegates, type_parameters must be PascalCase | |
dotnet_naming_rule.general_naming.severity = warning | |
dotnet_naming_rule.general_naming.symbols = general | |
dotnet_naming_rule.general_naming.style = pascal_case_style | |
dotnet_naming_symbols.general.applicable_kinds = class,struct,enum,property,method,event,namespace,delegate,type_parameter | |
dotnet_naming_symbols.general.applicable_accessibilities = * | |
# Everything else is camelCase | |
dotnet_naming_rule.everything_else_naming.severity = warning | |
dotnet_naming_rule.everything_else_naming.symbols = everything_else | |
dotnet_naming_rule.everything_else_naming.style = camel_case_style | |
dotnet_naming_symbols.everything_else.applicable_kinds = * | |
dotnet_naming_symbols.everything_else.applicable_accessibilities = * |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment