Skip to content

Commit bbe617e

Browse files
russcamstevejgordon
authored andcommitted
Update editor config naming rules (#5723)
Relates: elastic/apm-agent-dotnet#1295 (cherry picked from commit d5bb92e)
1 parent 66e947d commit bbe617e

File tree

1 file changed

+101
-11
lines changed

1 file changed

+101
-11
lines changed

.editorconfig

Lines changed: 101 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ indent_size = 4
1313
indent_style = tab
1414
indent_size = 4
1515

16-
[*.{fs,fsx}]
16+
[*.{fs,fsx,yml}]
1717
indent_style = space
1818
indent_size = 4
1919

20-
[*.{md,markdown,json,js,csproj,fsproj,targets,targets,props,yml}]
20+
[*.{md,markdown,json,js,csproj,fsproj,targets,targets,props}]
2121
indent_style = space
2222
indent_size = 2
2323

@@ -30,11 +30,86 @@ indent_size = 2
3030
# ---
3131

3232
# ---
33-
# langugage conventions https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#language-conventions
33+
# language conventions https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#language-conventions
3434

3535
# Sort using and Import directives with System.* appearing first
3636
dotnet_sort_system_directives_first = true
3737

38+
# Style rules
39+
# https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/naming-rules?view=vs-2017
40+
41+
# Constants always pascal case
42+
dotnet_naming_rule.constants_should_be_pascal_case.symbols = consts
43+
dotnet_naming_rule.constants_should_be_pascal_case.style = consts
44+
dotnet_naming_rule.constants_should_be_pascal_case.severity = suggestion
45+
46+
dotnet_naming_symbols.consts.applicable_kinds = field
47+
dotnet_naming_symbols.consts.applicable_accessibilities = *
48+
dotnet_naming_symbols.consts.required_modifiers = const
49+
50+
dotnet_naming_style.consts.capitalization = pascal_case
51+
52+
# Non-public static fields always pascal case
53+
dotnet_naming_rule.non_public_static_fields_should_be_pascal_case.symbols = non_public_static_fields
54+
dotnet_naming_rule.non_public_static_fields_should_be_pascal_case.style = non_public_static_fields
55+
dotnet_naming_rule.non_public_static_fields_should_be_pascal_case.severity = suggestion
56+
57+
dotnet_naming_symbols.non_public_static_fields.applicable_kinds = field
58+
dotnet_naming_symbols.non_public_static_fields.applicable_accessibilities = private,protected,internal,protected_internal,private_protected
59+
dotnet_naming_symbols.non_public_static_fields.required_modifiers = static
60+
61+
dotnet_naming_style.non_public_static_fields.capitalization = pascal_case
62+
63+
# Non-private readonly fields are pascal case
64+
dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.severity = suggestion
65+
dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.symbols = non_private_readonly_fields
66+
dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.style = non_private_readonly_fields
67+
68+
dotnet_naming_symbols.non_private_readonly_fields.applicable_kinds = field
69+
dotnet_naming_symbols.non_private_readonly_fields.applicable_accessibilities = public,protected,internal,protected_internal,private_protected
70+
dotnet_naming_symbols.non_private_readonly_fields.required_modifiers = readonly
71+
72+
dotnet_naming_style.non_private_readonly_fields.capitalization = pascal_case
73+
74+
# Private instance fields are camel case prefixed underscore
75+
dotnet_naming_rule.private_fields_should_be_camelcase_prefix_underscore.symbols = private_fields
76+
dotnet_naming_rule.private_fields_should_be_camelcase_prefix_underscore.style = private_fields
77+
dotnet_naming_rule.private_fields_should_be_camelcase_prefix_underscore.severity = suggestion
78+
79+
dotnet_naming_symbols.private_fields.applicable_kinds = field
80+
dotnet_naming_symbols.private_fields.applicable_accessibilities = private
81+
82+
dotnet_naming_style.private_fields.capitalization = camel_case
83+
dotnet_naming_style.private_fields.required_prefix = _
84+
85+
# Locals and parameters are camel case
86+
dotnet_naming_rule.locals.severity = suggestion
87+
dotnet_naming_rule.locals.symbols = locals
88+
dotnet_naming_rule.locals.style = locals
89+
90+
dotnet_naming_symbols.locals.applicable_kinds = parameter, local
91+
92+
dotnet_naming_style.locals.capitalization = camel_case
93+
94+
# Local functions are pascal case
95+
dotnet_naming_rule.local_functions.severity = suggestion
96+
dotnet_naming_rule.local_functions.symbols = local_functions
97+
dotnet_naming_rule.local_functions.style = local_functions
98+
99+
dotnet_naming_symbols.local_functions.applicable_kinds = local_function
100+
101+
dotnet_naming_style.local_functions.capitalization = pascal_case
102+
103+
# Public members always pascal case
104+
dotnet_naming_rule.public_members_should_be_pascal_case.symbols = public_members
105+
dotnet_naming_rule.public_members_should_be_pascal_case.style = public_members
106+
dotnet_naming_rule.public_members_should_be_pascal_case.severity = suggestion
107+
108+
dotnet_naming_symbols.public_members.applicable_kinds = property,method,field,event,delegate
109+
dotnet_naming_symbols.public_members.applicable_accessibilities = public
110+
111+
dotnet_naming_style.public_members.capitalization = pascal_case
112+
38113
dotnet_style_qualification_for_field = false:error
39114
dotnet_style_qualification_for_property = false:error
40115
dotnet_style_qualification_for_method = false:error
@@ -83,7 +158,7 @@ csharp_prefer_braces = false:warning
83158
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:error
84159

85160
# ---
86-
# formatting conventions https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-formatting-conventions
161+
# formatting conventions https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#formatting-conventions
87162

88163
# Newline settings (Allman yo!)
89164
csharp_new_line_before_open_brace = all
@@ -109,15 +184,30 @@ csharp_preserve_single_line_statements = false
109184
csharp_preserve_single_line_blocks = true
110185

111186
# Resharper
112-
resharper_csharp_braces_for_lock=required_for_complex
113-
resharper_csharp_braces_for_using=required_for_complex
114-
resharper_csharp_braces_for_while=required_for_complex
115-
resharper_csharp_braces_for_foreach=required_for_complex
116-
resharper_csharp_braces_for_for=required_for_complex
117-
resharper_csharp_braces_for_fixed=required_for_complex
118-
resharper_csharp_braces_for_ifelse=required_for_complex
187+
resharper_csharp_braces_for_lock=required_for_multiline
188+
resharper_csharp_braces_for_using=required_for_multiline
189+
resharper_csharp_braces_for_while=required_for_multiline
190+
resharper_csharp_braces_for_foreach=required_for_multiline
191+
resharper_csharp_braces_for_for=required_for_multiline
192+
resharper_csharp_braces_for_fixed=required_for_multiline
193+
resharper_csharp_braces_for_ifelse=required_for_multiline
119194

120195
resharper_csharp_accessor_owner_body=expression_body
121196

122197
resharper_redundant_case_label_highlighting=do_not_show
123198
resharper_redundant_argument_default_value_highlighting=do_not_show
199+
200+
[Jenkinsfile]
201+
indent_style = space
202+
indent_size = 2
203+
end_of_line = lf
204+
charset = utf-8
205+
trim_trailing_whitespace = true
206+
insert_final_newline = true
207+
208+
[*.{sh,bat,ps1}]
209+
trim_trailing_whitespace=true
210+
insert_final_newline=true
211+
212+
[*.sh]
213+
end_of_line = lf

0 commit comments

Comments
 (0)