Convert to ESM (#862)

* 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]>

Author: mshima

.gitignore

@@ -1,4 +1,4 @@
 node_modules
 yarn.lock
-.nyc_output
+coverage
 .project

lib/cli.js

@@ -1,39 +1,28 @@
 #!/usr/bin/env node
 'use strict';
-const fs = require('fs');
-const path = require('path');
-const chalk = require('chalk');
-const updateNotifier = require('update-notifier');
-const yosay = require('yosay');
-const stringLength = require('string-length');
-const rootCheck = require('root-check');
-const meow = require('meow');
-const list = require('cli-list');
-const Tabtab = require('tabtab');
-const pkg = require('../package.json');
-const Router = require('./router');
-
+import fs from 'node:fs';
+import path from 'node:path';
+import chalk from 'chalk';
+import updateNotifier from 'update-notifier';
+import yosay from 'yosay';
+import stringLength from 'string-length';
+import rootCheck from 'root-check';
+import meow from 'meow';
+import list from 'cli-list';
+import tabtab from './completion/tabtab.cjs';
+import pkg from './utils/project-package.js';
+import Router from './router.js';
+import {bootstrap} from 'global-agent';
+import * as routes from './routes/index.js';
+import {getDirname} from './utils/node-shims.js';
+
+const __dirname = getDirname(import.meta.url);
 const gens = list(process.argv.slice(2));
 
-// Override http networking to go through a proxy ifone is configured
-const MAJOR_NODEJS_VERSION = Number.parseInt(process.version.slice(1).split('.')[0], 10);
-
-if (MAJOR_NODEJS_VERSION >= 10) {
-  // `global-agent` works with Node.js v10 and above.
-  require('global-agent').bootstrap();
-} else {
-  // `global-tunnel-ng` works only with Node.js v10 and below.
-  require('global-tunnel-ng').initialize();
-}
-
-/* eslint new-cap: 0, no-extra-parens: 0 */
-const tabtab = new Tabtab.Commands.default({
-  name: 'yo',
-  completer: 'yo-complete'
-});
+bootstrap();
 
 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});
   const options = minicli.flags;
   const args = minicli.input;
 
@@ -66,7 +55,9 @@ function updateCheck() {
 async function pre() {
   // Debugging helper
   if (cmd === 'doctor') {
-    require('yeoman-doctor')();
+    // eslint-disable-next-line node/no-unsupported-features/es-syntax
+    const yeomanDoctor = (await import('yeoman-doctor')).default;
+    yeomanDoctor();
     return;
   }
 
@@ -76,7 +67,9 @@ async function pre() {
 
   // Easteregg
   if (cmd === 'yeoman' || cmd === 'yo') {
-    console.log(require('yeoman-character'));
+    // eslint-disable-next-line node/no-unsupported-features/es-syntax
+    const yeomanCharacter = (await import('yeoman-character')).default;
+    console.log(yeomanCharacter);
     return;
   }
 
@@ -171,13 +164,13 @@ async function init() {
 
 function runYo(env) {
   const router = new Router(env);
-  router.registerRoute('help', require('./routes/help'));
-  router.registerRoute('update', require('./routes/update'));
-  router.registerRoute('run', require('./routes/run'));
-  router.registerRoute('install', require('./routes/install'));
-  router.registerRoute('exit', require('./routes/exit'));
-  router.registerRoute('clearConfig', require('./routes/clear-config'));
-  router.registerRoute('home', require('./routes/home'));
+  router.registerRoute('help', routes.help);
+  router.registerRoute('update', routes.update);
+  router.registerRoute('run', routes.run);
+  router.registerRoute('install', routes.install);
+  router.registerRoute('exit', routes.exit);
+  router.registerRoute('clearConfig', routes.clearConfig);
+  router.registerRoute('home', routes.home);
 
   process.once('exit', router.navigate.bind(router, 'exit'));
 

lib/completion/completer.js lib/completion/completer.cjslib/completion/completer.js renamed to lib/completion/completer.cjs

@@ -4,7 +4,7 @@ const tabtab = require('tabtab')({
   name: 'yo',
   cache: !process.env.YO_TEST
 });
-const Completer = require('./completer');
+const Completer = require('./completer.cjs');
 
 (async () => {
   // eslint-disable-next-line node/no-unsupported-features/es-syntax

lib/completion/index.js lib/completion/index.cjslib/completion/index.js renamed to lib/completion/index.cjs

@@ -0,0 +1,10 @@
+const Tabtab = require('tabtab');
+
+// eslint-disable-next-line new-cap
+const tabtab = new Tabtab.Commands.default({
+  name: 'yo',
+  completer: 'yo-complete',
+  cache: false
+});
+
+module.exports = tabtab;

lib/completion/tabtab.cjs

@@ -1,21 +1,21 @@
 'use strict';
-const path = require('path');
-const titleize = require('titleize');
-const humanizeString = require('humanize-string');
-const readPkgUp = require('read-pkg-up');
-const updateNotifier = require('update-notifier');
-const Configstore = require('configstore');
-const {namespaceToName} = require('./utils/namespace');
+import path from 'path';
+import titleize from 'titleize';
+import humanizeString from 'humanize-string';
+import readPkgUp from 'read-pkg-up';
+import updateNotifier from 'update-notifier';
+import Configstore from 'configstore';
+import {namespaceToName} from './utils/namespace.js';
+import pkg from './utils/project-package.js';
 
 /**
  * The router is in charge of handling `yo` different screens.
  * @constructor
  * @param  {Environment} env A yeoman environment instance
  * @param  {Configstore} [conf] An optional config store instance
  */
-class Router {
+export default class Router {
   constructor(env, conf) {
-    const pkg = require('../package.json');
     this.routes = {};
     this.env = env;
     this.conf = conf || new Configstore(pkg.name, {
@@ -83,5 +83,3 @@ class Router {
     }
   }
 }
-
-module.exports = Router;

lib/router.js

@@ -1,11 +1,11 @@
 'use strict';
-const _ = require('lodash');
-const chalk = require('chalk');
-const inquirer = require('inquirer');
-const globalConfig = require('../utils/global-config');
-const {namespaceToName} = require('../utils/namespace');
+import _ from 'lodash';
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import globalConfig from '../utils/global-config.js';
+import {namespaceToName} from '../utils/namespace.js';
 
-module.exports = async app => {
+export const clearConfig = async app => {
   const defaultChoices = [
     {
       name: 'Take me back home, Yo!',

lib/routes/clear-config.js

@@ -1,7 +1,7 @@
 'use strict';
-const yosay = require('yosay');
+import yosay from 'yosay';
 
-module.exports = async () => {
+export const exit = async () => {
   const PADDING = 5;
   const url = 'http://yeoman.io';
   const maxLength = url.length + PADDING;

lib/routes/exit.js

@@ -1,8 +1,8 @@
 'use strict';
-const inquirer = require('inquirer');
-const open = require('open');
+import inquirer from 'inquirer';
+import open from 'open';
 
-module.exports = async app => {
+export const help = async app => {
   return inquirer.prompt([{
     name: 'whereTo',
     type: 'list',

lib/routes/help.js

@@ -1,13 +1,12 @@
 'use strict';
-const _ = require('lodash');
-const chalk = require('chalk');
-const fullname = require('fullname');
-const inquirer = require('inquirer');
-const {isString} = require('lodash');
-const {namespaceToName} = require('../utils/namespace');
-const globalConfigHasContent = require('../utils/global-config').hasContent;
+import _ from 'lodash';
+import chalk from 'chalk';
+import fullname from 'fullname';
+import inquirer from 'inquirer';
+import {namespaceToName} from '../utils/namespace.js';
+import globalConfig from '../utils/global-config.js';
 
-module.exports = async app => {
+export const home = async app => {
   const defaultChoices = [{
     name: 'Install a generator',
     value: 'install'
@@ -19,7 +18,7 @@ module.exports = async app => {
     value: 'exit'
   }];
 
-  if (globalConfigHasContent()) {
+  if (globalConfig.hasContent()) {
     defaultChoices.splice(-1, 0, {
       name: 'Clear global config',
       value: 'clearConfig'
@@ -53,7 +52,7 @@ module.exports = async app => {
   }
 
   return fullname().then(name => {
-    const allo = (name && isString(name)) ? `'Allo ${name.split(' ')[0]}! ` : '\'Allo! ';
+    const allo = (name && _.isString(name)) ? `'Allo ${name.split(' ')[0]}! ` : '\'Allo! ';
 
     return inquirer.prompt([{
       name: 'whatNext',