Skip to content

Commit 02cfa7d

Browse files
authored
Merge pull request #4 from servicetitan/editor-config-file
Editor config file is added
2 parents 6af7e82 + 6eb46e6 commit 02cfa7d

2 files changed

Lines changed: 290 additions & 26 deletions

File tree

.editorconfig

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
1+
# Remove the line below if you want to inherit .editorconfig settings from higher directories
2+
# https://docs.microsoft.com/en-us/visualstudio/ide/create-portable-custom-editor-options?view=vs-2019#supported-settings
3+
root = true
4+
5+
[*]
6+
charset = utf-8
7+
max_line_length = 120
8+
9+
# Markdown Files
10+
[*.md]
11+
trim_trailing_whitespace = false
12+
13+
# C# files
14+
[*.cs]
15+
# Indentation options
16+
17+
indent_size = 2
18+
indent_style = space
19+
tab_width = 2
20+
21+
# New line preferences
22+
end_of_line = crlf
23+
insert_final_newline = false
24+
25+
#### .NET Coding Conventions ####
26+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#net-code-style-settings
27+
28+
# Organize usings
29+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-formatting-conventions?view=vs-2019#organize-using-directives
30+
dotnet_separate_import_directive_groups = false
31+
dotnet_sort_system_directives_first = true
32+
33+
# this. and Me. preferences
34+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#this-and-me
35+
dotnet_style_qualification_for_event = false:suggestion
36+
dotnet_style_qualification_for_field = false:suggestion
37+
dotnet_style_qualification_for_method = false:suggestion
38+
dotnet_style_qualification_for_property = false:suggestion
39+
40+
# Language keywords vs BCL types preferences
41+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#language-keywords
42+
dotnet_style_predefined_type_for_locals_parameters_members = true:warning
43+
dotnet_style_predefined_type_for_member_access = true:warning
44+
45+
# Parentheses preferences
46+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#parentheses-preferences
47+
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:suggestion
48+
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:suggestion
49+
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:suggestion
50+
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:suggestion
51+
52+
# Modifier preferences
53+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#normalize-modifiers
54+
dotnet_style_require_accessibility_modifiers = always:warning
55+
56+
# Expression-level preferences
57+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#expression-level-preferences
58+
dotnet_style_collection_initializer = true:suggestion
59+
dotnet_style_explicit_tuple_names = true:suggestion
60+
dotnet_style_object_initializer = true:suggestion
61+
dotnet_style_prefer_auto_properties = true:suggestion
62+
dotnet_style_prefer_compound_assignment = true:suggestion
63+
dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion
64+
dotnet_style_prefer_conditional_expression_over_return = true:suggestion
65+
dotnet_style_prefer_inferred_anonymous_type_member_names = false:suggestion
66+
dotnet_style_prefer_inferred_tuple_names = true:suggestion
67+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
68+
69+
# Null-checking preferences
70+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#null-checking-preferences
71+
dotnet_style_coalesce_expression = true:suggestion
72+
dotnet_style_null_propagation = true:suggestion
73+
74+
# Field preferences
75+
dotnet_style_readonly_field = true:warning
76+
77+
# Parameter preferences
78+
dotnet_code_quality_unused_parameters = all:warning
79+
80+
#### C# Coding Conventions ####
81+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#c-code-style-settings
82+
83+
# var preferences
84+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#implicit-and-explicit-types
85+
csharp_style_var_elsewhere = true:suggestion
86+
csharp_style_var_for_built_in_types = true:suggestion
87+
csharp_style_var_when_type_is_apparent = true:suggestion
88+
89+
# Expression-bodied members
90+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#expression-bodied-members
91+
csharp_style_expression_bodied_accessors = true:suggestion
92+
csharp_style_expression_bodied_constructors = false:warning
93+
csharp_style_expression_bodied_indexers = true:suggestion
94+
csharp_style_expression_bodied_lambdas = true:suggestion
95+
csharp_style_expression_bodied_local_functions = false:warning
96+
csharp_style_expression_bodied_methods = when_on_single_line:suggestion
97+
csharp_style_expression_bodied_operators = false:warning
98+
csharp_style_expression_bodied_properties = true:suggestion
99+
100+
# Pattern matching preferences
101+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#pattern-matching
102+
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
103+
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
104+
csharp_style_prefer_switch_expression = true:suggestion
105+
106+
# Null-checking preferences
107+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#c-null-checking-preferences
108+
csharp_style_conditional_delegate_call = true:suggestion
109+
110+
# Modifier preferences
111+
csharp_prefer_static_local_function = true:suggestion
112+
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:silent
113+
114+
# Code-block preferences
115+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#code-block-preferences
116+
csharp_prefer_braces = true:suggestion
117+
csharp_prefer_simple_using_statement = false:silent
118+
119+
# Expression-level preferences
120+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#c-expression-level-preferences
121+
csharp_prefer_simple_default_expression = true:suggestion
122+
csharp_style_deconstructed_variable_declaration = true:suggestion
123+
csharp_style_inlined_variable_declaration = true:suggestion
124+
csharp_style_pattern_local_over_anonymous_function = true:suggestion
125+
csharp_style_prefer_index_operator = true:suggestion
126+
csharp_style_prefer_range_operator = true:suggestion
127+
csharp_style_throw_expression = true:suggestion
128+
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
129+
csharp_style_unused_value_expression_statement_preference = discard_variable:warning
130+
131+
# 'using' directive preferences
132+
csharp_using_directive_placement = outside_namespace:warning
133+
134+
#### C# Formatting Rules ####
135+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-formatting-conventions?view=vs-2019#c-formatting-settings
136+
137+
# New line preferences
138+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-formatting-conventions?view=vs-2019#new-line-options
139+
csharp_new_line_before_catch = true
140+
csharp_new_line_before_else = true
141+
csharp_new_line_before_finally = true
142+
csharp_new_line_before_members_in_anonymous_types = true
143+
csharp_new_line_before_members_in_object_initializers = true
144+
csharp_new_line_before_open_brace = properties,types
145+
csharp_new_line_between_query_expression_clauses = true
146+
147+
# Indentation preferences
148+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-formatting-conventions?view=vs-2019#indentation-options
149+
csharp_indent_block_contents = true
150+
csharp_indent_braces = false
151+
csharp_indent_case_contents = true
152+
csharp_indent_case_contents_when_block = false
153+
csharp_indent_labels = one_less_than_current
154+
csharp_indent_switch_labels = true
155+
156+
# Space preferences
157+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-formatting-conventions?view=vs-2019#spacing-options
158+
csharp_space_after_cast = true
159+
csharp_space_after_colon_in_inheritance_clause = true
160+
csharp_space_after_comma = true
161+
csharp_space_after_dot = false
162+
csharp_space_after_keywords_in_control_flow_statements = true
163+
csharp_space_after_semicolon_in_for_statement = true
164+
csharp_space_around_binary_operators = before_and_after
165+
csharp_space_around_declaration_statements = false
166+
csharp_space_before_colon_in_inheritance_clause = true
167+
csharp_space_before_comma = false
168+
csharp_space_before_dot = false
169+
csharp_space_before_open_square_brackets = false
170+
csharp_space_before_semicolon_in_for_statement = false
171+
csharp_space_between_empty_square_brackets = false
172+
csharp_space_between_method_call_empty_parameter_list_parentheses = false
173+
csharp_space_between_method_call_name_and_opening_parenthesis = false
174+
csharp_space_between_method_call_parameter_list_parentheses = false
175+
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
176+
csharp_space_between_method_declaration_name_and_open_parenthesis = false
177+
csharp_space_between_method_declaration_parameter_list_parentheses = false
178+
csharp_space_between_parentheses = false
179+
csharp_space_between_square_brackets = false
180+
181+
# Wrapping preferences
182+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-formatting-conventions?view=vs-2019#wrap-options
183+
csharp_preserve_single_line_blocks = true
184+
csharp_preserve_single_line_statements = false
185+
186+
#### Naming styles ####
187+
188+
# Naming rules
189+
# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-naming-conventions?view=vs-2019
190+
191+
# Style Definitions
192+
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
193+
194+
dotnet_naming_style.camel_case_style.capitalization = camel_case
195+
196+
# capital_i_prefix_style - Interfaces must be prefixed with I and be pascal case
197+
dotnet_naming_style.capital_i_prefix_style.required_prefix = I
198+
dotnet_naming_style.capital_i_prefix_style.capitalization = pascal_case
199+
200+
# capital_t_prefix_style - Generic Type Parameters must be prefixed with T and be pascal case
201+
dotnet_naming_style.capital_t_prefix_style.required_prefix = T
202+
dotnet_naming_style.capital_t_prefix_style.capitalization = pascal_case
203+
204+
# Private static fields must be camelCase
205+
dotnet_naming_rule.private_naming.severity = warning
206+
dotnet_naming_rule.private_naming.symbols = private_static
207+
dotnet_naming_rule.private_naming.style = camel_case_style
208+
dotnet_naming_symbols.private_static.applicable_kinds = field
209+
dotnet_naming_symbols.private_static.applicable_accessibilities = private, static
210+
211+
# Use PascalCase for readonly static fields
212+
dotnet_naming_rule.readonly_fields_should_be_pascal_case.severity = suggestion
213+
dotnet_naming_rule.readonly_fields_should_be_pascal_case.symbols = readonly_fields
214+
dotnet_naming_rule.readonly_fields_should_be_pascal_case.style = pascal_case_style
215+
dotnet_naming_symbols.readonly_fields.applicable_kinds = field
216+
dotnet_naming_symbols.readonly_fields.applicable_accessibilities = *
217+
dotnet_naming_symbols.readonly_fields.required_modifiers = readonly, static
218+
219+
# Use PascalCase for constant fields
220+
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
221+
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
222+
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
223+
dotnet_naming_symbols.constant_fields.applicable_kinds = field
224+
dotnet_naming_symbols.constant_fields.required_modifiers = const
225+
dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
226+
227+
# Private fields must be camelCase
228+
dotnet_naming_rule.private_naming.severity = suggestion
229+
dotnet_naming_rule.private_naming.symbols = private
230+
dotnet_naming_rule.private_naming.style = camel_case_style
231+
dotnet_naming_symbols.private.applicable_kinds = field
232+
dotnet_naming_symbols.private.applicable_accessibilities = private
233+
234+
# Use PascalCase for public fields
235+
dotnet_naming_rule.pascal_case_for_public_fields.severity = warning
236+
dotnet_naming_rule.pascal_case_for_public_fields.symbols = public_fields
237+
dotnet_naming_rule.pascal_case_for_public_fields.style = pascal_case_style
238+
dotnet_naming_symbols.public_fields.applicable_kinds = field
239+
dotnet_naming_symbols.public_fields.applicable_accessibilities = public
240+
241+
# Classes, structs, methods, enums, events, properties, namespaces, delegates must be PascalCase
242+
dotnet_naming_rule.general_naming.severity = warning
243+
dotnet_naming_rule.general_naming.symbols = general
244+
dotnet_naming_rule.general_naming.style = pascal_case_style
245+
dotnet_naming_symbols.general.applicable_kinds = class,struct,enum,property,method,event,namespace,delegate
246+
dotnet_naming_symbols.general.applicable_accessibilities = *
247+
248+
# Interfaces must be PascalCase and have an I prefix
249+
dotnet_naming_rule.interfaces_start_with_I.severity = warning
250+
dotnet_naming_rule.interfaces_start_with_I.symbols = any_interface
251+
dotnet_naming_rule.interfaces_start_with_I.style = capital_i_prefix_style
252+
dotnet_naming_symbols.any_interface.applicable_kinds = interface
253+
dotnet_naming_symbols.any_interface.applicable_accessibilities = *
254+
255+
# Generics Type Parameters use PascalCase and are prefixed with uppercase 'T'
256+
dotnet_naming_symbols.type_parameter_group.applicable_kinds = type_parameter
257+
dotnet_naming_rule.type_parameter_rule.symbols = type_parameter_group
258+
dotnet_naming_rule.type_parameter_rule.style = capital_t_prefix_style
259+
dotnet_naming_rule.type_parameter_rule.severity = warning

0 commit comments

Comments
 (0)