Move to ESM, update dependencies

[tommy-mitchell]

Closes #601.

Refactors np into ESM format and updates dependencies, fixing breaking changes.

Some notes:

• I've added a couple of ignore rules to xo to minimize diffs between updating xo's defaults. These can be removed if desired.
• version.js is now implemented as a class, with previous exports being static methods. The previous default export was a function that constructed a new Version instance, but that's hard to replicate with ESM.
• The async IIFE in cli-implementation.js has been removed in favor of a try/catch block with top-level await.
• I've added an option to np in index.js to set the listr renderer, so the index tests can use the silent renderer
• mockery, proxyquire, and execa_test_double have been dropped in favor of esmock and sinon
• Tests have been simplified via macros and utils where possible
  • Take a look at test/_utils.js for how execa is being stubbed
• Images have been moved from the repository root to a media/ folder

Todos:

• Bump Node versions / other engines, if needed
  • I've only changed the Node version in package.json. Are we dropping old Node versions? Places to change:
    • package.json
    • readme.md
    • .github/workflows/main.yml
• Update rxjs and other Observables dependencies
  • I'm not very familiar with either, so I opted to defer updating these by myself
• Update integration test to use ESM
• Resolve Support ESM only for the config file #599 - two tests fail due to cosmiconfig assuming that two .js fixtures are ESM configs when they're actually CJS

---

On the topic of updating dependencies, it might be worth moving to https://github.com/listr2/listr2 as an actively-maintained version of listr.

[tommy-mitchell]

I've gone ahead and bumped the Node workflows.

[tommy-mitchell]

Currently three tests are marked failing (integration and config issues). Everything else appears good.

[sindresorhus]

I've only changed the Node version in package.json. Are we dropping old Node versions? Places to change:

We can target Node.js 16.

On the topic of updating dependencies, it might be worth moving to https://github.com/listr2/listr2 as an actively-maintained version of listr.

👍

[tommy-mitchell]

We can target Node.js 16.

I've bumped the minimum Node and npm versions. Do the git and yarn versions need bumping too?

I think migrating to listr2 should be a separate PR.

[sindresorhus]

I've bumped the minimum Node and npm versions. Do the git and yarn versions need bumping too?

No

I think migrating to listr2 should be a separate PR.

👍

[tommy-mitchell]

A couple of solutions for the config issue:

• Use a custom ESM loader with cosmiconfig:

   const loadEsm = async filepath => import(filepath);
   
   const explorer = cosmiconfig('np', {
   	loaders: {
   		'.js': loadEsm,
   		'.mjs': loadEsm,
   	},
   });

  • cosmiconfig will likely support ESM soon (feat: Support loading ES Modules cosmiconfig/cosmiconfig#283), so this would be a temporary fix.

• Switch to https://github.com/antonk52/lilconfig, a smaller alternative to cosmiconfig which supports the same custom loader. It may also choose to support ESM if cosmiconfig does.

---

Additionally, I'm going to drop async-exit-hook in favor of the async feature in exit-hook.

[sindresorhus]

Use a custom ESM loader with cosmiconfig:

Sure. With a todo comment to move to remove the workaround when the cosmiconfig thing is resolved.

Additionally, I'm going to drop async-exit-hook in favor of the async feature in exit-hook.

👍

[tommy-mitchell]

Updated. Some caveats:

• cosmiconfig / Node can't load a .js file as ESM without a package.json with "type": "module" set. Explicitly using .mjs works. I've documented this in the readme.
• The index tests give a SYNCHRONOUS TERMINATION NOTICE because the gracefulExit() handling is in cli-implementation.js. Using the np CLI still works, though.
  • On a related note, I'm not sure wait the minimumWait should be for the hook.

[tommy-mitchell]

I've also updated RxJS, which lets us drop @samverschueren/stream-to-observable, any-observable, and split.

[tommy-mitchell]

I think migrating to listr2 should be a separate PR.

This should wait until v6 is out of beta: listr2/listr2#666

[tommy-mitchell]

Update integration test to use ESM

I've gotten rid of the external submodule and changed the integration test to initialize an empty git repo in a subfolder for testing. I've tried to make these tests as cross-platform as possible. The test command is now:

xo && ava && ava test/integration.js --no-worker-threads

Since the integration test needs to use process.chdir(), it's run separately. AVA is configured to ignore it in the first run.

---

Currently, one of the integration tests is failing, but that can be fixed in #682.

[tommy-mitchell]

I've added a couple of ignore rules to xo to minimize diffs between updating xo's defaults. These can be removed if desired.

Do you want to enable these rules? comma-dangle and object-shorthand for method properties.

Other than that and the documented .js CJS vs ESM issue with cosmiconfig, this PR is good to go.

[sindresorhus]

This should wait until v6 is out of beta: listr2/listr2#666

Can you open an issue so we don't forget?

[sindresorhus]

Do you want to enable these rules? comma-dangle and object-shorthand for method properties.

Yes

[tommy-mitchell]

Done.

[sindresorhus]

Nice work 👍👍