Skip to content

Instantly share code, notes, and snippets.

@canton7
Created April 23, 2019 20:59

Revisions

  1. canton7 created this gist Apr 23, 2019.
    206 changes: 206 additions & 0 deletions .editorconfig
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,206 @@
    [*.cs]

    # Standard EditorConfig settings
    indent_style = space
    indent_size = 4

    # .NET code style settings

    # See https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference?view=vs-2019
    # This section lists all of the rules from the above link, in order

    # "This." and "Me." qualifiers
    dotnet_style_qualification_for_event = true:warning
    dotnet_style_qualification_for_field = true:warning
    dotnet_style_qualification_for_method = true:warning
    dotnet_style_qualification_for_property = true:warning

    # Language keywords instead of framework type names for type references
    dotnet_style_predefined_type_for_locals_parameters_members = true:warning
    dotnet_style_predefined_type_for_member_access = true:warning

    # Modifier preferences
    dotnet_style_require_accessibility_modifiers = for_none_interface_members:warning
    csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:warning
    dotnet_style_readonly_field = true:warning

    # Parentheses preferences
    dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
    dotnet_style_parentheses_in_relational_binary_operators = never_if_unnecessary:silent
    dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
    dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent

    # Expression-level preferences
    dotnet_style_object_initializer = true:suggestion
    dotnet_style_collection_initializer = true:suggestion
    dotnet_style_explicit_tuple_names = true:suggestion
    dotnet_style_prefer_inferred_tuple_names = true:none
    dotnet_style_prefer_inferred_anonymous_type_member_names = true:silent
    dotnet_style_prefer_auto_properties = true:suggestion
    dotnet_style_prefer_is_null_check_over_reference_equality_method = false:suggestion
    dotnet_style_prefer_conditional_expression_over_assignment = true:silent
    dotnet_style_prefer_conditional_expression_over_return = true:silent

    # "Null" checking preferences
    dotnet_style_coalesce_expression = true:suggestion
    dotnet_style_null_propagation = true:suggestion

    # C# code style settings

    # Implicit and explicit types
    csharp_style_var_for_built_in_types = false:suggestion
    csharp_style_var_when_type_is_apparent = true:suggestion
    csharp_style_var_elsewhere = false:silent

    # Expression-bodied members
    csharp_style_expression_bodied_methods = when_on_single_line:silent
    csharp_style_expression_bodied_constructors = when_on_single_line:silent
    csharp_style_expression_bodied_operators = when_on_single_line:silent
    csharp_style_expression_bodied_properties = true:suggestion
    csharp_style_expression_bodied_indexers = true:suggestion
    csharp_style_expression_bodied_accessors = true:suggestion

    # Pattern matching
    csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
    csharp_style_pattern_matching_over_as_with_null_check = true:suggestion

    # Inlined variable declarations
    csharp_style_inlined_variable_declaration = true:silent

    # Expression-level preferences
    csharp_prefer_simple_default_expression = true:suggestion
    csharp_style_deconstructed_variable_declaration = true:suggestion
    csharp_style_pattern_local_over_anonymous_function = true:suggestion

    # "Null" checking preferences
    csharp_style_throw_expression = true:suggestion
    csharp_style_conditional_delegate_call = true:suggestion

    # Code block preferences
    csharp_prefer_braces = true:silent

    # .NET formatting settings

    # Organize usings
    dotnet_sort_system_directives_first = true
    dotnet_separate_import_directive_groups = false

    # C# formatting settings

    # Newline options
    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
    csharp_indent_case_contents = true
    csharp_indent_switch_labels = true
    csharp_indent_labels = one_less_than_current

    # Spacing options
    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 = true
    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
    csharp_preserve_single_line_statements = false
    csharp_preserve_single_line_blocks = true

    # .NET naming conventions

    # See https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-naming-conventions?view=vs-2019

    # Style: pascal case style
    dotnet_naming_style.pascal_case.capitalization = pascal_case

    # Style: camel case style
    dotnet_name_style.camel_case.capitalization = camel_case

    # Symbols: non-private members
    dotnet_naming_symbols.non_private_members.applicable_kinds = property,field,event
    dotnet_naming_symbols.non_private_members.applicable_accessibilities = public,internal,protected,protected_internal

    # Rule: non-private members must be capitalized
    dotnet_naming_rule.non_private_members_must_be_capitalized.style = pascal_case
    dotnet_naming_rule.non_private_members_must_be_capitalized.symbols = non_private_members
    dotnet_naming_rule.non_private_members_must_be_capitalized.severity = warning

    # Symbols: const fields
    dotnet_naming_symbols.const_fields.applicable_kinds = field
    dotnet_naming_symbols.const_fields.required_modifiers = const

    # Rule: const fields must be capitalized
    dotnet_naming_rule.const_fields_must_be_capitalized.style = pascal_case
    dotnet_naming_rule.const_fields_must_be_capitalized.symbols = const_fields
    dotnet_naming_rule.const_fields_must_be_capitalized.severity = warning

    # Symbols: static readonly fields
    dotnet_naming_symbols.static_readonly_fields.applicable_kinds = field
    dotnet_naming_symbols.static_readonly_fields.required_modifiers = static,readonly

    # Rule: static readonly fields must be capitalized
    dotnet_naming_rule.static_readonly_fields_must_be_capitalized.style = pascal_case
    dotnet_naming_rule.static_readonly_fields_must_be_capitalized.symbols = static_readonly_fields
    dotnet_naming_rule.static_readonly_fields_must_be_capitalized.severity = warning

    # Symbols: private fields, properties, events
    dotnet_naming_symbols.non_public_fields_properties_events.applicable_kinds = property,field,event
    dotnet_naming_symbols.non_public_fields_properties_events.applicable_accessibilities = private

    # Rule: private fields, properties, events must not be capitalized
    dotnet_naming_rule.private_fields_properties_events_must_not_be_capitalized.style = camel_case
    dotnet_naming_rule.private_fields_properties_events_must_not_be_capitalized.symbols = non_public_fields_properties_events
    dotnet_naming_rule.private_fields_properties_events_must_not_be_capitalized.severity = warning

    # Symbols: interfaces
    dotnet_naming_symbols.interfaces.applicable_kinds = interface

    # Style: must be pascal case and begin with "I"
    dotnet_naming_style.must_begin_with_i.capitalization = pascal_case
    dotnet_naming_style.must_begin_with_i.required_prefix = I

    # Rule: interfaces must begin with "I"
    dotnet_naming_rule.interfaces_must_begin_with_i.style = must_begin_with_i
    dotnet_naming_rule.interfaces_must_begin_with_i.symbols = interfaces
    dotnet_naming_rule.interfaces_must_begin_with_i.severity = warning

    # Symbols: namespaces, methods, delegates, classes, structs, interfaces, enums, local functions
    dotnet_naming_symbols.types_and_methods.applicable_kinds = namespace,class,struct,interface,enum,method,delegate,local_function
    dotnet_naming_symbols.types_and_methods.applicable_accessibilities = *

    # Rule: namespaces, methods, delegates, classes, structs, interfaces, enums, local functions must be capitalized
    dotnet_naming_rule.types_and_methods_must_be_capitalized.style = pascal_case
    dotnet_naming_rule.types_and_methods_must_be_capitalized.symbols = types_and_methods
    dotnet_naming_rule.types_and_methods_must_be_capitalized.severity = warning

    # Symbols: locals and parameters
    dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter,local

    # Rule: locals and parameters must be camel-case
    dotnet_naming_rule.locals_and_parameters_must_not_be_capitalized.style = camel_case
    dotnet_naming_rule.locals_and_parameters_must_not_be_capitalized.symbols = locals_and_parameters
    dotnet_naming_rule.locals_and_parameters_must_not_be_capitalized.severity = warning

    # Symbols: type parameters
    dotnet_naming_symbols.type_parameters.applicable_kinds = type_parameter

    # Style: must be Pascal case and begin with a "T"
    dotnet_naming_style.must_begin_with_t.capitalization = pascal_case
    dotnet_naming_style.must_begin_with_t.required_prefix = T

    # Rule: type parameters must be pascal case and begin with a "T"
    dotnet_naming_rule.type_parameters_must_begin_with_t.style = must_begin_with_t
    dotnet_naming_rule.type_parameters_must_begin_with_t.symbols = type_parameters
    dotnet_naming_rule.type_parameters_must_begin_with_t.severity = warning