Skip to content

Commit ddd279d

Browse files
nxtnnxtn
authored
Add .editorconfig (#4473)
1 parent 6c7e964 commit ddd279d

File tree

1 file changed

+195
-0
lines changed

1 file changed

+195
-0
lines changed

‎samples/snippets/.editorconfig‎

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

0 commit comments

Comments
 (0)