Merge feature/addUserSwap into develop (#22)

- Add UserSwap
- Improve global code quality

Author: HandyS11

.editorconfig

@@ -0,0 +1,124 @@
+root=true
+
+[*]
+tab_width = 4
+indent_size = 4
+end_of_line = crlf
+
+[*.cs]
+
+# Default severity for all analyzer diagnostics
+dotnet_analyzer_diagnostic.severity = none
+csharp_prefer_simple_using_statement = true:suggestion
+csharp_prefer_braces = true:silent
+csharp_style_prefer_method_group_conversion = true:silent
+csharp_style_prefer_top_level_statements = true:silent
+csharp_style_prefer_primary_constructors = true:suggestion
+csharp_style_expression_bodied_methods = false:silent
+csharp_style_expression_bodied_constructors = false:silent
+csharp_style_expression_bodied_operators = false:silent
+csharp_style_expression_bodied_properties = true:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = false:silent
+csharp_indent_labels = one_less_than_current
+csharp_style_allow_embedded_statements_on_same_line_experimental = true:silent
+
+# Newline settings
+dotnet_diagnostic.IDE0055.severity = warning
+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
+
+# Namespace settings
+dotnet_diagnostic.IDE0160.severity = warning
+csharp_style_namespace_declarations = block_scoped
+
+# unused usings
+dotnet_diagnostic.IDE0005.severity = warning
+
+
+[*.{cs,vb}]
+# using directives
+dotnet_diagnostic.IDE0055.severity = warning
+dotnet_diagnostic.IDE0065.severity = warning
+csharp_using_directive_placement = outside_namespace
+dotnet_sort_system_directives_first = true
+dotnet_separate_import_directive_groups = false
+
+#### Naming styles ####
+
+# Naming rules
+
+dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
+dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
+dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
+
+dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.types_should_be_pascal_case.symbols = types
+dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
+dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
+
+# Symbol specifications
+
+dotnet_naming_symbols.interface.applicable_kinds = interface
+dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.interface.required_modifiers = 
+
+dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
+dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.types.required_modifiers = 
+
+dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
+dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.non_field_members.required_modifiers = 
+
+# Naming styles
+
+dotnet_naming_style.begins_with_i.required_prefix = I
+dotnet_naming_style.begins_with_i.required_suffix = 
+dotnet_naming_style.begins_with_i.word_separator = 
+dotnet_naming_style.begins_with_i.capitalization = pascal_case
+
+dotnet_naming_style.pascal_case.required_prefix = 
+dotnet_naming_style.pascal_case.required_suffix = 
+dotnet_naming_style.pascal_case.word_separator = 
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+
+dotnet_naming_style.pascal_case.required_prefix = 
+dotnet_naming_style.pascal_case.required_suffix = 
+dotnet_naming_style.pascal_case.word_separator = 
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_compound_assignment = true:suggestion
+dotnet_style_prefer_simplified_interpolation = true:suggestion
+dotnet_style_namespace_match_folder = true:suggestion
+dotnet_style_operator_placement_when_wrapping = beginning_of_line
+
+# Collections
+dotnet_diagnostic.IDE0028.severity = suggestion
+dotnet_style_prefer_collection_expression = true
+dotnet_style_collection_initializer = true
+
+# remove Migrations files from Analyzer
+[**/Migrations/*.cs]
+dotnet_diagnostic.IDE0005.severity = silent
+# doesn't work on VS Code apparently
+generated_code = true

RustPlusApi/Examples/GetTeamChatChanges/Program.cs

@@ -6,7 +6,7 @@
 
 var rustPlus = new RustPlus(Ip, Port, PlayerId, PlayerToken);
 
-rustPlus.OnTeamChatReceived += (sender, message) =>
+rustPlus.OnTeamChatReceived += (_, message) =>
 {
     Console.WriteLine($"Infos:\n{JsonConvert.SerializeObject(message, JsonSettings)}");
 };

RustPlusApi/Examples/SetSmartSwitchValue/Program.cs

@@ -6,7 +6,7 @@
 
 var rustPlus = new RustPlus(Ip, Port, PlayerId, PlayerToken);
 const uint smartSwitchId = 0;
-var smartSwitchValue = true;
+const bool smartSwitchValue = true;
 
 await rustPlus.ConnectAsync();
 

RustPlusApi/Examples/SetSubscription/Program.cs

@@ -6,7 +6,7 @@
 
 var rustPlus = new RustPlus(Ip, Port, PlayerId, PlayerToken);
 const uint smartSwitchId = 0;
-var smartSwitchValue = true;
+const bool smartSwitchValue = true;
 
 await rustPlus.ConnectAsync();
 

RustPlusApi/RustPlusApi.Fcm/Converters/BodyConverter.cs

@@ -15,7 +15,7 @@ public class BodyConverter : JsonConverter<Body>
 
         public override void WriteJson(JsonWriter writer, Body? value, JsonSerializer serializer)
         {
-            JObject jsonObject = JObject.FromObject(value!, serializer);
+            var jsonObject = JObject.FromObject(value!, serializer);
             jsonObject.WriteTo(writer);
         }
     }

RustPlusApi/RustPlusApi.Fcm/Data/FcmMessage.cs

@@ -1,6 +1,7 @@
 using Newtonsoft.Json;
 
 using RustPlusApi.Fcm.Converters;
+// ReSharper disable ClassNeverInstantiated.Global
 
 namespace RustPlusApi.Fcm.Data
 {

RustPlusApi/RustPlusApi.Fcm/Extensions/MessageDataToEventModel.cs

@@ -5,11 +5,11 @@ namespace RustPlusApi.Fcm.Extensions
 {
     public static class MessageDataToEventModel
     {
-        public static AlarmEvent ToAlarmEvent(this MessageData data, Guid notifId)
+        public static AlarmEvent ToAlarmEvent(this MessageData data, Guid notificationId)
         {
             return new AlarmEvent
             {
-                NotificationId = notifId,
+                NotificationId = notificationId,
                 Title = data.Title,
                 Message = data.Message
             };

RustPlusApi/RustPlusApi.Fcm/RustPlusApi.Fcm.csproj

@@ -5,7 +5,7 @@
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
 		<PackageId>RustPlusApi.Fcm</PackageId>
-		<Version>1.2.0</Version>
+		<Version>1.2.1</Version>
 		<Authors>HandyS11</Authors>
 		<Owners>HandyS11</Owners>
 		<Product>A Rust+ API websocket made in C#.</Product>

RustPlusApi/RustPlusApi.Fcm/RustPlusFcmListener.cs

@@ -51,17 +51,17 @@ protected override void ParseNotification(string? message)
             }
         }
 
-        private void ParsePairing(Guid notifId, Body body)
+        private void ParsePairing(Guid notificationId, Body body)
         {
             switch (body.Type)
             {
                 case "entity":
-                    var entity = BuildGenericOutput(notifId, body, body.ToEntityEvent());
+                    var entity = BuildGenericOutput(notificationId, body, body.ToEntityEvent());
                     OnEntityParing?.Invoke(this, entity);
-                    ParsePairingEntity(notifId, body);
+                    ParsePairingEntity(notificationId, body);
                     break;
                 case "server":
-                    var server = BuildGenericOutput(notifId, body, body.ToServerEvent());
+                    var server = BuildGenericOutput(notificationId, body, body.ToServerEvent());
                     OnServerPairing?.Invoke(this, server);
                     break;
                 default:
@@ -70,9 +70,9 @@ private void ParsePairing(Guid notifId, Body body)
             }
         }
 
-        private void ParsePairingEntity(Guid notifId, Body body)
+        private void ParsePairingEntity(Guid notificationId, Body body)
         {
-            var response = BuildGenericOutput(notifId, body, body.ToEntityId());
+            var response = BuildGenericOutput(notificationId, body, body.ToEntityId());
 
             switch (body.EntityType)
             {

RustPlusApi/RustPlusApi.Fcm/RustPlusFcmListenerClient.cs

@@ -33,7 +33,7 @@ public class RustPlusFcmListenerClient(Credentials credentials, ICollection<stri
         private SslStream? _sslStream;
 
         private readonly CancellationTokenSource _cancellationTokenSource = new();
-        private CancellationToken _cancellationToken => _cancellationTokenSource.Token;
+        private CancellationToken CancellationToken => _cancellationTokenSource.Token;
 
         public event EventHandler? Connecting;
         public event EventHandler? Connected;
@@ -51,7 +51,7 @@ public async Task ConnectAsync()
             Connecting?.Invoke(this, EventArgs.Empty);
 
             _tcpClient = new TcpClient();
-            await _tcpClient.ConnectAsync(Host, Port);
+            await _tcpClient.ConnectAsync(Host, Port, CancellationToken);
 
             _sslStream = new SslStream(_tcpClient.GetStream(), false);
             await _sslStream.AuthenticateAsClientAsync(Host);
@@ -81,7 +81,7 @@ public async Task ConnectAsync()
 
                 Connected?.Invoke(this, EventArgs.Empty);
 
-                _ = Task.Run(ReceiveMessages, _cancellationToken);
+                _ = Task.Run(ReceiveMessages, CancellationToken);
             }
             catch (Exception ex)
             {
@@ -124,20 +124,20 @@ private void ReceiveMessages()
             if (version < KMcsVersion && version != 38)
                 throw new InvalidOperationException($"Protocol version {version} unsupported");
 
-            var size = ReadVarint32();
+            var size = ReadVarInt32();
             var payload = Read(size);
             var type = BuildProtobufFromTag((McsProtoTag)tag);
 
             if (type != typeof(LoginResponse))
-                throw new Exception($"Got wrong login response. Expected {typeof(LoginResponse).Name}, got {type.Name}");
+                throw new Exception($"Got wrong login response. Expected {nameof(LoginResponse)}, got {type.Name}");
 
             OnGotMessageBytes(payload, type);
 
-            while (!_cancellationToken.IsCancellationRequested)
+            while (!CancellationToken.IsCancellationRequested)
             {
                 // Read the tag and size
                 tag = _sslStream!.ReadByte();
-                size = ReadVarint32();
+                size = ReadVarInt32();
                 payload = Read(size);
                 type = BuildProtobufFromTag((McsProtoTag)tag);
 
@@ -183,8 +183,8 @@ private void OnGotMessageBytes(byte[] data, Type type)
         /// <returns>An array of bytes read from the stream.</returns>
         private byte[] Read(int size)
         {
-            byte[] buffer = new byte[size];
-            int bytesRead = 0;
+            var buffer = new byte[size];
+            var bytesRead = 0;
             while (bytesRead < size)
             {
                 bytesRead += _sslStream!.Read(buffer, bytesRead, size - bytesRead);
@@ -196,13 +196,13 @@ private byte[] Read(int size)
         /// Reads a variable-length 32-bit integer from the SSL stream.
         /// </summary>
         /// <returns>The 32-bit integer read from the stream.</returns>
-        private int ReadVarint32()
+        private int ReadVarInt32()
         {
-            int result = 0;
-            int shift = 0;
+            var result = 0;
+            var shift = 0;
             while (true)
             {
-                byte b = (byte)_sslStream!.ReadByte();
+                var b = (byte)_sslStream!.ReadByte();
                 result |= (b & 0x7F) << shift;
                 if ((b & 0x80) == 0) break;
                 shift += 7;
@@ -222,8 +222,8 @@ private void SendPacket(object packet)
             using var ms = new MemoryStream();
             Serializer.Serialize(ms, packet);
 
-            byte[] payload = ms.ToArray();
-            _sslStream!.Write([.. header, .. EncodeVarint32(payload.Length), .. payload]);
+            var payload = ms.ToArray();
+            _sslStream!.Write([.. header, .. EncodeVarInt32(payload.Length), .. payload]);
         }
 
         /// <summary>