feat: build esm modules using ipjs

[vasco-santos]

This builds up on @achingbrain 's work on #863 with build improvements and full support

This adds:

• ipjs for ESM modules
  • auto-detected
• types property transformation, allowing real time ts check in dev and path update for dist folder (TLDR no dist in the path)
• release for ESM modules will navigate to the dist to publish its content
• Dockerfile to bundlesize action per Supporting Node.js 14 and 16 LTS as the runtime of JavaScript action actions/runner#772 (comment) as we need node14+ for ESM

One of the problematic modules in skypack using aegir is uint8arrays. It is a CJS module that depends on a ESM first module (multiformats), which makes skypack to get bad dependency paths.

I tested this out shipping uint8arrays achingbrain/uint8arrays#22 PR and everything working smoothly 🎉

Original release: https://codepen.io/vascosantos/pen/KKmXoPV?editors=0011
Scoped release using aegir: https://codepen.io/vascosantos/pen/bGWoONq?editors=0011

(see browser built in console for errors)

[vasco-santos]

Probably ipjs should take care of the types transformation per mikeal/ipjs#10 , but it might not be a concern of ipjs to consider setups like these

[vasco-santos]

ipjs is not supporting windows, trying to figure out why

[vasco-santos]

mikeal/ipjs#15 I can't simulate locally nor with a CI branch, so can we just run build on linux+mac while this gets figured out?

[achingbrain]

This will stop us running tests on windows though, right? Or can we run tests under pure ESM instead?

[vasco-santos]

well, this just makes us not test that ipjs is doing it is thing and building ESM to a dist with esm and cjs, as the only available test is that one.
It will currently not work on windows and that is a concern to have

[achingbrain]

We need to generate types from /src into /types, then copy /types and /src into /dist otherwise the paths in the ts.map files in the /types dir get all messed up (since they are generated from /src and contain relative paths) and click-through breaks.

We can't generate types from the files in /dist because they are transpiled which can have unexpected results (see also, fix).

[vasco-santos]

There was a regression here and this is failing in #master with:

AssertionError: expected promise to be fulfilled but it was rejected with 'Error: Command failed with exit code 1: /Users/vsantos/gh/tmp/aegir/cli.js dependency-check derp/foo.js\n- Checking dependencies\n✖ Checking dependencies\nCommand failed with exit code 1: dependency-check package.json .aegir.js .aegir.cjs src/**/*.js src/**/*.cjs test/**/*.js test/**/*.cjs benchmarks/**/*.js benchmarks/**/*.cjs utils/**/*.js utils/**/*.cjs !./test/fixtures/**/*.js !./test/fixtures/**/*.cjs derp/foo.js --missing -i @types/* -i @types/*\nFail! Dependencies not listed in package.json: pico'

I skipped this for now, but I will open an issue to get this fixed

[vasco-santos]

#870

[achingbrain]

Is this failing in master? Passes for me locally and CI for master is green?

The test should pass because it's only supposed to dep check the passed file, but if it's failing it means it's checking more than just the passed file - it's probably worth looking into why this is now broken as it'll almost certainly cause problems on release.

[vasco-santos]

Yes, it is failing in master too. Did you update the package lock?
Unless it got fixed in the meantime, let me try again

[vasco-santos]

➜  aegir git:(master) nrt

> aegir@34.1.0 test
> node cli.js ts -p check && node cli.js test

Test Node.js


  dependency check
    1) should pass for passed files


  0 passing (520ms)
  1 failing

  1) dependency check
       should pass for passed files:
     AssertionError: expected promise to be fulfilled but it was rejected with 'Error: Command failed with exit code 1: /Users/vsantos/work/pl/gh/tmp/aegir/cli.js dependency-check derp/foo.js\n- Checking dependencies\n✖ Checking dependencies\nCommand failed with exit code 1: dependency-check package.json .aegir.js .aegir.cjs src/**/*.js src/**/*.cjs test/**/*.js test/**/*.cjs benchmarks/**/*.js benchmarks/**/*.cjs utils/**/*.js utils/**/*.cjs !./test/fixtures/**/*.js !./test/fixtures/**/*.cjs derp/foo.js --missing -i @types/* -i @types/*\nFail! Dependencies not listed in package.json: pico'

I will reinstall all deps

[achingbrain]

Actually yeah, removing the lockfile and reinstalling now it's failing. Ugh.

[vasco-santos]

also FYI this happened without any changes in this PR, except for the docs being added. The reason to ignore this here was because this was not related to the PR and I did not want to keep this blocked on an unrelated #master problem

[vasco-santos]

(still happens for me in #master) by removing the package-lock and installing everything with Node 16)

[achingbrain]

I think yargs has started merging passed array args with the defaults for that positional. Fix: yargs/yargs#2006

[vasco-santos]

yeah, that sounds like the problem when I was trying to figure it out. Can we move forward with the PR and wait on that to be shipped to unskip the tests?

[achingbrain]

Shipped in aegir@35.0.0