docs: add spell checker to ci

.cspell.json

@@ -0,0 +1,11 @@
+{
+  "import": [
+    "./node_modules/aegir/cspell.json"
+  ],
+  "dictionaries": ["project"],
+  "dictionaryDefinitions": [{
+    "name": "project",
+    "path": "./.github/dictionary.txt",
+    "addWords": true
+  }]
+}

.github/dictionary.txt

@@ -0,0 +1 @@
+dont

.github/workflows/main.yml

@@ -30,6 +30,7 @@ jobs:
     - run: npm run --if-present lint
     - run: npm run --if-present dep-check
     - run: npm run --if-present doc-check
+    - run: npm run --if-present spell-check
 
   test-node:
     needs: build

README.md

@@ -232,7 +232,7 @@ There are several other modules available outside this repo:
 - [`@helia/delegated-routing-v1-http-api`](https://github.com/ipfs/helia-delegated-routing-v1-http-api) An implementation of the [Delegated Routing v1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/) including a server and a client
 - [Helia WNFS](https://github.com/shovelers/helia-wnfs) a [WNFS](https://guide.fission.codes/developers/webnative/file-system-wnfs) implementation built on top of Helia
 - [`@helia/remote-pinning`](https://github.com/ipfs/helia-remote-pinning) A Helia client for communicating with [IPFS Pinning Services](https://ipfs.github.io/pinning-services-api-spec/)
-- [`@helia/http-gateway`](https://github.com/ipfs/helia-http-gateway) An implentation of the [IPFS HTTP Gateway API](https://docs.ipfs.tech/concepts/ipfs-gateway/#gateway-types) built with Helia
+- [`@helia/http-gateway`](https://github.com/ipfs/helia-http-gateway) An implementation of the [IPFS HTTP Gateway API](https://docs.ipfs.tech/concepts/ipfs-gateway/#gateway-types) built with Helia
 
 # 📣 Project status
 

ROADMAP.md

@@ -19,7 +19,7 @@ https://github.com/ipfs/helia/issues/5
     - [Q2](#q2)
       - [Drive Adoption](#drive-adoption)
     - [Q3](#q3)
-      - [Support Fully Speced Delegated Routing Protocols and Endpoints](#support-fully-speced-delegated-routing-protocols-and-endpoints)
+      - [Support Fully Specified Delegated Routing Protocols and Endpoints](#support-fully-specified-delegated-routing-protocols-and-endpoints)
       - [PL Delegate and Preload Nodes Will Be Shutting Down](#pl-delegate-and-preload-nodes-will-be-shutting-down)
 - [Past Milestones](#past-milestones)
   - [2022](#2022)
@@ -44,17 +44,17 @@ Improve "hospitality" of the project: https://github.com/ipfs/helia/issues/35
 
 After Helia is functional and users can adopt it, Protocol Labs EngRes ceases maintaining the legacy js-ipfs project.  Issue for tracking js-ipfs deprecation with roadsigns to Helia: https://github.com/ipfs/js-ipfs/issues/4336
 
-Port over examples from js-ipfs-examples to helia-examples to help with onramping: https://github.com/ipfs/helia/issues/29
+Port over examples from js-ipfs-examples to helia-examples to help with on-ramping: https://github.com/ipfs/helia/issues/29
 
 Demonstrate a practical example of Helia in a service worker as a fallback for HTTP gateways: https://github.com/ipfs/in-web-browsers/issues/207
 
 Setup mechanism for measuring adoption: https://github.com/ipfs/helia/issues/41
 
 ### Q3
 
-#### Support Fully Speced Delegated Routing Protocols and Endpoints
+#### Support Fully Specified Delegated Routing Protocols and Endpoints
 
-While it will be possible from a connectivity perspective to make DHT queries from a browser, we expect various applications will want to still delegate out routing. [HTTP Routing v1](https://github.com/ipfs/specs/blob/main/routing/ROUTING_V1_HTTP.md) is a protocol for delegated routing that other IPFS implementations like Kubo have implemented. While it currently uses HTTP as a transport, it is speced and not tied to the Kubo RPC API. 
+While it will be possible from a connectivity perspective to make DHT queries from a browser, we expect various applications will want to still delegate out routing. [HTTP Routing v1](https://github.com/ipfs/specs/blob/main/routing/ROUTING_V1_HTTP.md) is a protocol for delegated routing that other IPFS implementations like Kubo have implemented. While it currently uses HTTP as a transport, it is specified and not tied to the Kubo RPC API.
 
 #### PL Delegate and Preload Nodes Will Be Shutting Down
 

benchmarks/add-dir/package.json

@@ -14,7 +14,7 @@
   },
   "devDependencies": {
     "@helia/unixfs": "^4.0.1",
-    "aegir": "^45.0.1",
+    "aegir": "^45.1.1",
     "blockstore-core": "^5.0.2",
     "blockstore-fs": "^2.0.1",
     "datastore-core": "^10.0.2",

benchmarks/gc/package.json

@@ -12,7 +12,7 @@
   },
   "devDependencies": {
     "@ipld/dag-pb": "^4.0.6",
-    "aegir": "^45.0.1",
+    "aegir": "^45.1.1",
     "blockstore-fs": "^2.0.1",
     "datastore-level": "^11.0.1",
     "execa": "^8.0.1",

benchmarks/pinning/package.json

@@ -12,7 +12,7 @@
   },
   "devDependencies": {
     "@ipld/dag-pb": "^4.0.6",
-    "aegir": "^45.0.1",
+    "aegir": "^45.1.1",
     "blockstore-fs": "^2.0.1",
     "datastore-level": "^11.0.1",
     "execa": "^8.0.1",

benchmarks/transfer/package.json

@@ -20,7 +20,7 @@
     "@ipld/dag-pb": "^4.0.2",
     "@libp2p/tcp": "^10.0.1",
     "@multiformats/multiaddr": "^12.3.1",
-    "aegir": "^45.0.1",
+    "aegir": "^45.1.1",
     "blockstore-fs": "^2.0.1",
     "datastore-level": "^11.0.1",
     "helia": "^5.1.1",

benchmarks/transports/README.md

@@ -28,7 +28,7 @@ To run:
     WebSockets (node.js -> node.js) filecoin defaults, 1068, 1642, 2092, 2812, 4117, 4423, 6117, 7820, 7182, 7816
     //... results here
     ```
-3. Graph the CSV data with your favourite graphing tool
+3. Graph the CSV data with your favorite graphing tool
 
 ## Debugging
 

benchmarks/transports/package.json

@@ -27,7 +27,7 @@
     "@libp2p/websockets": "^9.0.0",
     "@libp2p/webtransport": "^5.0.0",
     "@multiformats/multiaddr": "^12.2.1",
-    "aegir": "^45.0.1",
+    "aegir": "^45.1.1",
     "blockstore-fs": "^2.0.1",
     "blockstore-idb": "^2.0.1",
     "datastore-idb": "^3.0.0",

benchmarks/transports/src/tests.ts

@@ -22,7 +22,7 @@ interface Impl {
   listen?(relay: Multiaddr): string
 }
 
-const webRTCimpls: Record<string, Impl> = {
+const webRTCImpls: Record<string, Impl> = {
   chromium: {
     type: 'helia',
     exec: PLAYWRIGHT,
@@ -46,7 +46,7 @@ const webRTCimpls: Record<string, Impl> = {
   }
 }
 
-const webSocketimpls: Record<string, Impl> = {
+const webSocketImpls: Record<string, Impl> = {
   'node.js': {
     type: 'helia',
     listen: () => '/ip4/127.0.0.1/tcp/0/ws'
@@ -119,9 +119,9 @@ function addTests (name: string, impls: Record<string, Impl>, tests: Test[], rel
 export function createTests (relay: Multiaddr): Test[] {
   const output: Test[] = []
 
-  addTests('WebRTC', webRTCimpls, output, relay)
+  addTests('WebRTC', webRTCImpls, output, relay)
   addTests('WebTransport', webTransportImpls, output, relay)
-  addTests('WebSockets', webSocketimpls, output, relay)
+  addTests('WebSockets', webSocketImpls, output, relay)
   addTests('TCP', tcpImpls, output, relay)
 
   return output

package.json

@@ -31,14 +31,15 @@
     "lint": "aegir run lint",
     "dep-check": "aegir run dep-check",
     "doc-check": "aegir run doc-check",
+    "spell-check": "aegir spell-check",
     "release": "run-s build docs:no-publish npm:release docs",
     "npm:release": "aegir exec --bail false npm -- publish",
     "release:rc": "aegir release-rc",
     "docs": "aegir docs",
     "docs:no-publish": "aegir docs --publish false"
   },
   "devDependencies": {
-    "aegir": "^45.0.1",
+    "aegir": "^45.1.1",
     "npm-run-all": "^4.1.5"
   },
   "type": "module",

packages/bitswap/package.json

@@ -92,7 +92,7 @@
     "@libp2p/interface-compliance-tests": "^6.1.11",
     "@libp2p/peer-id": "^5.0.8",
     "@types/sinon": "^17.0.3",
-    "aegir": "^45.0.6",
+    "aegir": "^45.1.1",
     "blockstore-core": "^5.0.2",
     "delay": "^6.0.0",
     "it-all": "^3.0.6",

packages/bitswap/src/network.ts

@@ -344,7 +344,7 @@ export class Network extends TypedEventEmitter<NetworkEvents> {
 
     // dial and wait for identify - this is to avoid opening a protocol stream
     // that we are not going to use but depends on the remote node running the
-    // identitfy protocol
+    // identify protocol
     const [
       connection
     ] = await Promise.all([

packages/bitswap/src/pb/message.proto

@@ -26,7 +26,7 @@ message Block {
 
 enum BlockPresenceType {
   HaveBlock = 0;
-  DontHaveBlock = 1;
+  DoNotHaveBlock = 1;
 }
 
 message BlockPresence {

packages/bitswap/src/pb/message.ts

@@ -275,12 +275,12 @@ export namespace Block {
 
 export enum BlockPresenceType {
   HaveBlock = 'HaveBlock',
-  DontHaveBlock = 'DontHaveBlock'
+  DoNotHaveBlock = 'DoNotHaveBlock'
 }
 
 enum __BlockPresenceTypeValues {
   HaveBlock = 0,
-  DontHaveBlock = 1
+  DoNotHaveBlock = 1
 }
 
 export namespace BlockPresenceType {

packages/bitswap/src/peer-want-lists/ledger.ts

@@ -45,7 +45,7 @@ export interface PeerWantListEntry {
   /**
    * If we don't have the block and we've told them we don't have the block
    */
-  sentDontHave?: boolean
+  sentDoNotHave?: boolean
 }
 
 export class Ledger {
@@ -138,14 +138,14 @@ export class Ledger {
         }
 
         // we have already told them we don't have the block
-        if (entry.sentDontHave === true) {
+        if (entry.sentDoNotHave === true) {
           continue
         }
 
-        entry.sentDontHave = true
+        entry.sentDoNotHave = true
         message.addBlockPresence(entry.cid, {
           cid: entry.cid.bytes,
-          type: BlockPresenceType.DontHaveBlock
+          type: BlockPresenceType.DoNotHaveBlock
         })
       }
     }

packages/bitswap/src/want-list.ts

@@ -62,7 +62,7 @@
 
 export interface WantOptions extends AbortOptions, ProgressOptions<BitswapNetworkWantProgressEvents> {
   /**
-   * Allow prioritising blocks
+   * Allow prioritizing blocks
    */
   priority?: number
 }
@@ -73,7 +73,7 @@
   block: Uint8Array
 }
 
-export interface WantDontHaveResult {
+export interface WantDoNotHaveResult {
   sender: PeerId
   cid: CID
   has: false
@@ -86,7 +86,7 @@
   block?: Uint8Array
 }
 
-export type WantPresenceResult = WantDontHaveResult | WantHaveResult
+export type WantPresenceResult = WantDoNotHaveResult | WantHaveResult
 
 export interface WantListEvents {
   block: CustomEvent<WantBlockResult>
@@ -294,7 +294,7 @@
     await this.network.sendMessage(peerId, message)
 
     // wait for peer response
-    const event = await raceEvent<CustomEvent<WantHaveResult | WantDontHaveResult>>(this, 'presence', options.signal, {
+    const event = await raceEvent<CustomEvent<WantHaveResult | WantDoNotHaveResult>>(this, 'presence', options.signal, {
       filter: (event) => {
         return peerId.equals(event.detail.sender) && uint8ArrayEquals(cid.multihash.digest, event.detail.cid.multihash.digest)
       }
@@ -399,7 +399,7 @@
         }
       })
 
-      this.safeDispatchEvent<WantHaveResult | WantDontHaveResult>('presence', {
+      this.safeDispatchEvent<WantHaveResult | WantDoNotHaveResult>('presence', {
         detail: {
           sender,
           cid,
@@ -428,7 +428,7 @@
 
       this.log('received %s from %p for %c', type, sender, cid)
 
-      this.safeDispatchEvent<WantHaveResult | WantDontHaveResult>('presence', {
+      this.safeDispatchEvent<WantHaveResult | WantDoNotHaveResult>('presence', {
         detail: {
           sender,
           cid,

packages/bitswap/test/network.spec.ts

@@ -136,7 +136,7 @@ describe('network', () => {
 
     const lpstr = lpStream(localDuplex)
 
-    // garbage data, cannot be unmarshalled as protobuf
+    // garbage data, cannot be unmarshaled as protobuf
     await lpstr.write(Uint8Array.from([0, 1, 2, 3]))
 
     await pRetry(() => {
@@ -401,11 +401,11 @@ describe('network', () => {
     })
     messageA.addBlockPresence(cid3, {
       cid: cid3.bytes,
-      type: BlockPresenceType.DontHaveBlock
+      type: BlockPresenceType.DoNotHaveBlock
     })
     messageA.addBlockPresence(cid5, {
       cid: cid5.bytes,
-      type: BlockPresenceType.DontHaveBlock
+      type: BlockPresenceType.DoNotHaveBlock
     })
     messageA.addWantlistEntry(cid5, {
       cid: cid5.bytes,
@@ -424,7 +424,7 @@ describe('network', () => {
     })
     messageB.addBlockPresence(cid4, {
       cid: cid4.bytes,
-      type: BlockPresenceType.DontHaveBlock
+      type: BlockPresenceType.DoNotHaveBlock
     })
     messageB.addBlockPresence(cid5, {
       cid: cid5.bytes,
@@ -478,13 +478,13 @@ describe('network', () => {
     }])
     expect(message).to.have.deep.property('blockPresences', [{
       cid: cid3.bytes,
-      type: BlockPresenceType.DontHaveBlock
+      type: BlockPresenceType.DoNotHaveBlock
     }, {
       cid: cid5.bytes,
       type: BlockPresenceType.HaveBlock
     }, {
       cid: cid4.bytes,
-      type: BlockPresenceType.DontHaveBlock
+      type: BlockPresenceType.DoNotHaveBlock
     }])
     expect(message).to.have.deep.property('wantlist', {
       full: true,

packages/bitswap/test/peer-want-list.spec.ts

@@ -347,7 +347,7 @@ describe('peer-want-lists', () => {
     expect(message.blocks).to.be.empty('should not have sent blocks')
     expect(message.blockPresences).to.have.lengthOf(1)
     expect([...message.blockPresences.values()][0].cid).to.equalBytes(cid.bytes)
-    expect([...message.blockPresences.values()][0].type).to.equal(BlockPresenceType.DontHaveBlock, 'should have sent DontHaveBlock presence')
+    expect([...message.blockPresences.values()][0].type).to.equal(BlockPresenceType.DoNotHaveBlock, 'should have sent DoNotHaveBlock presence')
   })
 
   it('should send requested blocks to peer when presence was requested but block size is less than maxSizeReplaceHasWithBlock', async () => {
@@ -437,7 +437,7 @@ describe('peer-want-lists', () => {
     expect(message.blocks).to.be.empty('should not have sent blocks')
     expect(message.blockPresences).to.have.lengthOf(1)
     expect([...message.blockPresences.values()][0].cid).to.equalBytes(cid.bytes)
-    expect([...message.blockPresences.values()][0].type).to.equal(BlockPresenceType.DontHaveBlock, 'should have sent DontHaveBlock presence')
+    expect([...message.blockPresences.values()][0].type).to.equal(BlockPresenceType.DoNotHaveBlock, 'should have sent DoNotHaveBlock presence')
   })
 
   it('should remove wants when peer cancels', async () => {

packages/block-brokers/package.json

@@ -74,7 +74,7 @@
     "@multiformats/uri-to-multiaddr": "^8.0.0",
     "@types/polka": "^0.5.7",
     "@types/sinon": "^17.0.3",
-    "aegir": "^45.0.6",
+    "aegir": "^45.1.1",
     "cors": "^2.8.5",
     "polka": "^0.5.2",
     "sinon": "^19.0.2",