.editorconfig

   1 # editorconfig.org
   2
   3 # top-most EditorConfig file
   4 root = true
   5
   6 # Default settings:
   7 # A newline ending every file
   8 # Use 4 spaces as indentation
   9 [*]
  10 insert_final_newline = true
  11 indent_style = space
  12 indent_size = 4
  13 trim_trailing_whitespace = true
  14
  15 [project.json]
  16 indent_size = 2
  17
  18 # C# files
  19 [*.cs]
  20 # New line preferences
  21 csharp_new_line_before_open_brace = all
  22 csharp_new_line_before_else = true
  23 csharp_new_line_before_catch = true
  24 csharp_new_line_before_finally = true
  25 csharp_new_line_before_members_in_object_initializers = true
  26 csharp_new_line_before_members_in_anonymous_types = true
  27 csharp_new_line_between_query_expression_clauses = true
  28
  29 # Indentation preferences
  30 csharp_indent_block_contents = true
  31 csharp_indent_braces = false
  32 csharp_indent_case_contents = true
  33 csharp_indent_case_contents_when_block = true
  34 csharp_indent_switch_labels = true
  35 csharp_indent_labels = one_less_than_current
  36
  37 # Modifier preferences
  38 csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
  39
  40 # avoid this. unless absolutely necessary
  41 dotnet_style_qualification_for_field = false:suggestion
  42 dotnet_style_qualification_for_property = false:suggestion
  43 dotnet_style_qualification_for_method = false:suggestion
  44 dotnet_style_qualification_for_event = false:suggestion
  45
  46 # Types: use keywords instead of BCL types, and permit var only when the type is clear
  47 csharp_style_var_for_built_in_types = false:suggestion
  48 csharp_style_var_when_type_is_apparent = false:none
  49 csharp_style_var_elsewhere = false:suggestion
  50 dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
  51 dotnet_style_predefined_type_for_member_access = true:suggestion
  52
  53 # name all constant fields using PascalCase
  54 dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
  55 dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields
  56 dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = pascal_case_style
  57 dotnet_naming_symbols.constant_fields.applicable_kinds   = field
  58 dotnet_naming_symbols.constant_fields.required_modifiers = const
  59 dotnet_naming_style.pascal_case_style.capitalization = pascal_case
  60
  61 # static fields should have s_ prefix
  62 dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
  63 dotnet_naming_rule.static_fields_should_have_prefix.symbols  = static_fields
  64 dotnet_naming_rule.static_fields_should_have_prefix.style    = static_prefix_style
  65 dotnet_naming_symbols.static_fields.applicable_kinds   = field
  66 dotnet_naming_symbols.static_fields.required_modifiers = static
  67 dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
  68 dotnet_naming_style.static_prefix_style.required_prefix = s_
  69 dotnet_naming_style.static_prefix_style.capitalization = camel_case
  70
  71 # internal and private fields should be _camelCase
  72 dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion
  73 dotnet_naming_rule.camel_case_for_private_internal_fields.symbols  = private_internal_fields
  74 dotnet_naming_rule.camel_case_for_private_internal_fields.style    = camel_case_underscore_style
  75 dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
  76 dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
  77 dotnet_naming_style.camel_case_underscore_style.required_prefix = _
  78 dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
  79
  80 # Code style defaults
  81 csharp_using_directive_placement = outside_namespace:suggestion
  82 dotnet_sort_system_directives_first = true
  83 csharp_prefer_braces = true:refactoring
  84 csharp_preserve_single_line_blocks = true:none
  85 csharp_preserve_single_line_statements = false:none
  86 csharp_prefer_static_local_function = true:suggestion
  87 csharp_prefer_simple_using_statement = false:none
  88 csharp_style_prefer_switch_expression = true:suggestion
  89
  90 # Code quality
  91 dotnet_style_readonly_field = true:suggestion
  92 dotnet_code_quality_unused_parameters = non_public:suggestion
  93
  94 # Expression-level preferences
  95 dotnet_style_object_initializer = true:suggestion
  96 dotnet_style_collection_initializer = true:suggestion
  97 dotnet_style_explicit_tuple_names = true:suggestion
  98 dotnet_style_coalesce_expression = true:suggestion
  99 dotnet_style_null_propagation = true:suggestion
 100 dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
 101 dotnet_style_prefer_inferred_tuple_names = true:suggestion
 102 dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
 103 dotnet_style_prefer_auto_properties = true:suggestion
 104 dotnet_style_prefer_conditional_expression_over_assignment = true:refactoring
 105 dotnet_style_prefer_conditional_expression_over_return = true:refactoring
 106 csharp_prefer_simple_default_expression = true:suggestion
 107
 108 # Expression-bodied members
 109 csharp_style_expression_bodied_methods = true:refactoring
 110 csharp_style_expression_bodied_constructors = true:refactoring
 111 csharp_style_expression_bodied_operators = true:refactoring
 112 csharp_style_expression_bodied_properties = true:refactoring
 113 csharp_style_expression_bodied_indexers = true:refactoring
 114 csharp_style_expression_bodied_accessors = true:refactoring
 115 csharp_style_expression_bodied_lambdas = true:refactoring
 116 csharp_style_expression_bodied_local_functions = true:refactoring
 117
 118 # Pattern matching
 119 csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
 120 csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
 121 csharp_style_inlined_variable_declaration = true:suggestion
 122
 123 # Null checking preferences
 124 csharp_style_throw_expression = true:suggestion
 125 csharp_style_conditional_delegate_call = true:suggestion
 126
 127 # Other features
 128 csharp_style_prefer_index_operator = false:none
 129 csharp_style_prefer_range_operator = false:none
 130 csharp_style_pattern_local_over_anonymous_function = false:none
 131
 132 # Space preferences
 133 csharp_space_after_cast = false
 134 csharp_space_after_colon_in_inheritance_clause = true
 135 csharp_space_after_comma = true
 136 csharp_space_after_dot = false
 137 csharp_space_after_keywords_in_control_flow_statements = true
 138 csharp_space_after_semicolon_in_for_statement = true
 139 csharp_space_around_binary_operators = before_and_after
 140 csharp_space_around_declaration_statements = do_not_ignore
 141 csharp_space_before_colon_in_inheritance_clause = true
 142 csharp_space_before_comma = false
 143 csharp_space_before_dot = false
 144 csharp_space_before_open_square_brackets = false
 145 csharp_space_before_semicolon_in_for_statement = false
 146 csharp_space_between_empty_square_brackets = false
 147 csharp_space_between_method_call_empty_parameter_list_parentheses = false
 148 csharp_space_between_method_call_name_and_opening_parenthesis = false
 149 csharp_space_between_method_call_parameter_list_parentheses = false
 150 csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
 151 csharp_space_between_method_declaration_name_and_open_parenthesis = false
 152 csharp_space_between_method_declaration_parameter_list_parentheses = false
 153 csharp_space_between_parentheses = false
 154 csharp_space_between_square_brackets = false
 155
 156 # Analyzers
 157 dotnet_code_quality.ca1802.api_surface = private, internal
 158
 159 # C++ Files
 160 [*.{cpp,h,in}]
 161 curly_bracket_next_line = true
 162 indent_brace_style = Allman
 163
 164 # Xml project files
 165 [*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}]
 166 indent_size = 2
 167
 168 # Xml build files
 169 [*.builds]
 170 indent_size = 2
 171
 172 # Xml files
 173 [*.{xml,stylecop,resx,ruleset}]
 174 indent_size = 2
 175
 176 # Xml config files
 177 [*.{props,targets,config,nuspec}]
 178 indent_size = 2
 179
 180 # Shell scripts
 181 [*.sh]
 182 end_of_line = lf
 183 [*.{cmd, bat}]
 184 end_of_line = crlf