Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Adds en-GB as spell checker option; reverts notable cases of American…
… English
  • Loading branch information
jacobslusser committed Jul 11, 2025
commit 024a02355f691112baba0b470beb61b27b1e3ad0
1 change: 1 addition & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ insert_final_newline = true
indent_style = space
indent_size = 4
tab_width = 4
spelling_languages = en-us,en-gb
spelling_exclusion_path = exclusion.dic
spelling_checkable_types = all

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 visualized 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 visualised 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
Expand Down
Binary file modified exclusion.dic
Binary file not shown.
1 change: 1 addition & 0 deletions src/Renci.SshNet/.editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[*.cs]
spelling_languages = en-us,en-gb
spelling_exclusion_path = ../exclusion.dic
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the file this is pointing to has only 2 words, both already included in the top-level file. Is it an artifact of earlier changes?

Suggested change
spelling_exclusion_path = ../exclusion.dic
spelling_exclusion_path = ../../exclusion.dic

spelling_checkable_types = all

Expand Down
2 changes: 1 addition & 1 deletion src/Renci.SshNet/Messages/Transport/IgnoreMessage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public override byte MessageNumber
}

/// <summary>
/// Gets ignore message data if this message has been initialized
/// Gets ignore message data if this message has been initialised
/// with data to be sent. Otherwise, returns an empty array.
/// </summary>
public byte[] Data { get; private set; }
Expand Down
2 changes: 1 addition & 1 deletion src/Renci.SshNet/PrivateKeyFile.cs
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ private void OpenCertificate(Stream certificate)

Certificate = new Certificate(Convert.FromBase64String(data));

Debug.Assert(Key is not null, $"{nameof(Key)} should have been initialized already.");
Debug.Assert(Key is not null, $"{nameof(Key)} should have been initialised already.");

if (!Certificate.Key.Public.SequenceEqual(Key.Public))
{
Expand Down
4 changes: 2 additions & 2 deletions src/Renci.SshNet/Security/Certificate.cs
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ public DateTimeOffset ValidBefore
/// The key identifies the option and the value encodes
/// option-specific information.
/// All such options are "critical" in the sense that an implementation
/// must refuse to authorize a key that has an unrecognized option.
/// must refuse to authorize a key that has an unrecognised option.
/// </summary>
public IDictionary<string, string> CriticalOptions
{
Expand All @@ -189,7 +189,7 @@ public IDictionary<string, string> CriticalOptions
/// <summary>
/// A set of zero or more optional extensions. These extensions
/// are not critical, and an implementation that encounters one that it does
/// not recognize may safely ignore it.
/// not recognise may safely ignore it.
/// </summary>
public IDictionary<string, string> Extensions
{
Expand Down
4 changes: 2 additions & 2 deletions src/Renci.SshNet/SshCommand.cs
Original file line number Diff line number Diff line change
Expand Up @@ -263,9 +263,9 @@ public Task ExecuteAsync(CancellationToken cancellationToken = default)
OutputStream.Dispose();
ExtendedOutputStream.Dispose();

// Initialize output streams. We already initialized them for the first
// Initialise output streams. We already initialised them for the first
// execution in the constructor (to allow passing them around before execution)
// so we just need to reinitialize them for subsequent executions.
// so we just need to reinitialise them for subsequent executions.
OutputStream = new PipeStream();
ExtendedOutputStream = new PipeStream();
_channel = _session.CreateChannelSession();
Expand Down
2 changes: 2 additions & 0 deletions src/exclusion.dic
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the (redundant?) file I am talking about

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another behavior (bug) in Visual Studio spellchecker. There were some times when it would honor the exclusion.dic file in the root and other times when it would only honor the one in the immediate same folder as the project/.editorconfig. From your fix, its possible I had my path wrong. Either way, I got tired of troubleshooting MS/VS issues and in the end tried to focus on the point of the PR which was to fix a few spelling errors, not necessarily build a spellchecking tool pipeline.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, thanks

Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
renci
openssh
1 change: 1 addition & 0 deletions test/.editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[*.cs]
spelling_languages = en-us,en-gb
spelling_exclusion_path = ../exclusion.dic
spelling_checkable_types = identifiers,comments

Expand Down
1 change: 1 addition & 0 deletions test/Renci.SshNet.Benchmarks/.editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[*.cs]
spelling_languages = en-us,en-gb
spelling_exclusion_path = ../../exclusion.dic
spelling_checkable_types = identifiers,comments

Expand Down
1 change: 1 addition & 0 deletions test/Renci.SshNet.IntegrationBenchmarks/.editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[*.cs]
spelling_languages = en-us,en-gb
spelling_exclusion_path = ../../exclusion.dic
spelling_checkable_types = identifiers,comments

Expand Down
1 change: 1 addition & 0 deletions test/Renci.SshNet.IntegrationTests/.editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[*.cs]
spelling_languages = en-us,en-gb
spelling_exclusion_path = ../../exclusion.dic
spelling_checkable_types = identifiers,comments

Expand Down
1 change: 1 addition & 0 deletions test/Renci.SshNet.Tests/.editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[*.cs]
spelling_languages = en-us,en-gb
spelling_exclusion_path = ../../exclusion.dic
spelling_checkable_types = identifiers,comments

Expand Down
2 changes: 1 addition & 1 deletion test/Renci.SshNet.Tests/Classes/OrderedDictionaryTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ private static void AssertEqual<TKey, TValue>(List<KeyValuePair<TKey, TValue>> e
valuesArray);

// Creates a List<T> via enumeration, avoiding the ICollection<T>.CopyTo
// optimization in the List<T> constructor.
// optimisation in the List<T> constructor.
static List<T> ToList<T>(IEnumerable<T> values)
{
List<T> list = new();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ private class MySession(ConnectionInfo connectionInfo) : ISession

public void SendMessage(Message message)
{
// Initialization sequence for SFTP session
// Initialisation sequence for SFTP session

if (message is ChannelOpenMessage)
{
Expand Down