refactor: update inquirer to version 9.0.6

alan-agius4 · alan-agius4 · commit 154833304a65 · 2023-10-26T14:11:39.000Z
Update the mentioned package. (cherry picked from commit a0f8fac)
diff --git a/package.json b/package.json
@@ -99,7 +99,7 @@
     "@types/express": "^4.16.0",
     "@types/http-proxy": "^1.17.4",
     "@types/ini": "^1.3.31",
-    "@types/inquirer": "^8.0.0",
+    "@types/inquirer": "^9.0.6",
     "@types/jasmine": "~5.1.0",
     "@types/karma": "^6.3.0",
     "@types/less": "^3.0.3",
@@ -150,7 +150,7 @@
     "https-proxy-agent": "7.0.2",
     "husky": "8.0.3",
     "ini": "4.1.1",
-    "inquirer": "8.2.6",
+    "inquirer": "9.2.11",
     "jasmine": "^5.0.0",
     "jasmine-core": "~5.1.0",
     "jasmine-spec-reporter": "~7.0.0",
diff --git a/packages/angular/cli/package.json b/packages/angular/cli/package.json
@@ -29,7 +29,7 @@
     "@yarnpkg/lockfile": "1.1.0",
     "ansi-colors": "4.1.3",
     "ini": "4.1.1",
-    "inquirer": "8.2.6",
+    "inquirer": "9.2.11",
     "jsonc-parser": "3.2.0",
     "npm-package-arg": "11.0.1",
     "npm-pick-manifest": "9.0.0",
diff --git a/packages/angular/cli/src/analytics/analytics.ts b/packages/angular/cli/src/analytics/analytics.ts
@@ -12,6 +12,7 @@ import type { CommandContext } from '../command-builder/command-module';
 import { colors } from '../utilities/color';
 import { getWorkspace } from '../utilities/config';
 import { analyticsDisabled } from '../utilities/environment-options';
+import { loadEsmModule } from '../utilities/load-esm';
 import { isTTY } from '../utilities/tty';
 
 /* eslint-disable no-console */
@@ -74,8 +75,8 @@ export async function promptAnalytics(
   }
 
   if (force || isTTY()) {
-    const { prompt } = await import('inquirer');
-    const answers = await prompt<{ analytics: boolean }>([
+    const { default: inquirer } = await loadEsmModule<typeof import('inquirer')>('inquirer');
+    const answers = await inquirer.prompt<{ analytics: boolean }>([
       {
         type: 'confirm',
         name: 'analytics',
diff --git a/packages/angular/cli/src/command-builder/schematics-command-module.ts b/packages/angular/cli/src/command-builder/schematics-command-module.ts
@@ -20,6 +20,7 @@ import { isPackageNameSafeForAnalytics } from '../analytics/analytics';
 import { EventCustomDimension } from '../analytics/analytics-parameters';
 import { getProjectByCwd, getSchematicDefaults } from '../utilities/config';
 import { assertIsError } from '../utilities/error';
+import { loadEsmModule } from '../utilities/load-esm';
 import { memoize } from '../utilities/memoize';
 import { isTTY } from '../utilities/tty';
 import {
@@ -234,9 +235,9 @@ export abstract class SchematicsCommandModule
           });
 
         if (questions.length) {
-          const { prompt } = await import('inquirer');
+          const { default: inquirer } = await loadEsmModule<typeof import('inquirer')>('inquirer');
 
-          return prompt(questions);
+          return inquirer.prompt(questions);
         } else {
           return {};
         }
diff --git a/packages/angular/cli/src/utilities/completion.ts b/packages/angular/cli/src/utilities/completion.ts
@@ -16,6 +16,7 @@ import { getWorkspace } from '../utilities/config';
 import { forceAutocomplete } from '../utilities/environment-options';
 import { isTTY } from '../utilities/tty';
 import { assertIsError } from './error';
+import { loadEsmModule } from './load-esm';
 
 /** Interface for the autocompletion configuration stored in the global workspace. */
 interface CompletionConfig {
@@ -180,8 +181,8 @@ async function shouldPromptForAutocompletionSetup(
 async function promptForAutocompletion(): Promise<boolean> {
   // Dynamically load `inquirer` so users don't have to pay the cost of parsing and executing it for
   // the 99% of builds that *don't* prompt for autocompletion.
-  const { prompt } = await import('inquirer');
-  const { autocomplete } = await prompt<{ autocomplete: boolean }>([
+  const { default: inquirer } = await loadEsmModule<typeof import('inquirer')>('inquirer');
+  const { autocomplete } = await inquirer.prompt<{ autocomplete: boolean }>([
     {
       name: 'autocomplete',
       type: 'confirm',
diff --git a/packages/angular/cli/src/utilities/load-esm.ts b/packages/angular/cli/src/utilities/load-esm.ts
@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+/**
+ * This uses a dynamic import to load a module which may be ESM.
+ * CommonJS code can load ESM code via a dynamic import. Unfortunately, TypeScript
+ * will currently, unconditionally downlevel dynamic import into a require call.
+ * require calls cannot load ESM code and will result in a runtime error. To workaround
+ * this, a Function constructor is used to prevent TypeScript from changing the dynamic import.
+ * Once TypeScript provides support for keeping the dynamic import this workaround can
+ * be dropped.
+ *
+ * @param modulePath The path of the module to load.
+ * @returns A Promise that resolves to the dynamically imported module.
+ */
+export function loadEsmModule<T>(modulePath: string | URL): Promise<T> {
+  return new Function('modulePath', `return import(modulePath);`)(modulePath) as Promise<T>;
+}
diff --git a/packages/angular/cli/src/utilities/prompt.ts b/packages/angular/cli/src/utilities/prompt.ts
@@ -13,6 +13,7 @@ import type {
   ListQuestion,
   Question,
 } from 'inquirer';
+import { loadEsmModule } from './load-esm';
 import { isTTY } from './tty';
 
 export async function askConfirmation(
@@ -32,8 +33,8 @@ export async function askConfirmation(
     default: defaultResponse,
   };
 
-  const { prompt } = await import('inquirer');
-  const answers = await prompt([question]);
+  const { default: inquirer } = await loadEsmModule<typeof import('inquirer')>('inquirer');
+  const answers = await inquirer.prompt([question]);
 
   return answers['confirmation'];
 }
@@ -57,8 +58,8 @@ export async function askQuestion(
     default: defaultResponseIndex,
   };
 
-  const { prompt } = await import('inquirer');
-  const answers = await prompt([question]);
+  const { default: inquirer } = await loadEsmModule<typeof import('inquirer')>('inquirer');
+  const answers = await inquirer.prompt([question]);
 
   return answers['answer'];
 }
@@ -80,8 +81,8 @@ export async function askChoices(
     choices,
   };
 
-  const { prompt } = await import('inquirer');
-  const answers = await prompt([question]);
+  const { default: inquirer } = await loadEsmModule<typeof import('inquirer')>('inquirer');
+  const answers = await inquirer.prompt([question]);
 
   return answers['answer'];
 }
diff --git a/packages/angular_devkit/build_angular/package.json b/packages/angular_devkit/build_angular/package.json
@@ -36,7 +36,7 @@
     "fast-glob": "3.3.1",
     "https-proxy-agent": "7.0.2",
     "http-proxy-middleware": "2.0.6",
-    "inquirer": "8.2.6",
+    "inquirer": "9.2.11",
     "jsonc-parser": "3.2.0",
     "karma-source-map-support": "1.4.0",
     "less": "4.2.0",
diff --git a/packages/angular_devkit/build_angular/src/utils/check-port.ts b/packages/angular_devkit/build_angular/src/utils/check-port.ts
@@ -7,6 +7,7 @@
  */
 
 import * as net from 'net';
+import { loadEsmModule } from './load-esm';
 import { isTTY } from './tty';
 
 function createInUseError(port: number): Error {
@@ -35,8 +36,8 @@ export async function checkPort(port: number, host: string): Promise<number> {
           return;
         }
 
-        import('inquirer')
-          .then(({ prompt }) =>
+        loadEsmModule<typeof import('inquirer')>('inquirer')
+          .then(({ default: { prompt } }) =>
             prompt({
               type: 'confirm',
               name: 'useDifferent',
diff --git a/packages/angular_devkit/build_angular/src/utils/load-esm.ts b/packages/angular_devkit/build_angular/src/utils/load-esm.ts
@@ -6,8 +6,6 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import { URL } from 'url';
-
 /**
  * This uses a dynamic import to load a module which may be ESM.
  * CommonJS code can load ESM code via a dynamic import. Unfortunately, TypeScript
diff --git a/packages/angular_devkit/schematics_cli/bin/schematics.ts b/packages/angular_devkit/schematics_cli/bin/schematics.ts
@@ -15,7 +15,7 @@ import { UnsuccessfulWorkflowExecution } from '@angular-devkit/schematics';
 import { NodeWorkflow } from '@angular-devkit/schematics/tools';
 import * as ansiColors from 'ansi-colors';
 import { existsSync } from 'fs';
-import * as inquirer from 'inquirer';
+import type { Question, QuestionCollection } from 'inquirer';
 import * as path from 'path';
 import yargsParser, { camelCase, decamelize } from 'yargs-parser';
 
@@ -68,9 +68,9 @@ function _listSchematics(workflow: NodeWorkflow, collectionName: string, logger:
 }
 
 function _createPromptProvider(): schema.PromptProvider {
-  return (definitions) => {
-    const questions: inquirer.QuestionCollection = definitions.map((definition) => {
-      const question: inquirer.Question = {
+  return async (definitions) => {
+    const questions: QuestionCollection = definitions.map((definition) => {
+      const question: Question = {
         name: definition.id,
         message: definition.message,
         default: definition.default,
@@ -131,6 +131,7 @@ function _createPromptProvider(): schema.PromptProvider {
           return { ...question, type: definition.type };
       }
     });
+    const { default: inquirer } = await loadEsmModule<typeof import('inquirer')>('inquirer');
 
     return inquirer.prompt(questions);
   };
@@ -487,3 +488,19 @@ if (require.main === module) {
       throw e;
     });
 }
+
+/**
+ * This uses a dynamic import to load a module which may be ESM.
+ * CommonJS code can load ESM code via a dynamic import. Unfortunately, TypeScript
+ * will currently, unconditionally downlevel dynamic import into a require call.
+ * require calls cannot load ESM code and will result in a runtime error. To workaround
+ * this, a Function constructor is used to prevent TypeScript from changing the dynamic import.
+ * Once TypeScript provides support for keeping the dynamic import this workaround can
+ * be dropped.
+ *
+ * @param modulePath The path of the module to load.
+ * @returns A Promise that resolves to the dynamically imported module.
+ */
+export function loadEsmModule<T>(modulePath: string | URL): Promise<T> {
+  return new Function('modulePath', `return import(modulePath);`)(modulePath) as Promise<T>;
+}
diff --git a/packages/angular_devkit/schematics_cli/package.json b/packages/angular_devkit/schematics_cli/package.json
@@ -19,7 +19,7 @@
     "@angular-devkit/core": "0.0.0-PLACEHOLDER",
     "@angular-devkit/schematics": "0.0.0-PLACEHOLDER",
     "ansi-colors": "4.1.3",
-    "inquirer": "8.2.6",
+    "inquirer": "9.2.11",
     "symbol-observable": "4.0.0",
     "yargs-parser": "21.1.1"
   }
diff --git a/yarn.lock b/yarn.lock
