Spelling (#143)

jsoref · adam-fowler · web-flow · commit f7a25995f75a · 2025-07-21T10:18:52.000Z
* spelling: a

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: an

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: cannot

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: collapse

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: compatibility

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: compilation

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: connected

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: consensus

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: containing

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: deep

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: discovery

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: existing

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: fine-grained

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: for

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: interval

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: otherwise,

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: race,

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: refreshes

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: strideable

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: that

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: them

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: unfortunately

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: unsubscribe

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: utilization

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

* spelling: values

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;

---------

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;
Co-authored-by: Adam Fowler &lt;adamfowler71@gmail.com&gt;
diff --git a/Notice.txt b/Notice.txt
@@ -36,7 +36,7 @@ It contains a derivation of RediStack's 'RedisHashSlot.swift' and RESP3 implemen
 
 ---
 
-This product contains a a derivation of Georges Menie's crc16 algorithm that was adopted
+This product contains a derivation of Georges Menie's crc16 algorithm that was adopted
 to Redis coding style by Salvatore Sanfilippo.
 
   * LICENSE:
diff --git a/README.md b/README.md
@@ -47,6 +47,6 @@ let (setResponse, getResponse) = await connection.pipeline(
 let value = try getResponse.get()
 ```
 
-## Redis compatibilty
+## Redis compatibility
 
-As Valkey is a fork of Redis v7.2.4, valkey-swift is compatible with Redis databases up to v7.2.4. There is a chance the v7.2.4 features will still be compatible in later versions of Redis, but these are now considered two different projects and they will diverge. valkey-swift uses the RESP3 protocol.
+As Valkey is a fork of Redis v7.2.4, valkey-swift is compatible with Redis databases up to v7.2.4. There is a chance that v7.2.4 features will still be compatible in later versions of Redis, but these are now considered two different projects and they will diverge. valkey-swift uses the RESP3 protocol.
diff --git a/Sources/Valkey/Cluster/ValkeyClusterClient.swift b/Sources/Valkey/Cluster/ValkeyClusterClient.swift
@@ -618,7 +618,7 @@ public final class ValkeyClusterClient: Sendable {
                         return electionWinner
                     }
 
-                    // ensure that we have pools for all returned nodes so that we can reach concensus
+                    // ensure that we have pools for all returned nodes so that we can reach consensus
                     let actions = self.stateLock.withLock { $0.updateValkeyServiceNodes(description) }
                     self.runUpdateValkeyNodesAction(actions)
 
diff --git a/Sources/Valkey/Cluster/ValkeyClusterClientStateMachine.swift b/Sources/Valkey/Cluster/ValkeyClusterClientStateMachine.swift
@@ -48,7 +48,7 @@ package struct ValkeyClusterClientStateMachineConfiguration {
     @usableFromInline
     package var circuitBreakerDuration: Duration
 
-    /// The default duration between starts of cluster refreshs, if the previous refresh was successful
+    /// The default duration between starts of cluster refreshes, if the previous refresh was successful
     package var defaultClusterRefreshInterval: Duration
 
     package init(circuitBreakerDuration: Duration, defaultClusterRefreshInterval: Duration) {
@@ -78,7 +78,7 @@ package struct ValkeyClusterClientStateMachine<
         case unavailable(UnavailableContext)
 
         /// The cluster was healthy before, but we received a MOVED error to an unknown host
-        /// In this state we have about a minute to become healthy again. Otherwise we mark
+        /// In this state we have about a minute to become healthy again. Otherwise, we mark
         /// the cluster as unavailable.
         case degraded(DegradedContext)
 
diff --git a/Sources/Valkey/Cluster/ValkeyNodeDiscovery.swift b/Sources/Valkey/Cluster/ValkeyNodeDiscovery.swift
@@ -13,7 +13,7 @@
 //===----------------------------------------------------------------------===//
 
 /// Allows the cluster client to initially find at least one node in the cluster or find the
-/// nodes again if connection to the has been lost.
+/// nodes again if connection to them has been lost.
 public protocol ValkeyNodeDiscovery: Sendable {
     /// A type that describes a single node in a valkey cluster
     associatedtype NodeDescription: ValkeyNodeDescriptionProtocol
diff --git a/Sources/Valkey/Connection/ValkeyConnection+ConnectionPool.swift b/Sources/Valkey/Connection/ValkeyConnection+ConnectionPool.swift
@@ -102,7 +102,7 @@ final class ValkeyClientMetrics: ConnectionPoolObservabilityDelegate {
         )
     }
 
-    /// The utlization of the connection changed; a stream may have been used, returned or the
+    /// The utilization of the connection changed; a stream may have been used, returned or the
     /// maximum number of concurrent streams available on the connection changed.
     func connectionLeased(id: ConnectionID) {
         self.logger.debug(
diff --git a/Sources/Valkey/Connection/ValkeyConnection.swift b/Sources/Valkey/Connection/ValkeyConnection.swift
@@ -159,7 +159,7 @@ public final actor ValkeyConnection: ValkeyConnectionProtocol, Sendable {
             }
         }
         let requestID = Self.requestIDGenerator.next()
-        // this currently allocates a promise for every command. We could collpase this down to one promise
+        // this currently allocates a promise for every command. We could collapse this down to one promise
         var mpromises: [EventLoopPromise<RESPToken>] = []
         var encoder = ValkeyCommandEncoder()
         for command in repeat each commands {
@@ -235,12 +235,12 @@ public final actor ValkeyConnection: ValkeyConnectionProtocol, Sendable {
         case .hostname(let host, let port):
             future = connect.connect(host: host, port: port)
             future.whenSuccess { _ in
-                logger.debug("Client connnected to \(host):\(port)")
+                logger.debug("Client connected to \(host):\(port)")
             }
         case .unixDomainSocket(let path):
             future = connect.connect(unixDomainSocketPath: path)
             future.whenSuccess { _ in
-                logger.debug("Client connnected to socket path \(path)")
+                logger.debug("Client connected to socket path \(path)")
             }
         }
 
diff --git a/Sources/Valkey/RESP/RESPStringRenderable.swift b/Sources/Valkey/RESP/RESPStringRenderable.swift
@@ -47,7 +47,7 @@ extension Data: RESPStringRenderable {}
 
 /// Internal type used to render RESPStringRenderable conforming type.
 ///
-/// Unforunately we cannot conform RESPStringRenderable to RESPRenderable if we want
+/// Unfortunately we cannot conform RESPStringRenderable to RESPRenderable if we want
 /// Collections to conform to RESPStringRenderable, as there is already a conformance
 /// to Collection when all the elements conform to RESPRenderable.
 @usableFromInline
diff --git a/Sources/Valkey/RESP/RESPTokenDecodable.swift b/Sources/Valkey/RESP/RESPTokenDecodable.swift
@@ -34,7 +34,7 @@ extension RESPToken: RESPTokenDecodable {
     /// This function also checks for RESP error types and returns them if found
     ///
     /// - Parameter type: Type to convert to
-    /// - Returns: Result contaoining either the Value or an error
+    /// - Returns: Result containing either the Value or an error
     @usableFromInline
     func decodeResult<Value: RESPTokenDecodable>(as type: Value.Type = Value.self) -> Result<Value, Error> {
         switch self.identifier {
diff --git a/Sources/ValkeyConnectionPool/ConnectionPool.swift b/Sources/ValkeyConnectionPool/ConnectionPool.swift
@@ -429,7 +429,7 @@ where
                 self.connectionEstablished(bundle)
 
                 // after the connection has been established, we keep the task open. This ensures
-                // that the pools run method can not be exited before all connections have been
+                // that the pools run method cannot be exited before all connections have been
                 // closed.
                 await withCheckedContinuation { (continuation: CheckedContinuation<Void, Never>) in
                     bundle.connection.onClose {
diff --git a/Sources/ValkeyConnectionPool/ConnectionPoolObservabilityDelegate.swift b/Sources/ValkeyConnectionPool/ConnectionPoolObservabilityDelegate.swift
@@ -15,7 +15,7 @@ public protocol ConnectionPoolObservabilityDelegate: Sendable {
     /// time and is reported via ````. The
     func connectSucceeded(id: ConnectionID, streamCapacity: UInt16)
 
-    /// The utlization of the connection changed; a stream may have been used, returned or the
+    /// The utilization of the connection changed; a stream may have been used, returned or the
     /// maximum number of concurrent streams available on the connection changed.
     func connectionUtilizationChanged(id: ConnectionID, streamsUsed: UInt16, streamCapacity: UInt16)
 
diff --git a/Sources/ValkeyConnectionPool/NIOLock.swift b/Sources/ValkeyConnectionPool/NIOLock.swift
@@ -138,7 +138,7 @@ final class LockStorage<Value>: ManagedBuffer<Value, LockPrimitive> {
         let buffer = Self.create(minimumCapacity: 1) { _ in
             value
         }
-        // Intentionally using a force cast here to avoid a miss compiliation in 5.10.
+        // Intentionally using a force cast here to avoid a miss compilation in 5.10.
         // This is as fast as an unsafeDownCast since ManagedBuffer is inlined and the optimizer
         // can eliminate the upcast/downcast pair
         let storage = buffer as! Self
diff --git a/Sources/ValkeyConnectionPool/NIOLockedValueBox.swift b/Sources/ValkeyConnectionPool/NIOLockedValueBox.swift
@@ -44,7 +44,7 @@ struct NIOLockedValueBox<Value> {
 
     /// Provides an unsafe view over the lock and its value.
     ///
-    /// This can be beneficial when you require fine grained control over the lock in some
+    /// This can be beneficial when you require fine-grained control over the lock in some
     /// situations but don't want lose the benefits of ``withLockedValue(_:)`` in others by
     /// switching to ``NIOLock``.
     var unsafe: Unsafe {
diff --git a/Sources/ValkeyConnectionPool/PoolStateMachine+ConnectionGroup.swift b/Sources/ValkeyConnectionPool/PoolStateMachine+ConnectionGroup.swift
@@ -517,13 +517,13 @@ extension PoolStateMachine {
         @inlinable
         mutating func closeConnectionIfIdle(_ connectionID: Connection.ID) -> CloseAction? {
             guard let index = self.connections.firstIndex(where: { $0.id == connectionID }) else {
-                // because of a race this connection (connection close runs against trigger of timeout)
+                // because of a race, this connection (connection close runs against trigger of timeout)
                 // was already removed from the state machine.
                 return nil
             }
 
             if index < self.minimumConcurrentConnections {
-                // because of a race a connection might receive a idle timeout after it was moved into
+                // because of a race, a connection might receive an idle timeout after it was moved into
                 // the persisted connections. If a connection is now persisted, we now need to ignore
                 // the trigger
                 return nil
diff --git a/Sources/ValkeyConnectionPool/PoolStateMachine.swift b/Sources/ValkeyConnectionPool/PoolStateMachine.swift
@@ -17,7 +17,7 @@ struct PoolConfiguration: Sendable {
     @usableFromInline
     var minimumConnectionCount: Int = 0
 
-    /// The maximum number of connections to for this pool, to be preserved.
+    /// The maximum number of connections for this pool, to be preserved.
     @usableFromInline
     var maximumConnectionSoftLimit: Int = 10
 
diff --git a/Sources/ValkeyJSON/JsonCommands.swift b/Sources/ValkeyJSON/JsonCommands.swift
@@ -487,7 +487,7 @@ extension ValkeyConnectionProtocol {
     /// Append one or more values to the array values at the path.
     ///
     /// - Documentation: [JSON.ARRAPPEND](https://valkey.io/commands/json.arrappend)
-    /// - Complexity: O(N) where N is the number of vaules
+    /// - Complexity: O(N) where N is the number of values
     @inlinable
     @discardableResult
     public func jsonArrappend<Path: RESPStringRenderable, Json: RESPStringRenderable>(
diff --git a/Sources/_ValkeyCommandsBuilder/Resources/valkey-json-commands.json b/Sources/_ValkeyCommandsBuilder/Resources/valkey-json-commands.json
@@ -1,7 +1,7 @@
 {
   "JSON.ARRAPPEND": {
     "summary": "Append one or more values to the array values at the path.",
-    "complexity": "O(N) where N is the number of vaules",
+    "complexity": "O(N) where N is the number of values",
     "group": "json",
     "module_since": "1.0.0",
     "arity": -4,
diff --git a/Tests/ValkeyTests/Cluster/HashSlotShardMapTests.swift b/Tests/ValkeyTests/Cluster/HashSlotShardMapTests.swift
@@ -714,8 +714,8 @@ struct HashSlotShardMapTests {
         return ValkeyClusterDescription(result)
     }
 
-    @Test("Case 1: MovedError specifies the already exisiting shard primary node")
-    func movedErrorSpecifiesTheAlreadyExisitingShardPrimaryNode() throws {
+    @Test("Case 1: MovedError specifies the already existing shard primary node")
+    func movedErrorSpecifiesTheAlreadyExistingShardPrimaryNode() throws {
         let clusterDescription = self.makeExampleCusterWithNShardsAndMReplicasPerShard(shards: 3, replicas: 1)
 
         var map = HashSlotShardMap()
diff --git a/Tests/ValkeyTests/Cluster/HashSlotTests.swift b/Tests/ValkeyTests/Cluster/HashSlotTests.swift
@@ -57,7 +57,7 @@ struct HashSlotTests {
     }
 
     @Test
-    func isStridable() {
+    func isStrideable() {
         let value: HashSlot = 123
         #expect(value.advanced(by: 12) == 135)
     }
diff --git a/Tests/ValkeyTests/Cluster/ValkeyClusterClientStateMachineTests.swift b/Tests/ValkeyTests/Cluster/ValkeyClusterClientStateMachineTests.swift
@@ -37,7 +37,7 @@ struct ValkeyClusterClientStateMachineTests {
 
     @Test
     @available(valkeySwift 1.0, *)
-    func runDiscorveryAfterStartup() {
+    func runDiscoveryAfterStartup() {
         let factory = MockClientFactory()
         let clock = MockClock()
         var stateMachine = TestStateMachine(configuration: testConfiguration, poolFactory: factory, clock: clock)
@@ -83,7 +83,7 @@ struct ValkeyClusterClientStateMachineTests {
 
     @Test
     @available(valkeySwift 1.0, *)
-    func runCircuitBreakerWillOpenIfDiscoeryIsntSuccessfulWithinCircuitBreakerDuration() {
+    func runCircuitBreakerWillOpenIfDiscoveryIsntSuccessfulWithinCircuitBreakerDuration() {
         let factory = MockClientFactory()
         let clock = MockClock()
         var stateMachine = TestStateMachine(configuration: testConfiguration, poolFactory: factory, clock: clock)
diff --git a/Tests/ValkeyTests/RESPTokenTests.swift b/Tests/ValkeyTests/RESPTokenTests.swift
@@ -372,9 +372,9 @@ struct RESPTokenTests {
         let tooDeeplyNested = String(repeating: nested, count: 100) + final
         var tooDeeplyNestedBuffer = ByteBuffer(string: tooDeeplyNested)
 
-        let notDepplyEnoughToThrow = String(repeating: nested, count: 99) + final
-        var notDepplyEnoughToThrowBuffer = ByteBuffer(string: notDepplyEnoughToThrow)
-        let notDepplyEnoughToThrowExpected = RESPToken(validated: notDepplyEnoughToThrowBuffer)
+        let notDeepEnoughToThrow = String(repeating: nested, count: 99) + final
+        var notDeepEnoughToThrowBuffer = ByteBuffer(string: notDeepEnoughToThrow)
+        let notDeepEnoughToThrowExpected = RESPToken(validated: notDeepEnoughToThrowBuffer)
 
         #if true
         #expect {
@@ -386,7 +386,7 @@ struct RESPTokenTests {
             return true
         }
 
-        #expect(try RESPToken(consuming: &notDepplyEnoughToThrowBuffer) == notDepplyEnoughToThrowExpected)
+        #expect(try RESPToken(consuming: &notDeepEnoughToThrowBuffer) == notDeepEnoughToThrowExpected)
         #else
         // this is very slow right now. Once we have faster decoding we should use this instead.
         try ByteToMessageDecoderVerifier.verifyDecoder(
diff --git a/Tests/ValkeyTests/ValkeySubscriptionTests.swift b/Tests/ValkeyTests/ValkeySubscriptionTests.swift
@@ -137,7 +137,7 @@ struct SubscriptionTests {
                 // expect UNSUBSCRIBE command
                 outbound = try await channel.waitForOutboundWrite(as: ByteBuffer.self)
                 #expect(outbound == RESPToken(.command(["UNSUBSCRIBE", "test"])).base)
-                // push unsubcribe
+                // push unsubscribe
                 try await channel.writeInbound(RESPToken(.push([.bulkString("unsubscribe"), .bulkString("test"), .number(0)])).base)
             }
             try await group.waitForAll()
@@ -670,7 +670,7 @@ struct SubscriptionTests {
                 // expect SUNSUBSCRIBE command
                 outbound = try await channel.waitForOutboundWrite(as: ByteBuffer.self)
                 #expect(outbound == RESPToken(.command(["SUNSUBSCRIBE", "test"])).base)
-                // push unsubcribe
+                // push unsubscribe
                 try await channel.writeInbound(RESPToken(.push([.bulkString("sunsubscribe"), .bulkString("test"), .number(1)])).base)
             }
             try await group.waitForAll()
@@ -799,7 +799,7 @@ struct SubscriptionTests {
                 // expect UNSUBSCRIBE command
                 outbound = try await channel.waitForOutboundWrite(as: ByteBuffer.self)
                 #expect(outbound == RESPToken(.command(["UNSUBSCRIBE", "__redis__:invalidate"])).base)
-                // push unsubcribe
+                // push unsubscribe
                 try await channel.writeInbound(RESPToken(.push([.bulkString("unsubscribe"), .bulkString("__redis__:invalidate"), .number(0)])).base)
             }
             try await group.waitForAll()
diff --git a/dev/generate-multi-command-encoder.sh b/dev/generate-multi-command-encoder.sh
@@ -51,7 +51,7 @@ echo ""
 echo "extension ValkeyCommandEncoder {"
 
 # note:
-# - widening the inverval below (eg. going from {1..15} to {1..25}) is Semver minor
+# - widening the interval below (eg. going from {1..15} to {1..25}) is Semver minor
 # - narrowing the interval below is SemVer _MAJOR_!
 for n in {1..15}; do
     genWithoutContextParameter "$n"
diff --git a/dev/generate-transaction-commands.sh b/dev/generate-transaction-commands.sh
@@ -44,7 +44,7 @@ echo ""
 echo "@available(valkeySwift 1.0, *)"
 echo "extension ValkeyConnection {"
 # note:
-# - widening the inverval below (eg. going from {1..15} to {1..25}) is Semver minor
+# - widening the interval below (eg. going from {1..15} to {1..25}) is Semver minor
 # - narrowing the interval below is SemVer _MAJOR_!
 for n in {1..10}; do
     genWithoutContextParameter "$n"

Original file line number	Diff line number	Diff line change
`@@ -618,7 +618,7 @@ public final class ValkeyClusterClient: Sendable {`
`618`	`618`	`return electionWinner`
`619`	`619`	`}`
`620`	`620`
`621`		`- // ensure that we have pools for all returned nodes so that we can reach concensus`
	`621`	`+ // ensure that we have pools for all returned nodes so that we can reach consensus`
`622`	`622`	`let actions = self.stateLock.withLock { $0.updateValkeyServiceNodes(description) }`
`623`	`623`	`self.runUpdateValkeyNodesAction(actions)`
`624`	`624`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ final class ValkeyClientMetrics: ConnectionPoolObservabilityDelegate {`
`102`	`102`	`)`
`103`	`103`	`}`
`104`	`104`
`105`		`- /// The utlization of the connection changed; a stream may have been used, returned or the`
	`105`	`+ /// The utilization of the connection changed; a stream may have been used, returned or the`
`106`	`106`	`/// maximum number of concurrent streams available on the connection changed.`
`107`	`107`	`func connectionLeased(id: ConnectionID) {`
`108`	`108`	`self.logger.debug(`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ public final actor ValkeyConnection: ValkeyConnectionProtocol, Sendable {`
`159`	`159`	`}`
`160`	`160`	`}`
`161`	`161`	`let requestID = Self.requestIDGenerator.next()`
`162`		`- // this currently allocates a promise for every command. We could collpase this down to one promise`
	`162`	`+ // this currently allocates a promise for every command. We could collapse this down to one promise`
`163`	`163`	`var mpromises: [EventLoopPromise<RESPToken>] = []`
`164`	`164`	`var encoder = ValkeyCommandEncoder()`
`165`	`165`	`for command in repeat each commands {`
`@@ -235,12 +235,12 @@ public final actor ValkeyConnection: ValkeyConnectionProtocol, Sendable {`
`235`	`235`	`case .hostname(let host, let port):`
`236`	`236`	`future = connect.connect(host: host, port: port)`
`237`	`237`	`future.whenSuccess { _ in`
`238`		`- logger.debug("Client connnected to \(host):\(port)")`
	`238`	`+ logger.debug("Client connected to \(host):\(port)")`
`239`	`239`	`}`
`240`	`240`	`case .unixDomainSocket(let path):`
`241`	`241`	`future = connect.connect(unixDomainSocketPath: path)`
`242`	`242`	`future.whenSuccess { _ in`
`243`		`- logger.debug("Client connnected to socket path \(path)")`
	`243`	`+ logger.debug("Client connected to socket path \(path)")`
`244`	`244`	`}`
`245`	`245`	`}`
`246`	`246`