Skip to content

Commit 9fccb7c

Browse files
achingbrainachingbrain
authoredAug 11, 2022
deps!: update aegir to 37.x.x (#243)
BREAKING CHANGE: This module used to be dual published as CJS/ESM, now it is just ESM
·
ipfs-unixfs-v11.1.2ipfs-unixfs-11.1.2
1 parent fd05d61 commit 9fccb7c

35 files changed

+308
-315
lines changed
 

‎.github/dependabot.yml

+3
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@ updates:
66
interval: daily
77
time: "10:00"
88
open-pull-requests-limit: 10
9+
commit-message:
10+
prefix: "deps"
11+
prefix-development: "deps(dev)"

‎README.md

+34-20
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,39 @@
1-
# ipfs-unixfs <!-- omit in toc -->
1+
# js-ipfs-unixfs <!-- omit in toc -->
22

3-
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
4-
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
5-
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
6-
[![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-unixfs)](https://travis-ci.com/ipfs/js-ipfs-unixfs)
7-
[![Codecov](https://codecov.io/gh/ipfs/js-ipfs-unixfs/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)
8-
[![Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
3+
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4+
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5+
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
6+
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)
7+
[![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)
98

10-
> JavaScript implementation of IPFS' UnixFS (a representation of a Unix file system on top of a MerkleDAG)
9+
> JS implementation of the IPFS UnixFS
1110
12-
The UnixFS spec can be found at [ipfs/specs/UNIXFS.md](https://github.com/ipfs/specs/blob/master/UNIXFS.md)
13-
14-
## Lead Maintainer <!-- omit in toc -->
15-
16-
[Alex Potsides](https://github.com/achingbrain)
17-
18-
## Table of Contents <!-- omit in toc -->
11+
## Table of contents <!-- omit in toc -->
1912

2013
- [Structure](#structure)
14+
- [Lead Maintainer <!-- omit in toc -->](#lead-maintainer----omit-in-toc---)
2115
- [Development](#development)
2216
- [Publishing new versions](#publishing-new-versions)
2317
- [Using prerelease versions](#using-prerelease-versions)
2418
- [Contribute](#contribute)
2519
- [License](#license)
20+
- [Contribute](#contribute-1)
2621

2722
## Structure
2823

29-
This project is broken into several modules, their purposes are:
24+
- [`/packages/ipfs-unixfs`](./packages/ipfs-unixfs) JavaScript implementation of IPFS' unixfs (a Unix FileSystem representation on top of a MerkleDAG)
25+
- [`/packages/ipfs-unixfs-exporter`](./packages/ipfs-unixfs-exporter) JavaScript implementation of the UnixFs exporter used by IPFS
26+
- [`/packages/ipfs-unixfs-importer`](./packages/ipfs-unixfs-importer) JavaScript implementation of the UnixFs importer used by IPFS
3027

31-
* [`/packages/ipfs-unixfs`](./packages/ipfs-unixfs) Serialization/deserialization of UnixFS objects to protocol buffers
32-
* [`/packages/ipfs-unixfs-importer`](./packages/ipfs-unixfs-importer) Builds DAGs from files and directories
33-
* [`/packages/ipfs-unixfs-exporter`](./packages/ipfs-unixfs-exporter) Exports DAGs
28+
The UnixFS spec can be found at [ipfs/specs/UNIXFS.md](https://github.com/ipfs/specs/blob/master/UNIXFS.md)
29+
30+
## Lead Maintainer <!-- omit in toc -->
31+
32+
[Alex Potsides](https://github.com/achingbrain)
33+
34+
- [`/packages/ipfs-unixfs`](./packages/ipfs-unixfs) Serialization/deserialization of UnixFS objects to protocol buffers
35+
- [`/packages/ipfs-unixfs-importer`](./packages/ipfs-unixfs-importer) Builds DAGs from files and directories
36+
- [`/packages/ipfs-unixfs-exporter`](./packages/ipfs-unixfs-exporter) Exports DAGs
3437

3538
## Development
3639

@@ -64,4 +67,15 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
6467

6568
## License
6669

67-
[MIT](LICENSE)
70+
Licensed under either of
71+
72+
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
73+
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
74+
75+
## Contribute
76+
77+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
78+
79+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
80+
81+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎lerna.json

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
{
22
"lerna": "4.0.0",
3-
"packages": [
4-
"packages/*"
5-
],
3+
"useWorkspaces": true,
64
"version": "independent",
75
"command": {
86
"run": {

‎packages/ipfs-unixfs-exporter/.aegir.cjs

-39
This file was deleted.

‎packages/ipfs-unixfs-exporter/.aegir.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
/** @type {import('aegir').PartialOptions} */
3+
export default {
4+
build: {
5+
bundlesizeMax: '31KB'
6+
}
7+
}

‎packages/ipfs-unixfs-exporter/README.md

+45-33
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,41 @@
1-
# ipfs-unixfs-exporter
1+
# ipfs-unixfs-exporter <!-- omit in toc -->
2+
3+
[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
4+
[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
5+
[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
6+
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)
7+
[![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)
8+
9+
> JavaScript implementation of the UnixFs exporter used by IPFS
10+
11+
## Table of contents <!-- omit in toc -->
12+
13+
- [Install](#install)
14+
- [Lead Maintainer](#lead-maintainer)
15+
- [Usage](#usage)
16+
- [Example](#example)
17+
- [API](#api)
18+
- [`exporter(cid, blockstore, options)`](#exportercid-blockstore-options)
19+
- [UnixFSEntry](#unixfsentry)
20+
- [Raw entries](#raw-entries)
21+
- [CBOR entries](#cbor-entries)
22+
- [`entry.content({ offset, length })`](#entrycontent-offset-length-)
23+
- [`walkPath(cid, blockstore)`](#walkpathcid-blockstore)
24+
- [`recursive(cid, blockstore)`](#recursivecid-blockstore)
25+
- [Contribute](#contribute)
26+
- [License](#license)
27+
- [Contribute](#contribute-1)
228

3-
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
4-
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
5-
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
6-
[![Build Status](https://flat.badgen.net/travis/ipfs/js-ipfs-unixfs)](https://travis-ci.com/ipfs/js-ipfs-unixfs)
7-
[![Codecov](https://codecov.io/gh/ipfs/js-ipfs-unixfs/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)
29+
## Install
830

9-
> Exports UnixFS and other DAGs from IPFS
31+
```console
32+
$ npm i ipfs-unixfs-exporter
33+
```
1034

1135
## Lead Maintainer
1236

1337
[Alex Potsides](https://github.com/achingbrain)
1438

15-
## Table of Contents
16-
17-
- [ipfs-unixfs-exporter](#ipfs-unixfs-exporter)
18-
- [Lead Maintainer](#lead-maintainer)
19-
- [Table of Contents](#table-of-contents)
20-
- [Install](#install)
21-
- [Usage](#usage)
22-
- [Example](#example)
23-
- [API](#api)
24-
- [`exporter(cid, blockstore, options)`](#exportercid-blockstore-options)
25-
- [UnixFSEntry](#unixfsentry)
26-
- [Raw entries](#raw-entries)
27-
- [CBOR entries](#cbor-entries)
28-
- [`entry.content({ offset, length })`](#entrycontent-offset-length-)
29-
- [`walkPath(cid, blockstore)`](#walkpathcid-blockstore)
30-
- [`recursive(cid, blockstore)`](#recursivecid-blockstore)
31-
- [Contribute](#contribute)
32-
- [License](#license)
33-
34-
## Install
35-
36-
```
37-
> npm install ipfs-unixfs-exporter
38-
```
39-
4039
## Usage
4140

4241
### Example
@@ -238,7 +237,9 @@ for await (const child of recursive('Qmfoo/foo/bar', blockstore)) {
238237
```
239238
240239
[dag API]: https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/DAG.md
240+
241241
[blockstore]: https://github.com/ipfs/js-ipfs-interfaces/tree/master/packages/interface-blockstore#readme
242+
242243
[UnixFS]: https://github.com/ipfs/specs/tree/master/unixfs
243244
244245
## Contribute
@@ -251,4 +252,15 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
251252
252253
## License
253254
254-
[MIT](LICENSE)
255+
Licensed under either of
256+
257+
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
258+
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
259+
260+
## Contribute
261+
262+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
263+
264+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
265+
266+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎packages/ipfs-unixfs-exporter/package.json

+38-34
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,32 @@
1919
"npm": ">=7.0.0"
2020
},
2121
"type": "module",
22-
"types": "types/src/index.d.ts",
22+
"types": "./dist/src/index.d.ts",
23+
"typesVersions": {
24+
"*": {
25+
"*": [
26+
"*",
27+
"dist/*",
28+
"dist/src/*",
29+
"dist/src/*/index"
30+
],
31+
"src/*": [
32+
"*",
33+
"dist/*",
34+
"dist/src/*",
35+
"dist/src/*/index"
36+
]
37+
}
38+
},
2339
"files": [
24-
"*",
25-
"!**/*.tsbuildinfo",
26-
"!**/browser-test",
27-
"!**/node-test"
40+
"src",
41+
"dist",
42+
"!dist/test",
43+
"!**/*.tsbuildinfo"
2844
],
2945
"exports": {
3046
".": {
47+
"types": "./dist/src/index.d.ts",
3148
"import": "./src/index.js"
3249
}
3350
},
@@ -64,15 +81,15 @@
6481
"release": "patch"
6582
},
6683
{
67-
"type": "chore",
84+
"type": "docs",
6885
"release": "patch"
6986
},
7087
{
71-
"type": "docs",
88+
"type": "test",
7289
"release": "patch"
7390
},
7491
{
75-
"type": "test",
92+
"type": "deps",
7693
"release": "patch"
7794
},
7895
{
@@ -102,7 +119,11 @@
102119
},
103120
{
104121
"type": "docs",
105-
"section": "Trivial Changes"
122+
"section": "Documentation"
123+
},
124+
{
125+
"type": "deps",
126+
"section": "Dependencies"
106127
},
107128
{
108129
"type": "test",
@@ -113,29 +134,21 @@
113134
}
114135
],
115136
"@semantic-release/changelog",
116-
[
117-
"@semantic-release/npm",
118-
{
119-
"pkgRoot": "dist"
120-
}
121-
],
137+
"@semantic-release/npm",
122138
"@semantic-release/github",
123139
"@semantic-release/git"
124140
]
125141
},
126142
"scripts": {
127-
"prepare": "aegir build --no-bundle && cp -R types dist",
128-
"pretest": "aegir build --esm-tests",
129143
"test": "aegir test",
130144
"test:node": "aegir test -t node --cov",
131145
"test:chrome": "aegir test -t browser --cov",
132146
"test:firefox": "aegir test -t browser -- --browser firefox",
133-
"build": "aegir build && cp -R types dist",
134-
"preleaseOnly": "npx json -I -f dist/package.json -e this.types='\"src/index.d.ts\"'",
135-
"clean": "rimraf ./dist ./types",
136-
"lint": "aegir ts -p check && aegir lint",
137-
"dep-check": "aegir dep-check -i @types/sinon -i nyc -i rimraf -i copy -i util -i crypto-browserify -i events -i readable-stream -i interface-blockstore",
138-
"release": "semantic-release"
147+
"build": "aegir build",
148+
"clean": "aegir clean",
149+
"lint": "aegir lint",
150+
"dep-check": "aegir dep-check -i interface-blockstore",
151+
"release": "aegir release"
139152
},
140153
"dependencies": {
141154
"@ipld/dag-cbor": "^7.0.2",
@@ -152,27 +165,18 @@
152165
"devDependencies": {
153166
"@types/sinon": "^10.0.0",
154167
"abort-controller": "^3.0.0",
155-
"aegir": "^36.2.3",
168+
"aegir": "^37.5.0",
156169
"blockstore-core": "^1.0.5",
157-
"copy": "^0.3.2",
158170
"crypto-browserify": "^3.12.0",
159-
"events": "^3.3.0",
160171
"ipfs-unixfs-importer": "^9.0.0",
161172
"it-all": "^1.0.5",
162173
"it-buffer-stream": "^2.0.0",
163174
"it-first": "^1.0.6",
164175
"merge-options": "^3.0.4",
165176
"native-abort-controller": "^1.0.3",
166-
"readable-stream": "^3.6.0",
167-
"rimraf": "^3.0.2",
168-
"sinon": "^14.0.0",
169-
"util": "^0.12.3"
177+
"sinon": "^14.0.0"
170178
},
171179
"browser": {
172180
"fs": false
173-
},
174-
"main": "src/index.js",
175-
"publishConfig": {
176-
"directory": "dist"
177181
}
178182
}

‎packages/ipfs-unixfs-exporter/test/exporter-sharded.spec.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* eslint-env mocha */
2-
import { expect } from 'aegir/utils/chai.js'
2+
import { expect } from 'aegir/chai'
33
import { UnixFS } from 'ipfs-unixfs'
44
import all from 'it-all'
55
import last from 'it-last'

‎packages/ipfs-unixfs-exporter/test/exporter-subtree.spec.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* eslint-env mocha */
2-
import { expect } from 'aegir/utils/chai.js'
2+
import { expect } from 'aegir/chai'
33
import { importer } from 'ipfs-unixfs-importer'
44
import all from 'it-all'
55
import last from 'it-last'

‎packages/ipfs-unixfs-exporter/test/exporter.spec.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/* eslint-env mocha */
22

3-
import { expect } from 'aegir/utils/chai.js'
3+
import { expect } from 'aegir/chai'
44
import { UnixFS } from 'ipfs-unixfs'
55
import { CID } from 'multiformats/cid'
66
import * as dagPb from '@ipld/dag-pb'

0 commit comments

Comments
 (0)
Please sign in to comment.