Skip to content

Commit cb920a5

Browse files
committed
fix: update readmes and bundle sizes
1 parent 16c1043 commit cb920a5

File tree

6 files changed

+24
-12
lines changed

6 files changed

+24
-12
lines changed

packages/gateway-conformance/.aegir.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ const log = logger('aegir')
55

66
/** @type {import('aegir').PartialOptions} */
77
export default {
8+
build: {
9+
bundlesizeMax: '1KB'
10+
},
811
test: {
912
files: ['./dist/src/*.spec.js'],
1013
before: async (options) => {

packages/gateway-conformance/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ repo and examine the changes made.
3030
3131
-->
3232

33-
Runs Gateway Conformance tests against @helia/verified-fetch using Kubo as a backing trustless-gateway.
33+
Runs Gateway Conformance tests against @helia/verified-fetch using Kubo as a
34+
backing trustless-gateway.
3435

3536
## Example - Testing a new @helia/verified-fetch release
3637

@@ -67,15 +68,17 @@ $ node dist/src/demo-server.js # in terminal 1
6768
$ curl -v GET http://localhost:3442/ipfs/bafkqabtimvwgy3yk/ # in terminal 2
6869
```
6970

70-
# Troubleshooting
71+
## Troubleshooting
7172

72-
## Missing file in gateway-conformance-fixtures folder
73+
### Missing file in gateway-conformance-fixtures folder
7374

7475
If you see the following error:
7576

76-
> ENOENT: no such file or directory, open '[...]/helia-verified-fetch/packages/gateway-conformance/dist/src/...
77+
> ENOENT: no such file or directory, open '\[...]/helia-verified-fetch/packages/gateway-conformance/dist/src/...
7778
78-
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`
79+
This likely means the docker container is not executing properly for some
80+
reason. You can try running the following command to see if there are any
81+
errors: `DEBUG="-mocha*,*,*:trace" npm run test`
7982

8083
# Install
8184

packages/gateway-conformance/src/index.ts

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
/**
22
* @packageDocumentation
33
*
4-
* Runs Gateway Conformance tests against @helia/verified-fetch using Kubo as a backing trustless-gateway.
4+
* Runs Gateway Conformance tests against @helia/verified-fetch using Kubo as a
5+
* backing trustless-gateway.
56
*
67
* @example Testing a new @helia/verified-fetch release
78
*
@@ -38,14 +39,16 @@
3839
* $ curl -v GET http://localhost:3442/ipfs/bafkqabtimvwgy3yk/ # in terminal 2
3940
* ```
4041
*
41-
* # Troubleshooting
42+
* ## Troubleshooting
4243
*
43-
* ## Missing file in gateway-conformance-fixtures folder
44+
* ### Missing file in gateway-conformance-fixtures folder
4445
*
4546
* If you see the following error:
4647
* > ENOENT: no such file or directory, open '[...]/helia-verified-fetch/packages/gateway-conformance/dist/src/...
4748
*
48-
* 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`
49+
* This likely means the docker container is not executing properly for some
50+
* reason. You can try running the following command to see if there are any
51+
* errors: `DEBUG="-mocha*,*,*:trace" npm run test`
4952
*/
5053

5154
export {}

packages/interop/.aegir.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ const IPFS_PATH = resolve(tmpdir(), 'verified-fetch-interop-ipfs-repo')
77

88
/** @type {import('aegir').PartialOptions} */
99
export default {
10+
build: {
11+
bundlesizeMax: '1KB'
12+
},
1013
dependencyCheck: {
1114
ignore: [
1215
'@helia/delegated-routing-v1-http-api-server',

packages/verified-fetch/.aegir.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/** @type {import('aegir').PartialOptions} */
22
const options = {
33
build: {
4-
bundlesizeMax: '132KB'
4+
bundlesizeMax: '355KB'
55
}
66
}
77

packages/verified-fetch/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ When fetching `DAG-PB` data, the content type will be set to `application/octet-
306306

307307
#### JSON
308308

309-
The JSON codec is a very simple codec, a block decodable with this codec is a JSON string encoded into a `Uint8Array`.
309+
The JSON codec is a very simple codec, a block parseable with this codec is a JSON string encoded into a `Uint8Array`.
310310

311311
##### Using the JSON codec
312312

@@ -554,7 +554,7 @@ This library supports the following methods of fetching web3 content from IPFS:
554554
2. IPNS protocol: `ipns://<peerId>` & `ipns://<publicKey>` & `ipns://<hostUri_Supporting_DnsLink_TxtRecords>`
555555
3. CID instances: An actual CID instance `CID.parse('bafy...')`
556556

557-
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).
557+
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).
558558

559559
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.
560560

0 commit comments

Comments
 (0)