feat!: publish as esm-only #56

achingbrain · 2022-08-30T12:10:33Z

Following on from the conversation in ipld/ipld#224 this converts this repo to use the latest aegir with Unified CI.

Remove all dev deps apart from aegir
Run the npx aegir check-project command to update project config
Remove non-Unified-CI github actions
Update imports to import from src/index.js instead of @ipld/dag-pb
Rename test/*.js to test/*.spec.js so aegir can find them
Update tsconfig.json to extend config from aegir
Remove "main" and other unused fields from package.json
Use chai from aegir pre-configured with plugins we use
Fixes everything the linter complains about

This will need a follow up PR to protocol/.github to add this repo to the Unified CI config file so it'll get automated config updates in the future.

Apologies that this PR is so noisy, most of it is from the check-project command

Following on from the conversation in ipld/ipld#224 this converts this repo to use the latest aegir with Unified CI. 1. Remove all dev deps apart from `aegir` 1. Run the `npx aegir check-project` command to update project config 1. Remove non-Unified-CI github actions 1. Update imports to import from `src/index.js` instead of `@ipld/dag-pb` 1. Rename `test/*.js` to `test/*.spec.js` so aegir can find them 1. Update `tsconfig.json` to extend config from `aegir` 1. Remove `"main"` and other unused fields from `package.json` 1. Use `chai` from `aegir` pre-configured with plugins we use This will need a follow up PR to `protocol/.github` to add this repo to the Unified CI [config file](https://github.com/protocol/.github/blob/master/configs/js.json) so it'll get automated config updates in the future. Apologies that this PR is so noisy, most of it is from the `check-project` command

achingbrain · 2022-08-30T12:12:05Z

.github/dependabot.yml

@@ -1,16 +1,11 @@
 version: 2
 updates:
-  - package-ecosystem: 'github-actions'


I don't know if we want to reinstate this, probably not - the view of the stewards seems to be to not pull in arbitrary github actions versions, instead to lock them down to individual commits managed by Unified CI, apart from a few blessed actions (essentially only the ones published by github).

achingbrain · 2022-08-30T12:14:25Z

package.json

+    "build": "aegir build",
+    "release": "aegir release",
+    "test": "aegir test -t node -t browser -t webworker -t electron-main",
+    "test:ts": "npm run test --prefix test/ts-use",


I wasn't sure what to do with this, since we don't test ts integration like this in libp2p/ipfs anywhere else (yet).

~~Just tagged it on to the end of test:node for now~~ - if it's useful we can add a block to the js-test-and-release.yml action? Might be preferable.

It seems the test command in ts-use uses an argument format that means it doesn't work on Windows.

Having the TS tests be par of js-test-and-release.yml would be great. I'm not sure how they should be approached yet though.

Would running the tests as TS but having the TS tests import JS tests work?

It's worth a shot, though the tests are compiled to js before execution so my brain turns inside out a little bit.

rvagg · 2022-08-31T02:54:18Z

README.md


-An implementation of the [DAG-PB spec](https://github.com/ipld/specs/blob/master/block-layer/codecs/dag-pb.md) for JavaScript designed for use with [multiformats](https://github.com/multiformats/js-multiformats) or via the higher-level `Block` abstraction in [@ipld/block](https://github.com/ipld/js-block).


why did this get removed? does the tooling just expect the intro section to be badges?

No particular reason - the readme is parsed and standardised by aegir to have the same badges, toc, license, install instructions etc everywhere.

It's a work in progress though, more than happy to merge fixes to the implementation.

rvagg · 2022-08-31T02:57:02Z

package.json

+      "types": "./dist/src/index.d.ts",
+      "import": "./src/index.js"


so what is the purpose of dist? is it just meant to be the pieces that aren't checked in but are built at publish-time? i.e. the types?

Might be useful to move it into the types folder the way we have for js-miltiformats. Or is dist the standard accross all the other IPFS repos?

dist is standard across all other IPFS repos.

is it just meant to be the pieces that aren't checked in but are built at publish-time? i.e. the types?

Exactly, yes - types, minified bundles, source maps, all that stuff.

rvagg · 2022-08-31T02:59:57Z

test/test-compat.spec.js

 import { bytes } from 'multiformats'
 import { CID } from 'multiformats/cid'
-import { encode, decode } from '@ipld/dag-pb'


what breaks for this to need to change? we could add back "paths" if it's typescript compiling that's failing; it's kind of nice to be consuming it as an external consumer would

Honestly this paths thing is super complicated and I don't see other projects doing it that way. 😅

I think it's related to some of the issues we're seeing with duplicate multiformats causing errors.

From what I'm seeing, the paths thing is counter to how ESM works and doesn't play nice with esbuild.

I think the ts-use pattern could be useful for making sure it works as a consumer.

RangerMauve · 2022-10-03T21:53:13Z

@achingbrain Do you think you'd have time to review Rod's latest changes in the v10.0.0 branch of multiformats to see if there's stuff in there that should be ported here?

…-only

achingbrain · 2022-10-15T10:34:27Z

We may wish to roll #59 into this but it's blocked by multiformats/js-multiformats#208 (fixed by multiformats/js-multiformats#210)

rvagg · 2022-10-17T06:25:11Z

👍 this all looks good to me, minus the multiformats@10 problems; I wouldn't mind confirming for myself that the types are going out to the place identified by the package.json, it looks all right but we keep on having problems with type exports!

rvagg · 2022-10-17T06:27:32Z

how about we just switch to cid1.equals(cid2) or cid1.toString() === cid2.toString() here for now to get over that particular hump and get this unblocked for a release?

achingbrain · 2022-10-17T06:29:30Z

Seems reasonable in places where we just compare two CIDs, but it won't work in places where we do deep equality checks on objects with CID fields without pulling those fields out or overwriting them.

achingbrain · 2022-10-17T06:42:24Z

multiformats/js-multiformats#215 makes the tests in this PR pass for me

achingbrain · 2022-10-17T06:56:38Z

Not this PR, I mean rolling multiformats@10.x.x into this PR.

## [3.0.0](v2.1.18...v3.0.0) (2022-10-19) ### ⚠ BREAKING CHANGES * publish as esm-only (#56) ### Features * publish as esm-only ([#56](#56)) ([27e1076](27e1076)) ### Trivial Changes * **no-release:** bump @types/mocha from 9.1.1 to 10.0.0 ([#58](#58)) ([6475261](6475261)) * **no-release:** bump actions/setup-node from 3.4.1 to 3.5.0 ([#57](#57)) ([72521b4](72521b4)) * **no-release:** bump actions/setup-node from 3.5.0 to 3.5.1 ([#60](#60)) ([eaa7039](eaa7039))

github-actions · 2022-10-19T09:57:15Z

🎉 This PR is included in version 3.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

achingbrain commented Aug 30, 2022

View reviewed changes

achingbrain mentioned this pull request Aug 30, 2022

JavaScript IPLD: ESM migration tracking issue ipld/ipld#224

Open

10 tasks

chore: remove ts test invocation from node

a4d145b

BigLep assigned achingbrain Aug 30, 2022

rvagg reviewed Aug 31, 2022

View reviewed changes

RangerMauve mentioned this pull request Sep 6, 2022

v10.0.0 tracking multiformats/js-multiformats#199

Closed

5 tasks

achingbrain added 2 commits October 15, 2022 07:22

Merge remote-tracking branch 'origin/master' into feat/publish-as-esm…

1a3dade

…-only

chore: update docs and ci scripts

943a008

achingbrain mentioned this pull request Oct 17, 2022

deps!: update multiformats to 10.x.x and all @ipld/* modules ipfs/js-ipfs-unixfs#265

Merged

chore: update multiformats

6b93dd7

achingbrain marked this pull request as ready for review October 18, 2022 06:38

chore: update config

e4928d2

achingbrain merged commit 27e1076 into master Oct 19, 2022

achingbrain deleted the feat/publish-as-esm-only branch October 19, 2022 09:50

github-actions bot added the released label Oct 19, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: publish as esm-only #56

feat!: publish as esm-only #56

achingbrain commented Aug 30, 2022 •

edited

Loading

achingbrain Aug 30, 2022 •

edited

Loading

achingbrain Aug 30, 2022 •

edited

Loading

achingbrain Aug 30, 2022

RangerMauve Aug 30, 2022

achingbrain Sep 14, 2022

rvagg Aug 31, 2022

achingbrain Sep 14, 2022

rvagg Aug 31, 2022

RangerMauve Sep 6, 2022

achingbrain Sep 14, 2022

rvagg Aug 31, 2022

RangerMauve Sep 6, 2022

RangerMauve commented Oct 3, 2022

achingbrain commented Oct 15, 2022

rvagg commented Oct 17, 2022

rvagg commented Oct 17, 2022

achingbrain commented Oct 17, 2022

achingbrain commented Oct 17, 2022

achingbrain commented Oct 17, 2022

github-actions bot commented Oct 19, 2022


		An implementation of the [DAG-PB spec](https://github.com/ipld/specs/blob/master/block-layer/codecs/dag-pb.md) for JavaScript designed for use with [multiformats](https://github.com/multiformats/js-multiformats) or via the higher-level `Block` abstraction in [@ipld/block](https://github.com/ipld/js-block).

feat!: publish as esm-only #56

feat!: publish as esm-only #56

Conversation

achingbrain commented Aug 30, 2022 • edited Loading

achingbrain Aug 30, 2022 • edited Loading

Choose a reason for hiding this comment

achingbrain Aug 30, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RangerMauve commented Oct 3, 2022

achingbrain commented Oct 15, 2022

rvagg commented Oct 17, 2022

rvagg commented Oct 17, 2022

achingbrain commented Oct 17, 2022

achingbrain commented Oct 17, 2022

achingbrain commented Oct 17, 2022

github-actions bot commented Oct 19, 2022

achingbrain commented Aug 30, 2022 •

edited

Loading

achingbrain Aug 30, 2022 •

edited

Loading

achingbrain Aug 30, 2022 •

edited

Loading