fix: correct all typos and add spell checker

Author: achingbrain

.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,18 @@
+ENOENT
+GOPATH
+mgmt
+gotest
+XKCD
+filetypemime
+fleek
+msword
+msdownload
+powerpoint
+noopener
+noreferrer
+nosniff
+Segoe
+Cantarell
+Noto
+Consolas
+filev

package.json

@@ -31,6 +31,7 @@
     "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 run release --concurrency 1",
     "docs": "aegir docs",

packages/gateway-conformance/README.md

@@ -73,7 +73,7 @@ $ curl -v GET http://localhost:3442/ipfs/bafkqabtimvwgy3yk/  # in terminal 2
 
 If you see the following error:
 
-> ENOENT: no such file or directory, open '\[...]/helia-verified-fetch/packages/gateway-conformance/dist/src/fixtures/data/gateway-conformance-fixtures/dnslinks.json
+> ENOENT: no such file or directory, open '[...]/helia-verified-fetch/packages/gateway-conformance/dist/src/...
 
 This likely means the docker container is not executing properly for some reason. You can try running the following command to see if there are any errors: `DEBUG="-mocha*,*,*:trace" npm run test`
 

packages/gateway-conformance/src/fixtures/get-local-dns-resolver.ts

@@ -46,7 +46,7 @@ export function getLocalDnsResolver (ipfsNsMap: string, kuboGateway: string): DN
         name: domain,
         type: 16,
         TTL: 180,
-        data // should be in the format 'dnslink=/ipfs/bafkqac3imvwgy3zao5xxe3de'
+        data // should be in the format 'dnslink=/ipfs/bafyfoo'
       })
     }
 

packages/gateway-conformance/src/index.ts

@@ -43,7 +43,7 @@
  * ## Missing file in gateway-conformance-fixtures folder
  *
  * If you see the following error:
- * > ENOENT: no such file or directory, open '[...]/helia-verified-fetch/packages/gateway-conformance/dist/src/fixtures/data/gateway-conformance-fixtures/dnslinks.json
+ * > ENOENT: no such file or directory, open '[...]/helia-verified-fetch/packages/gateway-conformance/dist/src/...
  *
  * This likely means the docker container is not executing properly for some reason. You can try running the following command to see if there are any errors: `DEBUG="-mocha*,*,*:trace" npm run test`
  */

packages/interop/src/json.spec.ts

@@ -4,7 +4,7 @@ import { expect } from 'aegir/chai'
 import { CID } from 'multiformats/cid'
 
 describe('@helia/verified-fetch - json', () => {
-  describe('unixfs - multiblock', () => {
+  describe('unixfs - multi-block', () => {
     let verifiedFetch: Awaited<ReturnType<typeof createVerifiedFetch>>
 
     before(async () => {

packages/interop/src/unixfs-dir.spec.ts

@@ -51,7 +51,7 @@ describe('@helia/verified-fetch - unixfs directory', () => {
       expect(resp.status).to.equal(501) // TODO: we should do a directory listing instead
     })
 
-    it('can return a string for unixfs pathed data', async () => {
+    it('can return a string for deep-linked unixfs data', async () => {
       const resp = await verifiedFetch('ipfs://QmbQDovX7wRe9ek7u6QXe9zgCXkTzoUSsTFJEkrYV1HrVR/1 - Barrel - Part 1 - alt.txt', {
         allowLocal: true,
         allowInsecure: true
@@ -61,7 +61,7 @@ describe('@helia/verified-fetch - unixfs directory', () => {
       expect(text).to.equal('Don\'t we all.')
     })
 
-    it('can return an image for unixfs pathed data', async () => {
+    it('can return an image for deep-linked unixfs data', async () => {
       const resp = await verifiedFetch('ipfs://QmbQDovX7wRe9ek7u6QXe9zgCXkTzoUSsTFJEkrYV1HrVR/1 - Barrel - Part 1.png', {
         allowLocal: true,
         allowInsecure: true
@@ -88,7 +88,7 @@ describe('@helia/verified-fetch - unixfs directory', () => {
       })
     })
 
-    it('can return an image content-type for unixfs pathed data', async () => {
+    it('can return an image content-type for deep-linked unixfs data', async () => {
       const resp = await verifiedFetch('ipfs://QmbQDovX7wRe9ek7u6QXe9zgCXkTzoUSsTFJEkrYV1HrVR/1 - Barrel - Part 1.png', {
         allowLocal: true,
         allowInsecure: true
@@ -108,9 +108,11 @@ describe('@helia/verified-fetch - unixfs directory', () => {
       expect(resp).to.be.ok()
       const text = await resp.text()
       // npx [email protected] cat '/ipfs/bafybeidbclfqleg2uojchspzd4bob56dqetqjsj27gy2cq3klkkgxtpn4i/685.txt'
+      // spell-checker: disable
       expect(text).to.equal(`Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc non imperdiet nunc. Proin ac quam ut nibh eleifend aliquet. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Sed ligula dolor, imperdiet sagittis arcu et, semper tincidunt urna. Donec et tempor augue, quis sollicitudin metus. Curabitur semper ullamcorper aliquet. Mauris hendrerit sodales lectus eget fermentum. Proin sollicitudin vestibulum commodo. Vivamus nec lectus eu augue aliquet dignissim nec condimentum justo. In hac habitasse platea dictumst. Mauris vel sem neque.
 
 Vivamus finibus, enim at lacinia semper, arcu erat gravida lacus, sit amet gravida magna orci sit amet est. Sed non leo lacus. Nullam viverra ipsum a tincidunt dapibus. Nulla pulvinar ligula sit amet ante ultrices tempus. Proin purus urna, semper sed lobortis quis, gravida vitae ipsum. Aliquam mi urna, pulvinar eu bibendum quis, convallis ac dolor. In gravida justo sed risus ullamcorper, vitae luctus massa hendrerit. Pellentesque habitant amet.`)
+      // spell-checker: enable
     })
   })
 })

packages/verified-fetch/README.md

@@ -306,7 +306,7 @@ When fetching `DAG-PB` data, the content type will be set to `application/octet-
 
 #### JSON
 
-The JSON codec is a very simple codec, a block parseable with this codec is a JSON string encoded into a `Uint8Array`.
+The JSON codec is a very simple codec, a block decodable with this codec is a JSON string encoded into a `Uint8Array`.
 
 ##### Using the JSON codec
 
@@ -399,7 +399,7 @@ console.info(obj.buf) // Uint8Array(5) [ 0, 1, 2, 3, 4 ]
 
 [DAG-CBOR](https://ipld.io/docs/codecs/known/dag-cbor/) uses the [Concise Binary Object Representation](https://cbor.io/) format for serialization instead of JSON.
 
-This supports more datatypes in a safer way than JSON and is smaller on the wire to boot so is usually preferable to JSON or DAG-JSON.
+This supports more data types in a safer way than JSON and is smaller on the wire to boot so is usually preferable to JSON or DAG-JSON.
 
 ##### Content-Type
 
@@ -479,7 +479,7 @@ const res = await verifiedFetch('ipfs://bafyfoo/path/to/dir')
 console.info(res.url) // ipfs://bafyfoo/path/to/dir/
 ```
 
-It's possible to prevent this behaviour and/or handle a redirect manually
+It's possible to prevent this behavior and/or handle a redirect manually
 through use of the [redirect](https://developer.mozilla.org/en-US/docs/Web/API/fetch#redirect)
 option.
 
@@ -554,7 +554,7 @@ This library supports the following methods of fetching web3 content from IPFS:
 2. IPNS protocol: `ipns://<peerId>` & `ipns://<publicKey>` & `ipns://<hostUri_Supporting_DnsLink_TxtRecords>`
 3. CID instances: An actual CID instance `CID.parse('bafy...')`
 
-As well as support for pathing & params for items 1 & 2 above according to [IPFS - Path Gateway Specification](https://specs.ipfs.tech/http-gateways/path-gateway) & [IPFS - Trustless Gateway Specification](https://specs.ipfs.tech/http-gateways/trustless-gateway/). Further refinement of those specifications specifically for web-based scenarios can be found in the [Web Pathing Specification IPIP](https://github.com/ipfs/specs/pull/453).
+As well as support for paths & params for items 1 & 2 above according to [IPFS - Path Gateway Specification](https://specs.ipfs.tech/http-gateways/path-gateway) & [IPFS - Trustless Gateway Specification](https://specs.ipfs.tech/http-gateways/trustless-gateway/). Further refinement of those specifications specifically for web-based scenarios can be found in the [Web Pathing Specification IPIP](https://github.com/ipfs/specs/pull/453).
 
 If you pass a CID instance, it assumes you want the content for that specific CID only, and does not support pathing or params for that CID.
 
@@ -658,7 +658,7 @@ Known Errors that can be thrown:
 3. `TypeError` - If the options argument is passed and is malformed.
 4. `AbortError` - If the content request is aborted due to user aborting provided AbortSignal. Note that this is a `AbortError` from `@libp2p/interface` and not the standard `AbortError` from the Fetch API.
 
-## Pluggability and Extensibility
+## Extensibility
 
 Verified‑fetch can now be extended to alter how it handles requests by using plugins.
 Plugins are classes that extend the `BasePlugin` class and implement the `VerifiedFetchPlugin`

packages/verified-fetch/src/index.ts

@@ -368,7 +368,7 @@
  *
  * [DAG-CBOR](https://ipld.io/docs/codecs/known/dag-cbor/) uses the [Concise Binary Object Representation](https://cbor.io/) format for serialization instead of JSON.
  *
- * This supports more datatypes in a safer way than JSON and is smaller on the wire to boot so is usually preferable to JSON or DAG-JSON.
+ * This supports more data types in a safer way than JSON and is smaller on the wire to boot so is usually preferable to JSON or DAG-JSON.
  *
  * ##### Content-Type
  *
@@ -448,7 +448,7 @@
  * console.info(res.url) // ipfs://bafyfoo/path/to/dir/
  * ```
  *
- * It's possible to prevent this behaviour and/or handle a redirect manually
+ * It's possible to prevent this behavior and/or handle a redirect manually
  * through use of the [redirect](https://developer.mozilla.org/en-US/docs/Web/API/fetch#redirect)
  * option.
  *
@@ -627,7 +627,7 @@
  * 3. `TypeError` - If the options argument is passed and is malformed.
  * 4. `AbortError` - If the content request is aborted due to user aborting provided AbortSignal. Note that this is a `AbortError` from `@libp2p/interface` and not the standard `AbortError` from the Fetch API.
  *
- * ## Pluggability and Extensibility
+ * ## Extensibility
  *
  * Verified‑fetch can now be extended to alter how it handles requests by using plugins.
  * Plugins are classes that extend the `BasePlugin` class and implement the `VerifiedFetchPlugin`
@@ -893,7 +893,7 @@ export interface CreateVerifiedFetchInit {
   /**
    * By default we will not connect to any HTTP Gateways providers over local or
    * loopback addresses, this is because they are typically running on remote
-   * peers that have published private addresses by mistate.
+   * peers that have published private addresses by mistake.
    *
    * Pass `true` here to connect to local Gateways as well, this may be useful
    * in testing environments.
@@ -904,7 +904,7 @@ export interface CreateVerifiedFetchInit {
 
   /**
    * By default we will not connect to any gateways over HTTP addresses,
-   * requring HTTPS connections instead. This is because it will cause
+   * requiring HTTPS connections instead. This is because it will cause
    * "mixed-content" errors to appear in the console when running in secure
    * browser contexts.
    *
@@ -1012,7 +1012,7 @@ export interface VerifiedFetchInit extends RequestInit, ProgressOptions<BubbledP
   /**
    * By default we will not connect to any HTTP Gateways providers over local or
    * loopback addresses, this is because they are typically running on remote
-   * peers that have published private addresses by mistate.
+   * peers that have published private addresses by mistake.
    *
    * Pass `true` here to connect to local Gateways as well, this may be useful
    * in testing environments.
@@ -1023,7 +1023,7 @@ export interface VerifiedFetchInit extends RequestInit, ProgressOptions<BubbledP
 
   /**
    * By default we will not connect to any gateways over HTTP addresses,
-   * requring HTTPS connections instead. This is because it will cause
+   * requiring HTTPS connections instead. This is because it will cause
    * "mixed-content" errors to appear in the console when running in secure
    * browser contexts.
    *