Fixes spelling errors in comments, private members, and public members in test projects

Author: jacobslusser

.editorconfig

@@ -1,4 +1,4 @@
-// Avoid looking for .editorconfig files in parent directories
+# Avoid looking for .editorconfig files in parent directories
 root=true
 
 [*]
@@ -7,6 +7,8 @@ insert_final_newline = true
 indent_style = space
 indent_size = 4
 tab_width = 4
+spelling_exclusion_path = exclusion.dic
+spelling_checkable_types = all
 
 [*.{xml,csproj,props}]
 
@@ -776,14 +778,14 @@ dotnet_diagnostic.IDE0032.severity = suggestion
 dotnet_diagnostic.IDE0045.severity = none
 
 # IDE0046: Use conditional expression for return
-# 
+#
 # Using a conditional expression is not always a clear win for readability.
 #
 # Configured using 'dotnet_style_prefer_conditional_expression_over_return'
 dotnet_diagnostic.IDE0046.severity = suggestion
 
 # IDE0047: Remove unnecessary parentheses
-# 
+#
 # Removing "unnecessary" parentheses is not always a clear win for readability.
 dotnet_diagnostic.IDE0047.severity = suggestion
 
@@ -794,7 +796,7 @@ dotnet_diagnostic.IDE0047.severity = suggestion
 dotnet_diagnostic.IDE0130.severity = none
 
 # IDE0270: Null check can be simplified
-# 
+#
 # var inputPath = originalDossierPathList.Find(x => x.id == updatedPath.id);
 # if (inputPath is null)
 # {
@@ -938,7 +940,7 @@ csharp_new_line_before_catch = true
 csharp_new_line_before_finally = true
 # Enabling this setting breaks Resharper formatting for an enum field reference that is
 # deeply nested in an object initializer.
-# 
+#
 # For an example, see TDataExchangeGeneralEnricher_CernInfrastructureObstruction.
 #csharp_new_line_before_members_in_object_initializers = true
 csharp_new_line_before_members_in_anonymous_types = true
@@ -1021,19 +1023,19 @@ dotnet_naming_rule.private_const_fields_pascal_case.severity = warning
 
 dotnet_naming_symbols.interface.applicable_kinds = interface
 dotnet_naming_symbols.interface.applicable_accessibilities = *
-dotnet_naming_symbols.interface.required_modifiers = 
+dotnet_naming_symbols.interface.required_modifiers =
 
 dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
 dotnet_naming_symbols.types.applicable_accessibilities = *
-dotnet_naming_symbols.types.required_modifiers = 
+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 = *
-dotnet_naming_symbols.non_field_members.required_modifiers = 
+dotnet_naming_symbols.non_field_members.required_modifiers =
 
 dotnet_naming_symbols.private_fields.applicable_kinds = field
 dotnet_naming_symbols.private_fields.applicable_accessibilities = private
-dotnet_naming_symbols.private_fields.required_modifiers = 
+dotnet_naming_symbols.private_fields.required_modifiers =
 
 dotnet_naming_symbols.private_static_fields.applicable_kinds = field
 dotnet_naming_symbols.private_static_fields.applicable_accessibilities = private
@@ -1050,18 +1052,18 @@ dotnet_naming_symbols.private_const_fields.required_modifiers = const
 # 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.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.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.camel_case_begins_with_underscore.required_prefix = _
-dotnet_naming_style.camel_case_begins_with_underscore.required_suffix = 
-dotnet_naming_style.camel_case_begins_with_underscore.word_separator = 
+dotnet_naming_style.camel_case_begins_with_underscore.required_suffix =
+dotnet_naming_style.camel_case_begins_with_underscore.word_separator =
 dotnet_naming_style.camel_case_begins_with_underscore.capitalization = camel_case
 
 #### .NET Compiler Platform general options ####

CONTRIBUTING.md

@@ -18,7 +18,7 @@ The library has a test project for unit tests and a test project for integration
 
 Code coverage information can be generated for all test projects at once or for individual test projects. From the root of the repository or from the individual test project directory, run `dotnet test --collect:"XPlat Code Coverage"`.
 
-The coverage information can be visualised using e.g. [ReportGenerator](https://reportgenerator.io/). Install the ReportGenerator dotnet tool with `dotnet tool update -g dotnet-reportgenerator-globaltool` and then run
+The coverage information can be visualized using e.g. [ReportGenerator](https://reportgenerator.io/). Install the ReportGenerator dotnet tool with `dotnet tool update -g dotnet-reportgenerator-globaltool` and then run
 
 ```
 reportgenerator -reports:**/coverage.cobertura.xml -targetdir:TestResults/CoverageReport -assemblyfilters:+Renci.SshNet

Renci.SshNet.sln

@@ -14,6 +14,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		CONTRIBUTING.md = CONTRIBUTING.md
 		Directory.Build.props = Directory.Build.props
 		Directory.Packages.props = Directory.Packages.props
+		exclusion.dic = exclusion.dic
 		global.json = global.json
 		LICENSE = LICENSE
 		nuget.config = nuget.config

exclusion.dic

@@ -0,0 +1,53 @@
+args
+atime
+bcrypt
+bigint
+bourne
+cbc
+chacha
+csproj
+decryptor
+dest
+diffie
+docfx
+ecdh
+ecdsa
+emerle
+exe
+fallback
+github
+hmac
+hostbased
+identd
+ietf
+impl
+infocmp
+kewl
+kex
+mindrot
+mtime
+netconf
+nist
+nistp
+openssh
+pkcs
+posix
+privatekey
+protoversion
+pubkey
+publickey
+renci
+ripemd
+slen
+sntrup
+softwareversion
+sshd
+tcpip
+threadpool
+umac
+unpad
+unix
+waithandle
+xoff
+xmldoc
+zlib

src/Renci.SshNet/.editorconfig

@@ -1,4 +1,6 @@
 [*.cs]
+spelling_exclusion_path = ../exclusion.dic
+spelling_checkable_types = all
 
 #### Sonar rules ####
 

src/Renci.SshNet/Abstractions/SocketAbstraction.cs

@@ -350,7 +350,7 @@ public static void Send(Socket socket, byte[] data, int offset, int size)
                     }
                     else
                     {
-                        throw; // any serious error occurr
+                        throw; // any serious error occur
                     }
                 }
             }

src/Renci.SshNet/BaseClient.cs

@@ -408,7 +408,7 @@ protected virtual void OnDisconnected()
         {
         }
 
-        private void Session_ErrorOccured(object? sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object? sender, ExceptionEventArgs e)
         {
             ErrorOccurred?.Invoke(this, e);
         }
@@ -558,7 +558,7 @@ private ISession CreateAndConnectSession()
             var session = _serviceFactory.CreateSession(ConnectionInfo, _serviceFactory.CreateSocketFactory());
             session.ServerIdentificationReceived += Session_ServerIdentificationReceived;
             session.HostKeyReceived += Session_HostKeyReceived;
-            session.ErrorOccured += Session_ErrorOccured;
+            session.ErrorOccured += Session_ErrorOccurred;
 
             try
             {
@@ -577,7 +577,7 @@ private async Task<ISession> CreateAndConnectSessionAsync(CancellationToken canc
             var session = _serviceFactory.CreateSession(ConnectionInfo, _serviceFactory.CreateSocketFactory());
             session.ServerIdentificationReceived += Session_ServerIdentificationReceived;
             session.HostKeyReceived += Session_HostKeyReceived;
-            session.ErrorOccured += Session_ErrorOccured;
+            session.ErrorOccured += Session_ErrorOccurred;
 
             try
             {
@@ -593,7 +593,7 @@ private async Task<ISession> CreateAndConnectSessionAsync(CancellationToken canc
 
         private void DisposeSession(ISession session)
         {
-            session.ErrorOccured -= Session_ErrorOccured;
+            session.ErrorOccured -= Session_ErrorOccurred;
             session.HostKeyReceived -= Session_HostKeyReceived;
             session.ServerIdentificationReceived -= Session_ServerIdentificationReceived;
             session.Dispose();

src/Renci.SshNet/Channels/Channel.cs

@@ -94,15 +94,15 @@ protected Channel(ISession session, uint localChannelNumber, uint localWindowSiz
             session.ChannelRequestReceived += OnChannelRequest;
             session.ChannelSuccessReceived += OnChannelSuccess;
             session.ChannelFailureReceived += OnChannelFailure;
-            session.ErrorOccured += Session_ErrorOccured;
+            session.ErrorOccured += Session_ErrorOccurred;
             session.Disconnected += Session_Disconnected;
         }
 
         /// <summary>
         /// Gets the session.
         /// </summary>
         /// <value>
-        ///  Thhe session.
+        ///  The session.
         /// </value>
         protected ISession Session
         {
@@ -328,7 +328,7 @@ public void SendData(byte[] data)
         /// multiple chunks and will wait for the remote window size to be adjusted when it's zero.
         /// </para>
         /// <para>
-        /// This is done to support SSH servers will a small window size that do not agressively
+        /// This is done to support SSH servers will a small window size that do not aggressively
         /// increase their window size. We need to take into account that there may be SSH servers
         /// that only increase their window size when it has reached zero.
         /// </para>
@@ -586,7 +586,7 @@ protected virtual void OnDisconnected()
         {
         }
 
-        protected virtual void OnErrorOccured(Exception exp)
+        protected virtual void OnErrorOccurred(Exception exp)
         {
         }
 
@@ -609,20 +609,20 @@ private void Session_Disconnected(object sender, EventArgs e)
         /// </summary>
         /// <param name="ex">The <see cref="Exception"/>.</param>
         /// <remarks>
-        /// This method will in turn invoke <see cref="OnErrorOccured(System.Exception)"/>, and
+        /// This method will in turn invoke <see cref="OnErrorOccurred(System.Exception)"/>, and
         /// raise the <see cref="Exception"/> event.
         /// </remarks>
         protected void OnChannelException(Exception ex)
         {
-            OnErrorOccured(ex);
+            OnErrorOccurred(ex);
             RaiseExceptionEvent(ex);
         }
 
-        private void Session_ErrorOccured(object sender, ExceptionEventArgs e)
+        private void Session_ErrorOccurred(object sender, ExceptionEventArgs e)
         {
             try
             {
-                OnErrorOccured(e.Exception);
+                OnErrorOccurred(e.Exception);
             }
             catch (Exception ex)
             {
@@ -854,7 +854,7 @@ protected virtual void Dispose(bool disposing)
                     session.ChannelRequestReceived -= OnChannelRequest;
                     session.ChannelSuccessReceived -= OnChannelSuccess;
                     session.ChannelFailureReceived -= OnChannelFailure;
-                    session.ErrorOccured -= Session_ErrorOccured;
+                    session.ErrorOccured -= Session_ErrorOccurred;
                     session.Disconnected -= Session_Disconnected;
                 }
 

src/Renci.SshNet/Channels/ChannelDirectTcpip.cs

@@ -249,9 +249,9 @@ protected override void OnEof()
         /// Called whenever an unhandled <see cref="Exception"/> occurs in <see cref="Session"/> causing
         /// the message loop to be interrupted, or when an exception occurred processing a channel message.
         /// </summary>
-        protected override void OnErrorOccured(Exception exp)
+        protected override void OnErrorOccurred(Exception exp)
         {
-            base.OnErrorOccured(exp);
+            base.OnErrorOccurred(exp);
 
             // signal to the client that we will not send anything anymore; this will also interrupt the
             // blocking receive in Bind if the client sends FIN/ACK in time
@@ -261,7 +261,7 @@ protected override void OnErrorOccured(Exception exp)
         }
 
         /// <summary>
-        /// Called when the server wants to terminate the connection immmediately.
+        /// Called when the server wants to terminate the connection immediately.
         /// </summary>
         /// <remarks>
         /// The sender MUST NOT send or receive any data after this message, and

src/Renci.SshNet/Channels/ChannelForwardedTcpip.cs

@@ -98,9 +98,9 @@ public void Bind(IPEndPoint remoteEndpoint, IForwardedPort forwardedPort)
             SocketAbstraction.ReadContinuous(_socket, buffer, 0, buffer.Length, SendData);
         }
 
-        protected override void OnErrorOccured(Exception exp)
+        protected override void OnErrorOccurred(Exception exp)
         {
-            base.OnErrorOccured(exp);
+            base.OnErrorOccurred(exp);
 
             // signal to the server that we will not send anything anymore; this will also interrupt the
             // blocking receive in Bind if the server sends FIN/ACK in time