docs: add spellcheck to gh actions (#2994)

Adds cspell to ci

Author: achingbrain

.github/cspell.json

@@ -0,0 +1,39 @@
+{
+  // Enable your dictionary by adding it to the list of `dictionaries`
+  "dictionaries": ["custom-words"],
+
+  // Tell CSpell about your dictionary
+  "dictionaryDefinitions": [{
+    // The name of the dictionary is used to look it up.
+    "name": "custom-words",
+    // Path to the custom word file. Relative to this `cspell.json` file.
+    "path": "./wordlist.txt",
+    // Some editor extensions will use `addWords` for adding words to your
+    // personal dictionary.
+    "addWords": true
+  }],
+
+  "files": [
+    "**/*.{ts,js,md}",
+    "!**/dist/**",
+    "!**/node_modules/**",
+    "!**/CHANGELOG.md"
+  ],
+
+  "ignoreRegExpList": [
+    // ignore import names (e.g. `import foo from 'module-name-with-typo'`)
+    "/from\\s+(['\"]).*\\1/",
+
+    // ignore anything in backticks
+    "/`.*`/",
+
+    // multiaddrs are not spell checked
+    "/multiaddr(.*)/",
+
+    // peer ids are not spell checked
+    "/peerIdFromString(.*)/",
+
+    // string encoded binary is not spell checked
+    "/uint8ArrayFromString(.*)/"
+  ]
+}

.github/wordlist.txt

@@ -0,0 +1,236 @@
+achingbrain
+additionals
+addr
+addrs
+aegir
+alanshaw
+autodial
+autodialer
+autonat
+bafyfoo
+bafzaa
+bavail
+bfree
+bitswap
+BLPOP
+bootstrapper
+bufs
+buildx
+casttree
+cborg
+cd
+certhash
+certhashes
+chainsafe
+ci
+ciphertext
+cjs
+cms
+codecov
+comms
+composable
+config
+const
+createLibp
+crypto
+cryptographically
+datagrams
+datastore
+dcutr
+dedupe
+dek
+deps
+DER
+dev
+devcon
+devs
+devtools
+dht
+dhts
+dialability
+dialable
+dialer
+discv
+dnsaddr
+dnsaddrs
+Dout
+dumbsub
+encrypter
+Encrypters
+esm
+ethereum
+EventEmitter
+eventloop
+FIL
+firewalled
+floodsub
+fs
+gater
+getbit
+getValue
+github
+GOLOG
+gossipsub
+graphana
+hacky
+helia
+hopr
+hopstr
+ihave
+implementers
+incrby
+io
+ipcidr
+ipfs
+ipns
+ipshipyard
+IPv
+iterable
+iterables
+iwant
+kad
+kadDHT
+kademlia
+KBUCKET
+keychain
+keypair
+keypairs
+keystore
+kubo
+ldelim
+libjuice
+libp
+maconn
+mafmt
+marshaled
+matcher
+mdns
+mDNS
+millis
+misconfigurations
+monorepo
+mplex
+multiaddr
+multiaddrs
+multibase
+multicodec
+multicodecs
+multidim
+multiformats
+multihash
+multihashes
+multistream
+muxed
+muxer
+muxerfactory
+muxers
+muxing
+namespace
+nat
+NATed
+nim
+nist
+nodejs
+nothrow
+npm
+onboarding
+opensource
+osi
+p's
+pbes
+pbkdf
+pbstr
+peerbit
+pem
+perf
+pkcs
+pkix
+plaintext
+pmp
+pnet
+pc
+polyfill
+pre
+priv
+productionization
+programmatically
+protobuf
+protos
+protoschool
+provs
+PRs
+PSK
+pubsub
+pushable
+Qmfoo
+quic
+QUICV
+removeObservedAddr
+Reprovide
+Reprovider
+RequireJS
+responder
+retimeable
+rlflx
+roadmap
+routable
+rpc
+rpush
+rsa
+runtimes
+sdp
+secio
+secp
+semver
+seqno
+setbit
+sha
+SSDP
+SSL
+stablelib
+startable
+startables
+statfs
+stopstr
+stringified
+stringifies
+stringifying
+subarray
+sublist
+subnet
+supercop
+tdigest
+testdata
+toc
+TODO
+topologies
+tsconfig
+tutorialkit
+ufrag
+uint
+unconfirm
+undialable
+undialables
+unhandle
+unmarshal
+unmarshaled
+unmarshaling
+unmarshals
+upgradability
+upgrader
+upnp
+upnpnat
+urlpad
+useragent
+varint
+vyzo
+Waku
+weakcb
+weald
+webapp
+webrtc
+webrtcdirect
+webtransport
+XSalsa
+xxbloom
+yamux

.github/workflows/main.yml

@@ -18,29 +18,34 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
-      with:
-        node-version: lts/*
-    - uses: ipfs/aegir/actions/cache-node-modules@main
-      with:
-        directories: ${{ env.CACHE_DIRS }}
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+      - uses: ipfs/aegir/actions/cache-node-modules@main
+        with:
+          directories: ${{ env.CACHE_DIRS }}
 
   check:
     needs: build
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
-      with:
-        node-version: lts/*
-    - uses: ipfs/aegir/actions/cache-node-modules@main
-      with:
-        directories: ${{ env.CACHE_DIRS }}
-    - run: npm run --if-present lint
-    - run: npm run --if-present dep-check
-    - run: npm run --if-present docs:no-publish
-    - run: npm run --if-present doc-check
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+      - uses: ipfs/aegir/actions/cache-node-modules@main
+        with:
+          directories: ${{ env.CACHE_DIRS }}
+      - run: npm run --if-present lint
+      - run: npm run --if-present dep-check
+      - run: npm run --if-present docs:no-publish
+      - run: npm run --if-present doc-check
+      - uses: streetsidesoftware/cspell-action@ef95dc49d631fc2a9e9ea089ae2b2127b7c4588e # v6.10.0
+        with:
+            config: .github/cspell.json
+            use_cspell_files: true
+
   test-node:
     needs: build
     runs-on: ${{ matrix.os }}

CONTRIBUTING.md

@@ -4,7 +4,7 @@
 
 👉 Please see the [IPFS JavaScript Community contributing guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for how to collaborate and contribute to js-libp2p.
 
-💪 The [core maintainers](https://github.com/libp2p/js-libp2p/blob/main/CODEOWNERS) hang out in #libp2p-implementers in ipfs.io Matrix, FIL Slack, and IPFS Discord. They perform weekly triage of issues and PRs per https://lu.ma/libp2p
+💪 The [core maintainers](https://github.com/libp2p/js-libp2p/blob/main/CODEOWNERS) hang out in #libp2p-implementers in ipfs.io Matrix, FIL Slack, and IPFS Discord. They perform weekly triage of issues and PRs on the Open Maintainers Call - see the [Libp2p Events Calendar](https://lu.ma/libp2p) to find out when the next one is.
 
 🤲 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed in [README.md](https://github.com/libp2p/js-libp2p/blob/main/README.md), without any additional terms or conditions.
 

README.md

@@ -13,7 +13,7 @@
 [![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amain)
 
 > [!NOTE]
-> Are you tring to upgrade libp2p to the latest version?  Check out the [migration guides](https://github.com/libp2p/js-libp2p/tree/main/doc/migrations) for any changes you need to make.
+> Are you trying to upgrade libp2p to the latest version?  Check out the [migration guides](https://github.com/libp2p/js-libp2p/tree/main/doc/migrations) for any changes you need to make.
 
 ### Project status
 
@@ -24,7 +24,7 @@ The documentation in the main branch may contain changes from a pre-release.
 If you are looking for the documentation of the latest release, you can view the latest release on [npm](https://www.npmjs.com/package/libp2p), or select the tag in github that matches the version you are looking for.
 
 > [!TIP]
-> Just tring to figure out what this is all about? Check our [GETTING\_STARTED.md](https://github.com/libp2p/js-libp2p/blob/main/doc/GETTING_STARTED.md) guide and [examples](https://github.com/libp2p/js-libp2p-examples).
+> Just trying to figure out what this is all about? Check our [GETTING\_STARTED.md](https://github.com/libp2p/js-libp2p/blob/main/doc/GETTING_STARTED.md) guide and [examples](https://github.com/libp2p/js-libp2p-examples).
 
 ## Background
 
@@ -41,7 +41,7 @@ We are in the process of writing better documentation, blog posts, tutorials and
 - Articles
   - [The overview of libp2p](https://github.com/libp2p/libp2p#description)
 
-To sum up, libp2p is a "network stack" -- a protocol suite -- that cleanly separates concerns, and enables sophisticated applications to only use the protocols they absolutely need, without giving up interoperability and upgradeability. libp2p grew out of IPFS, but it is built so that lots of people can use it, for lots of different projects.
+To sum up, libp2p is a "network stack" -- a protocol suite -- that cleanly separates concerns, and enables sophisticated applications to only use the protocols they absolutely need, without giving up interoperability and upgradability. libp2p grew out of IPFS, but it is built so that lots of people can use it, for lots of different projects.
 
 ## Roadmap
 
@@ -76,7 +76,7 @@ You can find multiple examples on the [examples repo](https://github.com/libp2p/
 ## Structure
 
 - [`/doc`](https://github.com/libp2p/js-libp2p/blob/main/doc) Docs for libp2p
-- [`/interop`](https://github.com/libp2p/js-libp2p/tree/main/interop) Multidimension Interop Test
+- [`/interop`](https://github.com/libp2p/js-libp2p/tree/main/interop) Multidimensional Interop Test
 - [`/packages/crypto`](https://github.com/libp2p/js-libp2p/tree/main/packages/crypto) Crypto primitives for libp2p
 - [`/packages/interface`](https://github.com/libp2p/js-libp2p/tree/main/packages/interface) The interface implemented by a libp2p node
 - [`/packages/interface-compliance-tests`](https://github.com/libp2p/js-libp2p/tree/main/packages/interface-compliance-tests) Compliance tests for JS libp2p interfaces
@@ -121,7 +121,7 @@ You can find multiple examples on the [examples repo](https://github.com/libp2p/
 #### Run unit tests
 
 ```sh
-# run all the unit tsts
+# run all the unit tests
 > npm test
 
 # run just Node.js tests