forked from microsoft/BuildXL
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.editorconfig
217 lines (166 loc) · 13.4 KB
/
.editorconfig
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# top-most EditorConfig file
root = true
[*]
end_of_line = crlf
insert_final_newline = false
indent_style = space
indent_size = 4
[*.cs]
#######################################################################################
# C# code style settings #
#######################################################################################
# Sort using and Import directives with System.* appearing first
dotnet_sort_system_directives_first = true
# Avoid "this." and "Me." if not necessary
dotnet_style_qualification_for_field = false : warning
dotnet_style_qualification_for_property = false : warning
dotnet_style_qualification_for_method = false : warning
dotnet_style_qualification_for_event = false : warning
# Use language keywords instead of framework type names for type references: i.e. prefer 'int' over 'Int32'
dotnet_style_predefined_type_for_locals_parameters_members = true : warning
dotnet_style_predefined_type_for_member_access = true : warning
# Prefer `int.MaxValue` over `Int32.MaxValue`
dotnet_style_predefined_type_for_member_access = true : warning
# Prefer `private const string foo` over `const string foo`
dotnet_style_require_accessibility_modifiers = for_non_interface_members : warning
# Prefer modifier order
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
# Suggest more modern language features when available
# Prefer object initializers (e.g. `new Foo() { Bar = 42 };`) over property assignment (e.g. `var f = new Foo(); f.Bar = 42;`)
dotnet_style_object_initializer = true : suggestion
# Prefer collection initializers (e.g. new List<int>{1,2,3})
dotnet_style_collection_initializer = true : suggestion
# Prefer null coalescing (e.g. `x ?? y`) over ternary null checking (e.g. `x != null ? x:y`)
dotnet_style_coalesce_expression = true : suggestion
# Prefer null propagation (e.g. `x?.Foo`) over ternary null checking (e.g. `x != null ? x.Foo:null`)
dotnet_style_null_propagation = true : suggestion
# Prefer tuple names over ItemN properties
dotnet_style_explicit_tuple_names = true : suggestion
# Prefer inferred anonymous type member names (e.g. `var anon = new { age, name };`)
dotnet_style_prefer_inferred_anonymous_type_member_names = true : suggestion
# Prefer `var` type in declarations for built-in system types like `int`
csharp_style_var_for_built_in_types = true : suggestion
# Prefer `var` type in declarations when the type is explicitly mentioned on the RHS (e.g. `var customer = new Customer();`)
csharp_style_var_when_type_is_apparent = true : suggestion
# Prefer `var` type in declarations in all other cases
csharp_style_var_elsewhere = true : suggestion
# Prefer expression-bodied members for methods when they will be a single line (e.g. `public int GetAge() => this.Age;`)
csharp_style_expression_bodied_methods = when_on_single_line : suggestion
# Prefer expression-bodied members for constructors when they will be a single line (e.g. `public int GetAge() => this.Age;`)
csharp_style_expression_bodied_constructors = when_on_single_line : suggestion
# Prefer expression-bodied members for operators when they will be a single line (e.g. `public int GetAge() => this.Age;`)
csharp_style_expression_bodied_operators = when_on_single_line : suggestion
# Prefer expression-bodied members for properties when they will be a single line (e.g. `public int GetAge() => this.Age;`)
csharp_style_expression_bodied_properties = true : suggestion
# Prefer expression-bodied members for indexers when they will be a single line (e.g. `public int GetAge() => this.Age;`)
csharp_style_expression_bodied_indexers = true : suggestion
# Prefer expression-bodied members for accessors when they will be a single line (e.g. `public int GetAge() => this.Age;`)
csharp_style_expression_bodied_accessors = true : suggestion
# Prefer pattern matching instead of `is` expressions with type casts
csharp_style_pattern_matching_over_is_with_cast_check = true : suggestion
# Prefer pattern matching instead of `as` expressions with null checks to determine if something is of a particular type
csharp_style_pattern_matching_over_as_with_null_check = true : suggestion
# Prefer `out` variables to be declared inline in the argument list of a method call when possible
csharp_style_inlined_variable_declaration = true : suggestion
# Prefer `default` over `default(T)`
csharp_prefer_simple_default_expression = true : suggestion
# Prefer deconstructed variable declaration
csharp_style_deconstructed_variable_declaration = true : suggestion
# Prefer local functions over anonymous functions
csharp_style_pattern_local_over_anonymous_function = true : suggestion
# TODO: Change to suggestion after switching to C# 7.2
# Prefer to use `throw` expressions instead of `throw` statements
csharp_style_throw_expression = false : suggestion
# Prefer MyEvent?.Invoke(); over `var d = MyEvnet; if (d != null) {d();}`
csharp_style_conditional_delegate_call = true : warning
# Prefer curly braces even for one line of code
csharp_prefer_braces = true : warning
# Prefer foo[42] = 1; over foo[ 42 ] = 1;
csharp_space_between_square_brackets = false : warning
# Do not prefer if (x) DoSomething()
csharp_preserve_single_line_statements = false : warning
# Prefer { DoSomething(); }
csharp_preserve_single_line_blocks = true : suggestion
# Prefer var foo = new[] {1, 2, 3} over new[] {1,2,3};
csharp_space_after_comma = true : suggestion
#######################################################################################
# Formatting #
#######################################################################################
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
csharp_indent_case_contents = true
csharp_indent_switch_labels = true
csharp_indent_labels = flush_left
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
#######################################################################################
# Naming Conventions #
#######################################################################################
# Non-private static fields are PascalCase
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = warning
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style
dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field
dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected internal, private protected
dotnet_naming_symbols.non_private_static_fields.required_modifiers = static
dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case
# Constants are PascalCase
dotnet_naming_rule.constants_should_be_pascal_case.severity = warning
dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants
dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style
dotnet_naming_symbols.constants.applicable_kinds = field, local
dotnet_naming_symbols.constants.required_modifiers = const
dotnet_naming_style.constant_style.capitalization = pascal_case
# Static fields are camelCase and start with s_
dotnet_naming_rule.static_fields_should_be_camel_case.severity = warning
dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields
dotnet_naming_rule.static_fields_should_be_camel_case.style = static_field_style
dotnet_naming_symbols.static_fields.applicable_kinds = field
dotnet_naming_symbols.static_fields.required_modifiers = static
# The rule should be enforced only for private fields
dotnet_naming_symbols.static_fields.applicable_accessibilities = private
dotnet_naming_style.static_field_style.capitalization = camel_case
dotnet_naming_style.static_field_style.required_prefix = s_
# Async methods should have 'Async' suffix
dotnet_naming_rule.async_methods_should_have_async_suffix.severity = warning
dotnet_naming_rule.async_methods_should_have_async_suffix.symbols = async_methods
dotnet_naming_rule.async_methods_should_have_async_suffix.style = async_methods_style
dotnet_naming_symbols.async_methods.applicable_kinds = method
dotnet_naming_symbols.async_methods.required_modifiers = async
dotnet_naming_style.async_methods_style.capitalization = pascal_case
dotnet_naming_style.async_methods_style.required_suffix = Async
# Instance fields are camelCase and start with m_
dotnet_naming_rule.instance_fields_should_be_camel_case.severity = warning
dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields
dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style
dotnet_naming_symbols.instance_fields.applicable_kinds = field
# The rule should be enforced only for private fields
dotnet_naming_symbols.instance_fields.applicable_accessibilities = private
dotnet_naming_style.instance_field_style.capitalization = camel_case
dotnet_naming_style.instance_field_style.required_prefix = m_
# Locals and parameters are camelCase
dotnet_naming_rule.locals_should_be_camel_case.severity = warning
dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters
dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style
dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local
dotnet_naming_style.camel_case_style.capitalization = camel_case
# Local functions are cascalCase
# TODO: I don't think that local functions are supported as part of applicable_kinds.
# dotnet_naming_rule.local_functions_should_be_camel_case.severity = warning
# dotnet_naming_rule.local_functions_should_be_camel_case.symbols = local_functions
# dotnet_naming_rule.local_functions_should_be_camel_case.style = local_function_style
# dotnet_naming_symbols.local_functions.applicable_kinds = local_functions
# dotnet_naming_style.local_function_style.capitalization = camel_case
# By default, name items with PascalCase
dotnet_naming_rule.members_should_be_pascal_case.severity = warning
dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members
dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style
dotnet_naming_symbols.all_members.applicable_kinds = *
dotnet_naming_style.pascal_case_style.capitalization = pascal_case