Skip to content

Commit 9ad9d3d

Browse files
authored
chore: copy .editorconfig under UTP adapter to apply C# coding standards rules (#1516)
1 parent a5ad2af commit 9ad9d3d

File tree

4 files changed

+109
-3
lines changed

4 files changed

+109
-3
lines changed
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
6+
[*.cs]
7+
# spacing rules
8+
end_of_line = lf
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
indent_style = space
12+
indent_size = 4
13+
14+
# formatting rules
15+
dotnet_diagnostic.IDE0001.severity = error # Simplify name
16+
dotnet_diagnostic.IDE0002.severity = error # Simplify member access
17+
dotnet_diagnostic.IDE0005.severity = error # Remove unnecessary import
18+
dotnet_diagnostic.IDE0063.severity = error # Use simple 'using' statement
19+
dotnet_style_qualification_for_field = false:error
20+
dotnet_style_qualification_for_property = false:error
21+
dotnet_style_qualification_for_method = false:error
22+
dotnet_style_qualification_for_event = false:error
23+
dotnet_style_predefined_type_for_locals_parameters_members = true:error
24+
dotnet_style_predefined_type_for_member_access = true:error
25+
dotnet_style_require_accessibility_modifiers = always:error
26+
csharp_style_var_when_type_is_apparent = true:error
27+
csharp_prefer_braces = true:error
28+
csharp_using_directive_placement = outside_namespace:error
29+
30+
# naming rules
31+
# namespace Unity.Netcode { ... }
32+
# public class NetworkObject { ... }
33+
# public void Spawn(...) { ... }
34+
dotnet_naming_symbols.usertypes_naming_symbols.applicable_kinds = namespace, class, struct, enum, property, method, field, event, delegate, local_function
35+
dotnet_naming_symbols.usertypes_naming_symbols.applicable_accessibilities = public, internal
36+
dotnet_naming_style.usertypes_naming_style.capitalization = pascal_case
37+
dotnet_naming_rule.usertypes_naming_rule.symbols = usertypes_naming_symbols
38+
dotnet_naming_rule.usertypes_naming_rule.style = usertypes_naming_style
39+
dotnet_naming_rule.usertypes_naming_rule.severity = error
40+
41+
# public void ChangeOwnership(ulong newOwnerClientId) { ... }
42+
# ulong[] targetClientIds = clientRpcParams.Send.TargetClientIds;
43+
dotnet_naming_symbols.paramlocal_naming_symbols.applicable_kinds = parameter, local
44+
dotnet_naming_symbols.paramlocal_naming_symbols.applicable_accessibilities = *
45+
dotnet_naming_style.paramlocal_naming_style.capitalization = camel_case
46+
dotnet_naming_rule.paramlocal_naming_rule.symbols = paramlocal_naming_symbols
47+
dotnet_naming_rule.paramlocal_naming_rule.style = paramlocal_naming_style
48+
dotnet_naming_rule.paramlocal_naming_rule.severity = error
49+
50+
# interface INetworkSerializable
51+
dotnet_naming_symbols.interface_naming_symbols.applicable_kinds = interface
52+
dotnet_naming_symbols.interface_naming_symbols.applicable_accessibilities = public, internal
53+
dotnet_naming_style.interface_naming_style.required_prefix = I
54+
dotnet_naming_style.interface_naming_style.capitalization = pascal_case
55+
dotnet_naming_rule.interface_naming_rule.symbols = interface_naming_symbols
56+
dotnet_naming_rule.interface_naming_rule.style = interface_naming_style
57+
dotnet_naming_rule.interface_naming_rule.severity = error
58+
59+
# class NetworkVariable<T>
60+
# class NetworkDictionary<TKey, TValue>
61+
dotnet_naming_symbols.typeparam_naming_symbols.applicable_kinds = type_parameter
62+
dotnet_naming_symbols.typeparam_naming_symbols.applicable_accessibilities = public, internal
63+
dotnet_naming_style.typeparam_naming_style.required_prefix = T
64+
dotnet_naming_style.typeparam_naming_style.capitalization = pascal_case
65+
dotnet_naming_rule.typeparam_naming_rule.symbols = typeparam_naming_symbols
66+
dotnet_naming_rule.typeparam_naming_rule.style = typeparam_naming_style
67+
dotnet_naming_rule.typeparam_naming_rule.severity = error
68+
69+
# const int k_MaxCount
70+
dotnet_naming_symbols.constant_naming_symbols.applicable_kinds = field
71+
dotnet_naming_symbols.constant_naming_symbols.applicable_accessibilities = private, protected, protected_internal, private_protected
72+
dotnet_naming_symbols.constant_naming_symbols.required_modifiers = const
73+
dotnet_naming_style.constant_naming_style.required_prefix = k_
74+
dotnet_naming_style.constant_naming_style.capitalization = pascal_case
75+
dotnet_naming_rule.constant_naming_rule.symbols = constant_naming_symbols
76+
dotnet_naming_rule.constant_naming_rule.style = constant_naming_style
77+
dotnet_naming_rule.constant_naming_rule.severity = error
78+
79+
# static readonly Vector3 k_DefaultLength
80+
dotnet_naming_symbols.staticreadonly_naming_symbols.applicable_kinds = field
81+
dotnet_naming_symbols.staticreadonly_naming_symbols.applicable_accessibilities = private, protected, protected_internal, private_protected
82+
dotnet_naming_symbols.staticreadonly_naming_symbols.required_modifiers = static, readonly
83+
dotnet_naming_style.staticreadonly_naming_style.required_prefix = k_
84+
dotnet_naming_style.staticreadonly_naming_style.capitalization = pascal_case
85+
dotnet_naming_rule.staticreadonly_naming_rule.symbols = staticreadonly_naming_symbols
86+
dotnet_naming_rule.staticreadonly_naming_rule.style = staticreadonly_naming_style
87+
dotnet_naming_rule.staticreadonly_naming_rule.severity = error
88+
89+
# static int s_SharedCount
90+
dotnet_naming_symbols.staticfield_naming_symbols.applicable_kinds = field
91+
dotnet_naming_symbols.staticfield_naming_symbols.applicable_accessibilities = private, protected, protected_internal, private_protected
92+
dotnet_naming_symbols.staticfield_naming_symbols.required_modifiers = static
93+
dotnet_naming_style.staticfield_naming_style.required_prefix = s_
94+
dotnet_naming_style.staticfield_naming_style.capitalization = pascal_case
95+
dotnet_naming_rule.staticfield_naming_rule.symbols = staticfield_naming_symbols
96+
dotnet_naming_rule.staticfield_naming_rule.style = staticfield_naming_style
97+
dotnet_naming_rule.staticfield_naming_rule.severity = error
98+
99+
# int m_CurrentCount
100+
dotnet_naming_symbols.memberfield_naming_symbols.applicable_kinds = field
101+
dotnet_naming_symbols.memberfield_naming_symbols.applicable_accessibilities = private, protected, protected_internal, private_protected
102+
dotnet_naming_style.memberfield_naming_style.required_prefix = m_
103+
dotnet_naming_style.memberfield_naming_style.capitalization = pascal_case
104+
dotnet_naming_rule.memberfield_naming_rule.symbols = memberfield_naming_symbols
105+
dotnet_naming_rule.memberfield_naming_rule.style = memberfield_naming_style
106+
dotnet_naming_rule.memberfield_naming_rule.severity = error

com.unity.netcode.adapter.utp/Runtime/NetworkMetricsPipelineStage.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ private static void InitializeConnection(byte* staticInstanceBuffer, int staticI
5858
}
5959
}
6060
}
61-
#endif
61+
#endif

com.unity.netcode.adapter.utp/Tests/Runtime/ConnectionTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,4 +282,4 @@ public IEnumerator RepeatedClientDisconnectsNoop()
282282
}
283283
}
284284
}
285-
#endif
285+
#endif

com.unity.netcode.adapter.utp/Tests/Runtime/TransportTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,4 +276,4 @@ public IEnumerator ReceiveMultipleClients()
276276
}
277277
}
278278
}
279-
#endif
279+
#endif

0 commit comments

Comments
 (0)