Switch from CJS to ESM #859

tjlahr · 2025-03-20T14:52:37Z

WIP / HOLD MERGE

tabtab autocompletion relies on module.parent and doesn't work with ESM
personally, I had difficulties getting tabtab to work even on main (generators showing up as "[object Object]" for example)
I'm skipping the broken tabtab test for now, while the rest of the change is under review.
Would love any suggestions on how to solve for old tabtab.

This PR migrates Yo to ECMAScript modules (ESM).

Most of the lines changed are related to the import/export syntax itself.

However, a few libraries and techniques had to be updated in order to work around older and non-ESM issue. I've listed those changes below.

Purpose of this pull request?

Switch from CJS to ESM in order to solve issue 787.

What changes did you make?

switch project to type=module
adopt import/export syntax throughout codebase
update meow (ESM support since v10)
remove global-tunnel-ng branch since we're > Node 10
replace proxyquire (no ESM) with testdouble
replace nyc (no ESM) with c8
shim __dirname
remove unused --no-update-notifier in CLI

Is there anything you'd like reviewers to focus on?

* switch project to type=module * adopt import/export syntax throughout codebase * update meow (ESM support since v10) * remove global-tunnel-ng branch since we're > Node 10 * replace proxyquire (no ESM) with testdouble * replace nyc (no ESM) with c8 * shim __dirname * remove unused --no-update-notifier in CLI * [WIP] disable failing tabtab test

socket-security · 2025-03-20T14:53:03Z

New, updated, and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	Transitive: environment, filesystem, shell	`+37`	2.85 MB
npm/[email protected] ➜ 13.2.0	None	`0`	419 kB	sindresorhus
npm/[email protected]	None	`+4`	14.3 kB	sindresorhus

🚮 Removed packages: npm/[email protected]

View full report↗︎

tjlahr · 2025-03-20T14:59:01Z

lib/cli.js

-  // `global-tunnel-ng` works only with Node.js v10 and below.
-  require('global-tunnel-ng').initialize();
-}
+bootstrap();


We can eliminate this branching because we're > Node 10.
Simply import and call bootstrap.

tjlahr · 2025-03-20T14:59:33Z

lib/cli.js


 const cli = gens.map(gen => {
-  const minicli = meow({autoHelp: false, autoVersion: true, pkg, argv: gen});
+  const minicli = meow({autoHelp: false, autoVersion: true, pkg, argv: gen, importMeta: import.meta});


Small tweak to support the latest meow version.

tjlahr · 2025-03-20T15:00:17Z

lib/cli.js

+  router.registerRoute('install', routes.install);
+  router.registerRoute('exit', routes.exit);
+  router.registerRoute('clearConfig', routes.clearConfig);
+  router.registerRoute('home', routes.home);


I collected these into a routes object that can be imported at once.

tjlahr · 2025-03-20T15:01:59Z

lib/routes/home.js


  return fullname().then(name => {
-    const allo = (name && isString(name)) ? `'Allo ${name.split(' ')[0]}! ` : '\'Allo! ';
+    const allo = (name && _.isString(name)) ? `'Allo ${name.split(' ')[0]}! ` : '\'Allo! ';


I will occasionally inline lodash if it's a one-off and the specific method was imported directly.

tjlahr · 2025-03-20T15:05:07Z

lib/utils/node-shims.js

+ */
+export const getDirname = fileUrl => {
+  return path.dirname(fileURLToPath(fileUrl));
+};


__dirname shim.

I did not write a corresponding test for this because __dirname is used all over the place anyway and failures here would show up as failures there. Also, it's tiny and the test would be 99% mock setup.

tjlahr · 2025-03-20T15:08:29Z

package.json

-    "test": "nyc mocha --timeout=30000",
-    "coverage": "nyc report --reporter=text-lcov | coveralls"
+    "test": "c8 mocha --timeout=30000",
+    "coverage": "c8 report --reporter=text-lcov | coveralls"


nyc doesn't provide coverage for ESM projects (Nyc on ESM Node.js 13 (no babel) istanbuljs/nyc#1287)

esm-loader-hook is promising but experimental (https://github.com/istanbuljs/esm-loader-hook)

c8 is a fully-compatible replacement that worked immediately

tjlahr · 2025-03-20T15:11:05Z

package.json

-    "proxyquire": "^2.0.1",
    "registry-url": "^5.1.0",
    "sinon": "^19.0.2",
+    "testdouble": "^3.20.2",


Also considered sinon and rewiremock as alternatives here but this was the most seamless.

If this were my project, I'd switch to jest and use their module mocking.

We have adopted vitest in some packages.

tjlahr · 2025-03-20T15:12:07Z

test/cli.js

    const cp = execFile('node', [
      path.resolve(__dirname, '..', pkg.bin.yo),
-      '--version',
-      '--no-update-notifier'


I couldn't find any evidence that this is used anywhere.

tjlahr · 2025-03-20T15:12:40Z

test/completion.js

  });

-  describe('Test completion STDOUT output', () => {
+  describe.skip('Test completion STDOUT output', () => {


WIP - see comment about tabtab relying on module.parent

mshima · 2025-04-04T16:31:22Z

@tjlahr can we merge to a branch to make easier to contribute?

tjlahr · 2025-04-04T17:21:12Z

@mshima That's fine. What branch would you like to merge this to?

mshima · 2025-04-04T17:44:23Z

I will create a new one.

* Switch from CJS to ESM (#859) * Fix 787 - Switch from CJS to ESM * switch project to type=module * adopt import/export syntax throughout codebase * update meow (ESM support since v10) * remove global-tunnel-ng branch since we're > Node 10 * replace proxyquire (no ESM) with testdouble * replace nyc (no ESM) with c8 * shim __dirname * remove unused --no-update-notifier in CLI * [WIP] disable failing tabtab test * Make sure we're resetting td mocks * Delete .nyc_output directory * revert tab completion to cjs * adjust autocomplete binary * re-add --no-update-notifier * disable update-notifier using env * remove console.log leftover --------- Co-authored-by: Thomas Lahr <[email protected]>

tjlahr commented Mar 20, 2025

View reviewed changes

Make sure we're resetting td mocks

93f9306

tjlahr mentioned this pull request Mar 20, 2025

Switch from CJS (CommonJS) to ESM (ECMAScript Modules) #787

Closed

mshima changed the base branch from main to esm April 4, 2025 17:45

mshima merged commit d30469c into yeoman:esm Apr 4, 2025
11 checks passed

tjlahr deleted the 787-switch-from-cjs-to-esm branch April 4, 2025 17:53

mshima mentioned this pull request Apr 4, 2025

Convert to ESM #862

Merged

4 tasks

mshima mentioned this pull request Apr 10, 2025

Track yo v6 release. #882

Closed

Uh oh!

Switch from CJS to ESM #859

Switch from CJS to ESM #859

Uh oh!

Conversation

tjlahr commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of this pull request?

What changes did you make?

Is there anything you'd like reviewers to focus on?

Uh oh!

socket-security bot commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mshima commented Apr 4, 2025

Uh oh!

tjlahr commented Apr 4, 2025

Uh oh!

mshima commented Apr 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tjlahr commented Mar 20, 2025 •

edited

Loading

socket-security bot commented Mar 20, 2025 •

edited

Loading