Skip to content

Commit 45ca6bc

Browse files
authored
docs: add spell checker to ci (#743)
Adds cspell to CI to catch typos in code and docs.
1 parent d602bb2 commit 45ca6bc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+225
-183
lines changed

.cspell.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"import": [
3+
"./node_modules/aegir/cspell.json"
4+
],
5+
"dictionaries": ["project"],
6+
"dictionaryDefinitions": [{
7+
"name": "project",
8+
"path": "./.github/dictionary.txt",
9+
"addWords": true
10+
}]
11+
}

.github/dictionary.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dont

.github/workflows/main.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ jobs:
3030
- run: npm run --if-present lint
3131
- run: npm run --if-present dep-check
3232
- run: npm run --if-present doc-check
33+
- run: npm run --if-present spell-check
3334

3435
test-node:
3536
needs: build

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ There are several other modules available outside this repo:
232232
- [`@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
233233
- [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
234234
- [`@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/)
235-
- [`@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
235+
- [`@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
236236

237237
# 📣 Project status
238238

ROADMAP.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ https://github.com/ipfs/helia/issues/5
1919
- [Q2](#q2)
2020
- [Drive Adoption](#drive-adoption)
2121
- [Q3](#q3)
22-
- [Support Fully Speced Delegated Routing Protocols and Endpoints](#support-fully-speced-delegated-routing-protocols-and-endpoints)
22+
- [Support Fully Specified Delegated Routing Protocols and Endpoints](#support-fully-specified-delegated-routing-protocols-and-endpoints)
2323
- [PL Delegate and Preload Nodes Will Be Shutting Down](#pl-delegate-and-preload-nodes-will-be-shutting-down)
2424
- [Past Milestones](#past-milestones)
2525
- [2022](#2022)
@@ -44,17 +44,17 @@ Improve "hospitality" of the project: https://github.com/ipfs/helia/issues/35
4444

4545
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
4646

47-
Port over examples from js-ipfs-examples to helia-examples to help with onramping: https://github.com/ipfs/helia/issues/29
47+
Port over examples from js-ipfs-examples to helia-examples to help with on-ramping: https://github.com/ipfs/helia/issues/29
4848

4949
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
5050

5151
Setup mechanism for measuring adoption: https://github.com/ipfs/helia/issues/41
5252

5353
### Q3
5454

55-
#### Support Fully Speced Delegated Routing Protocols and Endpoints
55+
#### Support Fully Specified Delegated Routing Protocols and Endpoints
5656

57-
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.
57+
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.
5858

5959
#### PL Delegate and Preload Nodes Will Be Shutting Down
6060

benchmarks/add-dir/README.md

Lines changed: 52 additions & 52 deletions
Large diffs are not rendered by default.

benchmarks/add-dir/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
},
1515
"devDependencies": {
1616
"@helia/unixfs": "^4.0.1",
17-
"aegir": "^45.0.1",
17+
"aegir": "^45.1.1",
1818
"blockstore-core": "^5.0.2",
1919
"blockstore-fs": "^2.0.1",
2020
"datastore-core": "^10.0.2",

benchmarks/gc/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
},
1313
"devDependencies": {
1414
"@ipld/dag-pb": "^4.0.6",
15-
"aegir": "^45.0.1",
15+
"aegir": "^45.1.1",
1616
"blockstore-fs": "^2.0.1",
1717
"datastore-level": "^11.0.1",
1818
"execa": "^8.0.1",

benchmarks/pinning/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
},
1313
"devDependencies": {
1414
"@ipld/dag-pb": "^4.0.6",
15-
"aegir": "^45.0.1",
15+
"aegir": "^45.1.1",
1616
"blockstore-fs": "^2.0.1",
1717
"datastore-level": "^11.0.1",
1818
"execa": "^8.0.1",

benchmarks/transfer/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"@ipld/dag-pb": "^4.0.2",
2121
"@libp2p/tcp": "^10.0.1",
2222
"@multiformats/multiaddr": "^12.3.1",
23-
"aegir": "^45.0.1",
23+
"aegir": "^45.1.1",
2424
"blockstore-fs": "^2.0.1",
2525
"datastore-level": "^11.0.1",
2626
"helia": "^5.1.1",

0 commit comments

Comments
 (0)