|
| 1 | +; see http://editorconfig.org/ for docs on this file |
| 2 | + |
| 3 | +root = true |
| 4 | + |
| 5 | +[*] |
| 6 | +ignore_if_in_header = This code was generated by a tool|<auto-generated> |
| 7 | +indent_style = space |
| 8 | +indent_size = 4 |
| 9 | +; uncomment to help with sharing files across os's (i.e. network share or through local vm) |
| 10 | +#end_of_line = lf |
| 11 | +; avoid a bom, which causes endless problems with naive text tooling |
| 12 | +charset = utf-8 |
| 13 | +trim_trailing_whitespace = true |
| 14 | +insert_final_newline = true |
| 15 | +; keeping auto-format enabled helps avoid merge hell for projects without CI-based format validation |
| 16 | +#disable_auto_format = true |
| 17 | + |
| 18 | +[*.cs] |
| 19 | +; uncomment to enable full formatting of c# files |
| 20 | +formatters = generic, uncrustify |
| 21 | + |
| 22 | +[*.asmdef] |
| 23 | +scrape_api = true |
| 24 | + |
| 25 | +[**/Tests/**.asmdef] |
| 26 | +scrape_api = false |
| 27 | + |
| 28 | +[*.Tests.asmdef] |
| 29 | +scrape_api = false |
| 30 | + |
| 31 | +[*.md] |
| 32 | +indent_size = 2 |
| 33 | +; trailing whitespace is unfortunately significant in markdown |
| 34 | +trim_trailing_whitespace = false |
| 35 | +; uncomment to enable basic formatting of markdown files |
| 36 | +#formatters = generic |
| 37 | + |
| 38 | +[{Makefile,makefile}] |
| 39 | +; tab characters are part of the Makefile format |
| 40 | +indent_style = tab |
| 41 | + |
| 42 | +[*.asmdef] |
| 43 | +indent_size = 4 |
| 44 | + |
| 45 | +[*.json] |
| 46 | +indent_size = 2 |
| 47 | + |
| 48 | +[*.{vcproj,bat,cmd,xaml,tt,t4,ttinclude}] |
| 49 | +end_of_line = crlf |
| 50 | + |
| 51 | +; this VS-specific stuff is based on experiments to see how VS will modify a file after it has been manually edited. |
| 52 | +; the settings are meant to closely match what VS does to minimize unnecessary diffs. |
| 53 | +[*.{vcxproj,vcxproj.filters}] |
| 54 | +indent_style = space |
| 55 | +indent_size = 2 |
| 56 | +end_of_line = crlf |
| 57 | +charset = utf-8-bom |
| 58 | +trim_trailing_whitespace = true |
| 59 | +insert_final_newline = false |
| 60 | +; must be broken out because of 51-char bug (https://github.com/editorconfig/editorconfig-visualstudio/issues/21) |
| 61 | +[*.{csproj,pyproj,props,targets}] |
| 62 | +indent_style = space |
| 63 | +indent_size = 2 |
| 64 | +end_of_line = crlf |
| 65 | +charset = utf-8-bom |
| 66 | +trim_trailing_whitespace = true |
| 67 | +insert_final_newline = false |
| 68 | +[*.{sln,sln.template}] |
| 69 | +indent_style = tab |
| 70 | +indent_size = 4 |
| 71 | +end_of_line = crlf |
| 72 | +charset = utf-8 |
| 73 | +trim_trailing_whitespace = true |
| 74 | +insert_final_newline = false |
| 75 | + |
| 76 | +#### naming styles #### |
| 77 | + |
| 78 | +# naming rules |
| 79 | +[*.cs] |
| 80 | +dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion |
| 81 | +dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface |
| 82 | +dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i |
| 83 | + |
| 84 | +dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion |
| 85 | +dotnet_naming_rule.types_should_be_pascal_case.symbols = types |
| 86 | +dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case |
| 87 | + |
| 88 | +dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion |
| 89 | +dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members |
| 90 | +dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case |
| 91 | + |
| 92 | +dotnet_naming_rule.method_should_be_pascal_case.severity = suggestion |
| 93 | +dotnet_naming_rule.method_should_be_pascal_case.symbols = method |
| 94 | +dotnet_naming_rule.method_should_be_pascal_case.style = pascal_case |
| 95 | + |
| 96 | +dotnet_naming_rule.private_or_internal_field_should_be_begins_with_m_.severity = suggestion |
| 97 | +dotnet_naming_rule.private_or_internal_field_should_be_begins_with_m_.symbols = private_or_internal_field |
| 98 | +dotnet_naming_rule.private_or_internal_field_should_be_begins_with_m_.style = begins_with_m_ |
| 99 | + |
| 100 | +dotnet_naming_rule.private_or_internal_static_field_should_be_begins_with_s_.severity = suggestion |
| 101 | +dotnet_naming_rule.private_or_internal_static_field_should_be_begins_with_s_.symbols = private_or_internal_static_field |
| 102 | +dotnet_naming_rule.private_or_internal_static_field_should_be_begins_with_s_.style = begins_with_s_ |
| 103 | + |
| 104 | +dotnet_naming_rule.non_public_const_fields_should_be_begins_with_k_.severity = suggestion |
| 105 | +dotnet_naming_rule.non_public_const_fields_should_be_begins_with_k_.symbols = non_public_const_fields |
| 106 | +dotnet_naming_rule.non_public_const_fields_should_be_begins_with_k_.style = begins_with_k_ |
| 107 | + |
| 108 | +dotnet_naming_rule.non_public_static_readonly_fields_should_be_begins_with_k_.severity = suggestion |
| 109 | +dotnet_naming_rule.non_public_static_readonly_fields_should_be_begins_with_k_.symbols = non_public_static_readonly_fields |
| 110 | +dotnet_naming_rule.non_public_static_readonly_fields_should_be_begins_with_k_.style = begins_with_k_ |
| 111 | + |
| 112 | +dotnet_naming_rule.event_should_be_camel_case.severity = suggestion |
| 113 | +dotnet_naming_rule.event_should_be_camel_case.symbols = event |
| 114 | +dotnet_naming_rule.event_should_be_camel_case.style = camel_case |
| 115 | + |
| 116 | +dotnet_naming_rule.method_parameters_should_be_camel_case.severity = suggestion |
| 117 | +dotnet_naming_rule.method_parameters_should_be_camel_case.symbols = method_parameters |
| 118 | +dotnet_naming_rule.method_parameters_should_be_camel_case.style = camel_case |
| 119 | + |
| 120 | +dotnet_naming_rule.local_should_be_camel_case.severity = suggestion |
| 121 | +dotnet_naming_rule.local_should_be_camel_case.symbols = local |
| 122 | +dotnet_naming_rule.local_should_be_camel_case.style = camel_case |
| 123 | + |
| 124 | +# symbol specifications |
| 125 | + |
| 126 | +dotnet_naming_symbols.interface.applicable_kinds = interface |
| 127 | +dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected |
| 128 | +dotnet_naming_symbols.interface.required_modifiers = |
| 129 | + |
| 130 | +dotnet_naming_symbols.event.applicable_kinds = event |
| 131 | +dotnet_naming_symbols.event.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected |
| 132 | +dotnet_naming_symbols.event.required_modifiers = |
| 133 | + |
| 134 | +dotnet_naming_symbols.method.applicable_kinds = method |
| 135 | +dotnet_naming_symbols.method.applicable_accessibilities = public |
| 136 | +dotnet_naming_symbols.method.required_modifiers = |
| 137 | + |
| 138 | +dotnet_naming_symbols.private_or_internal_field.applicable_kinds = field |
| 139 | +dotnet_naming_symbols.private_or_internal_field.applicable_accessibilities = internal, private, private_protected |
| 140 | +dotnet_naming_symbols.private_or_internal_field.required_modifiers = |
| 141 | + |
| 142 | +dotnet_naming_symbols.private_or_internal_static_field.applicable_kinds = field |
| 143 | +dotnet_naming_symbols.private_or_internal_static_field.applicable_accessibilities = internal, private, private_protected |
| 144 | +dotnet_naming_symbols.private_or_internal_static_field.required_modifiers = static |
| 145 | + |
| 146 | +dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum |
| 147 | +dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected |
| 148 | +dotnet_naming_symbols.types.required_modifiers = |
| 149 | + |
| 150 | +dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method |
| 151 | +dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected |
| 152 | +dotnet_naming_symbols.non_field_members.required_modifiers = |
| 153 | + |
| 154 | +dotnet_naming_symbols.non_public_const_fields.applicable_kinds = field |
| 155 | +dotnet_naming_symbols.non_public_const_fields.applicable_accessibilities = internal, private, protected, protected_internal, private_protected |
| 156 | +dotnet_naming_symbols.non_public_const_fields.required_modifiers = const |
| 157 | + |
| 158 | +dotnet_naming_symbols.non_public_static_readonly_fields.applicable_kinds = field |
| 159 | +dotnet_naming_symbols.non_public_static_readonly_fields.applicable_accessibilities = private, protected, protected_internal, private_protected |
| 160 | +dotnet_naming_symbols.non_public_static_readonly_fields.required_modifiers = readonly, static |
| 161 | + |
| 162 | +dotnet_naming_symbols.method_parameters.applicable_kinds = parameter |
| 163 | +dotnet_naming_symbols.method_parameters.applicable_accessibilities = |
| 164 | +dotnet_naming_symbols.method_parameters.required_modifiers = |
| 165 | + |
| 166 | +dotnet_naming_symbols.local.applicable_kinds = local |
| 167 | +dotnet_naming_symbols.local.applicable_accessibilities = local |
| 168 | +dotnet_naming_symbols.local.required_modifiers = |
| 169 | + |
| 170 | +# naming styles |
| 171 | + |
| 172 | +dotnet_naming_style.pascal_case.required_prefix = |
| 173 | +dotnet_naming_style.pascal_case.required_suffix = |
| 174 | +dotnet_naming_style.pascal_case.word_separator = |
| 175 | +dotnet_naming_style.pascal_case.capitalization = pascal_case |
| 176 | + |
| 177 | +dotnet_naming_style.begins_with_i.required_prefix = I |
| 178 | +dotnet_naming_style.begins_with_i.required_suffix = |
| 179 | +dotnet_naming_style.begins_with_i.word_separator = |
| 180 | +dotnet_naming_style.begins_with_i.capitalization = pascal_case |
| 181 | + |
| 182 | +dotnet_naming_style.begins_with_m_.required_prefix = m_ |
| 183 | +dotnet_naming_style.begins_with_m_.required_suffix = |
| 184 | +dotnet_naming_style.begins_with_m_.word_separator = |
| 185 | +dotnet_naming_style.begins_with_m_.capitalization = pascal_case |
| 186 | + |
| 187 | +dotnet_naming_style.begins_with_s_.required_prefix = s_ |
| 188 | +dotnet_naming_style.begins_with_s_.required_suffix = |
| 189 | +dotnet_naming_style.begins_with_s_.word_separator = |
| 190 | +dotnet_naming_style.begins_with_s_.capitalization = pascal_case |
| 191 | + |
| 192 | +dotnet_naming_style.begins_with_k_.required_prefix = k_ |
| 193 | +dotnet_naming_style.begins_with_k_.required_suffix = |
| 194 | +dotnet_naming_style.begins_with_k_.word_separator = |
| 195 | +dotnet_naming_style.begins_with_k_.capitalization = pascal_case |
| 196 | + |
| 197 | +dotnet_naming_style.camel_case.required_prefix = |
| 198 | +dotnet_naming_style.camel_case.required_suffix = |
| 199 | +dotnet_naming_style.camel_case.word_separator = |
| 200 | +dotnet_naming_style.camel_case.capitalization = camel_case |
0 commit comments