Skip to content

Commit 0e1e3d3

Browse files
authored
fix!: update dependencies (#278)
The CID class in the multiformats module has a breaking change so update all deps. Also removes lerna and updates readmes and config.
1 parent 9dc1088 commit 0e1e3d3

File tree

10 files changed

+61
-112
lines changed

10 files changed

+61
-112
lines changed

Diff for: .gitignore

+6-42
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,8 @@
1-
docs
2-
yarn.lock
3-
**/node_modules/
4-
**/*.log
5-
test/repo-tests*
6-
**/bundle.js
7-
package-lock.json
8-
tsconfig-types.aegir.json
9-
10-
# Logs
11-
logs
12-
*.log
13-
14-
coverage
15-
.coverage
16-
*.lcov
17-
18-
# Runtime data
19-
pids
20-
*.pid
21-
*.seed
22-
23-
# Directory for instrumented libs generated by jscoverage/JSCover
24-
lib-cov
25-
26-
# Coverage directory used by tools like istanbul
27-
coverage
28-
.nyc_output
29-
30-
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
31-
.grunt
32-
33-
# node-waf configuration
34-
.lock-wscript
35-
36-
build
37-
38-
# Dependency directory
39-
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
401
node_modules
41-
42-
lib
2+
build
433
dist
44-
types
4+
.docs
5+
.coverage
6+
node_modules
7+
package-lock.json
8+
yarn.lock

Diff for: README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
44
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
55
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)
6-
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-unixfs/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-unixfs/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
77

88
> JS implementation of the IPFS UnixFS
99
@@ -14,9 +14,9 @@
1414
- [Development](#development)
1515
- [Publishing new versions](#publishing-new-versions)
1616
- [Using prerelease versions](#using-prerelease-versions)
17-
- [Contribute](#contribute)
17+
- [API Docs](#api-docs)
1818
- [License](#license)
19-
- [Contribute](#contribute-1)
19+
- [Contribute](#contribute)
2020

2121
## Structure
2222

@@ -56,13 +56,9 @@ Any changed packages from each successful build of master are published to npm a
5656

5757
Canary builds only consider changes to packages in the last built commit so changes to the root config files should not result in new prereleases being published to npm.
5858

59-
## Contribute
60-
61-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs/issues)!
62-
63-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
59+
## API Docs
6460

65-
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
61+
- <https://ipfs.github.io/js-ipfs-unixfs>
6662

6763
## License
6864

Diff for: lerna.json

-10
This file was deleted.

Diff for: package.json

+17-15
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,25 @@
1717
},
1818
"private": true,
1919
"scripts": {
20-
"reset": "lerna run clean && rimraf ./node_modules ./package-lock.json packages/*/node_modules packages/*/package-lock.json",
21-
"test": "lerna run --concurrency 1 test -- --",
22-
"test:node": "lerna run --concurrency 1 test:node -- --",
23-
"test:chrome": "lerna run --concurrency 1 test:chrome -- --",
24-
"test:chrome-webworker": "lerna --concurrency 1 run test:chrome-webworker -- --",
25-
"test:firefox": "lerna run --concurrency 1 test:firefox -- --",
26-
"test:firefox-webworker": "lerna run --concurrency 1 test:firefox-webworker -- --",
27-
"test:electron-main": "lerna run --concurrency 1 test:electron-main -- --",
28-
"test:electron-renderer": "lerna run --concurrency 1 test:electron-renderer -- --",
29-
"clean": "lerna run clean",
30-
"build": "lerna run build",
31-
"lint": "lerna run lint",
32-
"dep-check": "lerna run dep-check",
33-
"release": "lerna exec --concurrency 1 -- semantic-release -e semantic-release-monorepo"
20+
"reset": "aegir run clean && aegir clean ./node_modules ./package-lock.json packages/*/node_modules packages/*/package-lock.json",
21+
"test": "aegir run test",
22+
"test:node": "aegir run test:node",
23+
"test:chrome": "aegir run test:chrome",
24+
"test:chrome-webworker": "aegir run test:chrome-webworker",
25+
"test:firefox": "aegir run test:firefox",
26+
"test:firefox-webworker": "aegir run test:firefox-webworker",
27+
"test:electron-main": "aegir run test:electron-main",
28+
"test:electron-renderer": "aegir run test:electron-renderer",
29+
"clean": "aegir run clean",
30+
"build": "aegir run build",
31+
"lint": "aegir run lint",
32+
"docs": "NODE_OPTIONS=--max_old_space_size=4096 aegir docs",
33+
"docs:no-publish": "npm run docs -- --publish false",
34+
"dep-check": "aegir run dep-check",
35+
"release": "npm run docs:no-publish && aegir run release && npm run docs"
3436
},
3537
"dependencies": {
36-
"lerna": "^6.0.1"
38+
"aegir": "^37.9.0"
3739
},
3840
"workspaces": [
3941
"packages/*"

Diff for: packages/ipfs-unixfs-exporter/README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
44
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
55
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)
6-
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-unixfs/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-unixfs/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
77

88
> JavaScript implementation of the UnixFs exporter used by IPFS
99
@@ -20,9 +20,9 @@
2020
- [`entry.content({ offset, length })`](#entrycontent-offset-length-)
2121
- [`walkPath(cid, blockstore)`](#walkpathcid-blockstore)
2222
- [`recursive(cid, blockstore)`](#recursivecid-blockstore)
23-
- [Contribute](#contribute)
23+
- [API Docs](#api-docs)
2424
- [License](#license)
25-
- [Contribute](#contribute-1)
25+
- [Contribute](#contribute)
2626

2727
## Install
2828

@@ -236,13 +236,9 @@ for await (const child of recursive('Qmfoo/foo/bar', blockstore)) {
236236
// entries contains all children of the `Qmfoo/foo/bar` directory and it's children
237237
```
238238
239-
## Contribute
240-
241-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-exporter/issues)!
242-
243-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
239+
## API Docs
244240
245-
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
241+
- <https://ipfs.github.io/js-ipfs-unixfs/modules/ipfs_unixfs_exporter.html>
246242
247243
## License
248244

Diff for: packages/ipfs-unixfs-exporter/package.json

+8-5
Original file line numberDiff line numberDiff line change
@@ -151,27 +151,27 @@
151151
"release": "aegir release"
152152
},
153153
"dependencies": {
154-
"@ipld/dag-cbor": "^8.0.0",
155-
"@ipld/dag-pb": "^3.0.0",
154+
"@ipld/dag-cbor": "^9.0.0",
155+
"@ipld/dag-pb": "^4.0.0",
156156
"@multiformats/murmur3": "^2.0.0",
157157
"err-code": "^3.0.1",
158158
"hamt-sharding": "^3.0.0",
159-
"interface-blockstore": "^3.0.0",
159+
"interface-blockstore": "^4.0.0",
160160
"ipfs-unixfs": "^8.0.0",
161161
"it-last": "^2.0.0",
162162
"it-map": "^2.0.0",
163163
"it-parallel": "^3.0.0",
164164
"it-pipe": "^2.0.4",
165165
"it-pushable": "^3.1.0",
166-
"multiformats": "^10.0.0",
166+
"multiformats": "^11.0.0",
167167
"p-queue": "^7.3.0",
168168
"uint8arrays": "^4.0.2"
169169
},
170170
"devDependencies": {
171171
"@types/sinon": "^10.0.0",
172172
"abort-controller": "^3.0.0",
173173
"aegir": "^37.5.0",
174-
"blockstore-core": "^2.0.1",
174+
"blockstore-core": "^3.0.0",
175175
"crypto-browserify": "^3.12.0",
176176
"delay": "^5.0.0",
177177
"ipfs-unixfs-importer": "^11.0.0",
@@ -184,5 +184,8 @@
184184
},
185185
"browser": {
186186
"fs": false
187+
},
188+
"typedoc": {
189+
"entryPoint": "./src/index.js"
187190
}
188191
}

Diff for: packages/ipfs-unixfs-importer/README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
44
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
55
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)
6-
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-unixfs/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-unixfs/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
77

88
> JavaScript implementation of the UnixFs importer used by IPFS
99
@@ -15,9 +15,9 @@
1515
- [API](#api)
1616
- [const stream = importer(source, blockstore \[, options\])](#const-stream--importersource-blockstore--options)
1717
- [Overriding internals](#overriding-internals)
18-
- [Contribute](#contribute)
18+
- [API Docs](#api-docs)
1919
- [License](#license)
20-
- [Contribute](#contribute-1)
20+
- [Contribute](#contribute)
2121

2222
## Install
2323

@@ -167,13 +167,9 @@ Several aspects of the importer are overridable by specifying functions as part
167167
- This function should read `{ cid, path, unixfs, node }` entries from `source` and place them in a directory structure
168168
- It should yield an object with the properties `{ cid, path, unixfs, size }` where `cid` is a `CID`, `path` is a string, `unixfs` is a UnixFS entry and `size` is a `Number`.
169169

170-
## Contribute
171-
172-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
173-
174-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
170+
## API Docs
175171

176-
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
172+
- <https://ipfs.github.io/js-ipfs-unixfs/modules/ipfs_unixfs_importer.html>
177173

178174
## License
179175

Diff for: packages/ipfs-unixfs-importer/package.json

+7-4
Original file line numberDiff line numberDiff line change
@@ -151,30 +151,33 @@
151151
"release": "aegir release"
152152
},
153153
"dependencies": {
154-
"@ipld/dag-pb": "^3.0.0",
154+
"@ipld/dag-pb": "^4.0.0",
155155
"@multiformats/murmur3": "^2.0.0",
156156
"err-code": "^3.0.1",
157157
"hamt-sharding": "^3.0.0",
158-
"interface-blockstore": "^3.0.0",
158+
"interface-blockstore": "^4.0.0",
159159
"ipfs-unixfs": "^8.0.0",
160160
"it-all": "^2.0.0",
161161
"it-batch": "^2.0.0",
162162
"it-first": "^2.0.0",
163163
"it-parallel-batch": "^2.0.0",
164164
"merge-options": "^3.0.4",
165-
"multiformats": "^10.0.0",
165+
"multiformats": "^11.0.0",
166166
"rabin-wasm": "^0.1.4",
167167
"uint8arraylist": "^2.3.3",
168168
"uint8arrays": "^4.0.2"
169169
},
170170
"devDependencies": {
171171
"aegir": "^37.5.0",
172172
"assert": "^2.0.0",
173-
"blockstore-core": "^2.0.1",
173+
"blockstore-core": "^3.0.0",
174174
"it-buffer-stream": "^3.0.0",
175175
"wherearewe": "^2.0.1"
176176
},
177177
"browser": {
178178
"fs": false
179+
},
180+
"typedoc": {
181+
"entryPoint": "./src/index.js"
179182
}
180183
}

Diff for: packages/ipfs-unixfs/README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
44
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
55
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)
6-
[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-unixfs/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml)
6+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-unixfs/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
77

88
> JavaScript implementation of IPFS' unixfs (a Unix FileSystem representation on top of a MerkleDAG)
99
@@ -24,9 +24,9 @@
2424
- [marshal and unmarshal](#marshal-and-unmarshal)
2525
- [is this UnixFS entry a directory?](#is-this-unixfs-entry-a-directory)
2626
- [has an mtime been set?](#has-an-mtime-been-set)
27-
- [Contribute](#contribute)
27+
- [API Docs](#api-docs)
2828
- [License](#license)
29-
- [Contribute](#contribute-1)
29+
- [Contribute](#contribute)
3030

3131
## Install
3232

@@ -181,13 +181,9 @@ const dir = new Data({ type: 'dir', mtime: new Date() })
181181
dir.mtime // { secs: Number, nsecs: Number }
182182
```
183183

184-
## Contribute
185-
186-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs/issues)!
187-
188-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
184+
## API Docs
189185

190-
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
186+
- <https://ipfs.github.io/js-ipfs-unixfs/modules/ipfs_unixfs.html>
191187

192188
## License
193189

Diff for: packages/ipfs-unixfs/package.json

+3
Original file line numberDiff line numberDiff line change
@@ -167,5 +167,8 @@
167167
},
168168
"browser": {
169169
"fs": false
170+
},
171+
"typedoc": {
172+
"entryPoint": "./src/index.js"
170173
}
171174
}

0 commit comments

Comments
 (0)