Replace inquirer with @inquirer/* packages

Copilot · dmichon-msft · dmichon-msft · commit 1294e90ae61a · 2026-04-17T22:57:45.000Z
Agent-Logs-Url: https://github.com/microsoft/rushstack/sessions/489f4c8b-19ff-4dd2-9198-b68f948590c4 Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>
diff --git a/common/config/rush/nonbrowser-approved-packages.json b/common/config/rush/nonbrowser-approved-packages.json
@@ -26,6 +26,26 @@
       "name": "@eslint/eslintrc",
       "allowedCategories": [ "libraries" ]
     },
+    {
+      "name": "@inquirer/checkbox",
+      "allowedCategories": [ "libraries" ]
+    },
+    {
+      "name": "@inquirer/confirm",
+      "allowedCategories": [ "libraries" ]
+    },
+    {
+      "name": "@inquirer/input",
+      "allowedCategories": [ "libraries" ]
+    },
+    {
+      "name": "@inquirer/search",
+      "allowedCategories": [ "libraries" ]
+    },
+    {
+      "name": "@inquirer/select",
+      "allowedCategories": [ "libraries" ]
+    },
     {
       "name": "@jest/core",
       "allowedCategories": [ "libraries" ]
@@ -794,10 +814,6 @@
       "name": "import-lazy",
       "allowedCategories": [ "libraries" ]
     },
-    {
-      "name": "inquirer",
-      "allowedCategories": [ "libraries" ]
-    },
     {
       "name": "jest",
       "allowedCategories": [ "libraries", "tests" ]
diff --git a/libraries/rush-lib/package.json b/libraries/rush-lib/package.json
@@ -62,12 +62,15 @@
     "dependency-path": "~9.2.8",
     "dotenv": "~16.4.7",
     "fast-glob": "~3.3.1",
-    "figures": "3.0.0",
     "git-repo-info": "~2.1.0",
     "glob-escape": "~0.0.2",
     "https-proxy-agent": "~5.0.0",
     "ignore": "~5.1.6",
-    "inquirer": "~8.2.7",
+    "@inquirer/checkbox": "~5.1.3",
+    "@inquirer/confirm": "~6.0.11",
+    "@inquirer/input": "~5.0.11",
+    "@inquirer/search": "~4.1.7",
+    "@inquirer/select": "~5.1.3",
     "js-yaml": "~4.1.0",
     "npm-package-arg": "~6.1.0",
     "object-hash": "3.0.0",
@@ -89,7 +92,6 @@
     "@rushstack/webpack-deep-imports-plugin": "workspace:*",
     "@rushstack/webpack-preserve-dynamic-require-plugin": "workspace:*",
     "@types/cli-table": "0.3.0",
-    "@types/inquirer": "7.3.1",
     "@types/js-yaml": "4.0.9",
     "@types/npm-package-arg": "6.1.0",
     "@types/object-hash": "~3.0.6",
diff --git a/libraries/rush-lib/src/cli/actions/ChangeAction.ts b/libraries/rush-lib/src/cli/actions/ChangeAction.ts
@@ -4,7 +4,6 @@
 import * as path from 'node:path';
 import * as child_process from 'node:child_process';
 
-import type * as InquirerType from 'inquirer';
 
 import type {
   CommandLineFlagParameter,
@@ -246,8 +245,6 @@ export class ChangeAction extends BaseRushAction {
 
     await this._warnUnstagedChangesAsync();
 
-    const inquirer: typeof InquirerType = await import('inquirer');
-    const promptModule: InquirerType.PromptModule = inquirer.createPromptModule();
     let changeFileData: Map<string, IChangeFile> = new Map<string, IChangeFile>();
     let interactiveMode: boolean = false;
     if (this._bulkChangeParameter.value) {
@@ -323,15 +320,14 @@ export class ChangeAction extends BaseRushAction {
         await this._getChangeFilesSinceBaseBranchAsync()
       );
       changeFileData = await this._promptForChangeFileDataAsync(
-        promptModule,
         sortedProjectList,
         existingChangeComments
       );
 
       if (this._isEmailRequired(changeFileData)) {
         const email: string = this._changeEmailParameter.value
           ? this._changeEmailParameter.value
-          : await this._detectOrAskForEmailAsync(promptModule);
+          : await this._detectOrAskForEmailAsync();
         changeFileData.forEach((changeFile: IChangeFile) => {
           changeFile.email = this.rushConfiguration.getProjectByName(changeFile.packageName)?.versionPolicy
             ?.includeEmailInChangeFile
@@ -343,7 +339,6 @@ export class ChangeAction extends BaseRushAction {
     let changefiles: string[];
     try {
       changefiles = await this._writeChangeFilesAsync(
-        promptModule,
         changeFileData,
         this._overwriteFlagParameter.value,
         interactiveMode
@@ -528,15 +523,13 @@ export class ChangeAction extends BaseRushAction {
    * The main loop which prompts the user for information on changed projects.
    */
   private async _promptForChangeFileDataAsync(
-    promptModule: InquirerType.PromptModule,
     sortedProjectList: string[],
     existingChangeComments: Map<string, string[]>
   ): Promise<Map<string, IChangeFile>> {
     const changedFileData: Map<string, IChangeFile> = new Map<string, IChangeFile>();
 
     for (const projectName of sortedProjectList) {
       const changeInfo: IChangeInfo | undefined = await this._askQuestionsAsync(
-        promptModule,
         projectName,
         existingChangeComments
       );
@@ -563,7 +556,6 @@ export class ChangeAction extends BaseRushAction {
    * Asks all questions which are needed to generate changelist for a project.
    */
   private async _askQuestionsAsync(
-    promptModule: InquirerType.PromptModule,
     packageName: string,
     existingChangeComments: Map<string, string[]>
   ): Promise<IChangeInfo | undefined> {
@@ -574,11 +566,10 @@ export class ChangeAction extends BaseRushAction {
       comments.forEach((comment) => {
         this.terminal.writeLine(`    > ${comment}`);
       });
-      const { appendComment }: { appendComment: 'skip' | 'append' } = await promptModule({
-        name: 'appendComment',
-        type: 'list',
-        default: 'skip',
+      const { default: select } = await import('@inquirer/select');
+      const appendComment: 'skip' | 'append' = await select<'skip' | 'append'>({
         message: 'Append to existing comments or skip?',
+        default: 'skip',
         choices: [
           {
             name: 'Skip',
@@ -594,23 +585,19 @@ export class ChangeAction extends BaseRushAction {
       if (appendComment === 'skip') {
         return undefined;
       } else {
-        return await this._promptForCommentsAsync(promptModule, packageName);
+        return await this._promptForCommentsAsync(packageName);
       }
     } else {
-      return await this._promptForCommentsAsync(promptModule, packageName);
+      return await this._promptForCommentsAsync(packageName);
     }
   }
 
   private async _promptForCommentsAsync(
-    promptModule: InquirerType.PromptModule,
     packageName: string
   ): Promise<IChangeInfo | undefined> {
     const bumpOptions: { [type: string]: string } = this._getBumpOptions(packageName);
-    const { comment }: { comment: string } = await promptModule({
-      name: 'comment',
-      type: 'input',
-      message: `Describe changes, or ENTER if no changes:`
-    });
+    const { default: input } = await import('@inquirer/input');
+    const comment: string = await input({ message: `Describe changes, or ENTER if no changes:` });
 
     if (Object.keys(bumpOptions).length === 0 || !comment) {
       return {
@@ -619,17 +606,16 @@ export class ChangeAction extends BaseRushAction {
         type: ChangeType[ChangeType.none]
       } as IChangeInfo;
     } else {
-      const { bumpType }: { bumpType: string } = await promptModule({
+      const { default: select } = await import('@inquirer/select');
+      const bumpType: string = await select<string>({
         choices: Object.keys(bumpOptions).map((option) => {
           return {
             value: option,
             name: bumpOptions[option]
           };
         }),
         default: 'patch',
-        message: 'Select the type of change:',
-        name: 'bumpType',
-        type: 'list'
+        message: 'Select the type of change:'
       });
 
       return {
@@ -693,10 +679,10 @@ export class ChangeAction extends BaseRushAction {
    * Will determine a user's email by first detecting it from their Git config,
    * or will ask for it if it is not found or the Git config is wrong.
    */
-  private async _detectOrAskForEmailAsync(promptModule: InquirerType.PromptModule): Promise<string> {
+  private async _detectOrAskForEmailAsync(): Promise<string> {
     return (
-      (await this._detectAndConfirmEmailAsync(promptModule)) ||
-      (await this._promptForEmailAsync(promptModule))
+      (await this._detectAndConfirmEmailAsync()) ||
+      (await this._promptForEmailAsync())
     );
   }
 
@@ -716,20 +702,15 @@ export class ChangeAction extends BaseRushAction {
    * Detects the user's email address from their Git configuration, prompts the user to approve the
    * detected email. It returns undefined if it cannot be detected.
    */
-  private async _detectAndConfirmEmailAsync(
-    promptModule: InquirerType.PromptModule
-  ): Promise<string | undefined> {
+  private async _detectAndConfirmEmailAsync(): Promise<string | undefined> {
     const email: string | undefined = this._detectEmail();
 
     if (email) {
-      const { isCorrectEmail }: { isCorrectEmail: boolean } = await promptModule([
-        {
-          type: 'confirm',
-          name: 'isCorrectEmail',
-          default: 'Y',
-          message: `Is your email address ${email}?`
-        }
-      ]);
+      const { default: confirm } = await import('@inquirer/confirm');
+      const isCorrectEmail: boolean = await confirm({
+        message: `Is your email address ${email}?`,
+        default: true
+      });
       return isCorrectEmail ? email : undefined;
     } else {
       return undefined;
@@ -739,18 +720,14 @@ export class ChangeAction extends BaseRushAction {
   /**
    * Asks the user for their email address
    */
-  private async _promptForEmailAsync(promptModule: InquirerType.PromptModule): Promise<string> {
-    const { email }: { email: string } = await promptModule([
-      {
-        type: 'input',
-        name: 'email',
-        message: 'What is your email address?',
-        validate: (input: string) => {
-          return true; // @todo should be an email
-        }
+  private async _promptForEmailAsync(): Promise<string> {
+    const { default: input } = await import('@inquirer/input');
+    return await input({
+      message: 'What is your email address?',
+      validate: (value: string) => {
+        return true; // @todo should be an email
       }
-    ]);
-    return email;
+    });
   }
 
   private async _warnUnstagedChangesAsync(): Promise<void> {
@@ -774,15 +751,13 @@ export class ChangeAction extends BaseRushAction {
    * Writes change files to the common/changes folder. Will prompt for overwrite if file already exists.
    */
   private async _writeChangeFilesAsync(
-    promptModule: InquirerType.PromptModule,
     changeFileData: Map<string, IChangeFile>,
     overwrite: boolean,
     interactiveMode: boolean
   ): Promise<string[]> {
     const writtenFiles: string[] = [];
     await changeFileData.forEach(async (changeFile: IChangeFile) => {
       const writtenFile: string | undefined = await this._writeChangeFileAsync(
-        promptModule,
         changeFile,
         overwrite,
         interactiveMode
@@ -795,7 +770,6 @@ export class ChangeAction extends BaseRushAction {
   }
 
   private async _writeChangeFileAsync(
-    promptModule: InquirerType.PromptModule,
     changeFileData: IChangeFile,
     overwrite: boolean,
     interactiveMode: boolean
@@ -808,7 +782,7 @@ export class ChangeAction extends BaseRushAction {
     const shouldWrite: boolean =
       !fileExists ||
       overwrite ||
-      (interactiveMode ? await this._promptForOverwriteAsync(promptModule, filePath) : false);
+      (interactiveMode ? await this._promptForOverwriteAsync(filePath) : false);
 
     if (!interactiveMode && fileExists && !overwrite) {
       throw new Error(`Changefile ${filePath} already exists`);
@@ -821,16 +795,12 @@ export class ChangeAction extends BaseRushAction {
   }
 
   private async _promptForOverwriteAsync(
-    promptModule: InquirerType.PromptModule,
     filePath: string
   ): Promise<boolean> {
-    const overwrite: boolean = await promptModule([
-      {
-        name: 'overwrite',
-        type: 'confirm',
-        message: `Overwrite ${filePath}?`
-      }
-    ]);
+    const { default: confirm } = await import('@inquirer/confirm');
+    const overwrite: boolean = await confirm({
+      message: `Overwrite ${filePath}?`
+    });
 
     if (overwrite) {
       return true;
diff --git a/libraries/rush-lib/src/logic/InteractiveUpgrader.ts b/libraries/rush-lib/src/logic/InteractiveUpgrader.ts
@@ -1,15 +1,12 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import Prompt from 'inquirer/lib/ui/prompt';
-
 import { NpmCheck, type INpmCheckState, type INpmCheckPackageSummary } from '@rushstack/npm-check-fork';
 import { Colorize } from '@rushstack/terminal';
 
 import type { RushConfiguration } from '../api/RushConfiguration';
 import { upgradeInteractive, type IDepsToUpgradeAnswers } from '../utilities/InteractiveUpgradeUI';
 import type { RushConfigurationProject } from '../api/RushConfigurationProject';
-import { SearchListPrompt } from '../utilities/prompts/SearchListPrompt';
 
 interface IUpgradeInteractiveDeps {
   projects: RushConfigurationProject[];
@@ -42,26 +39,27 @@ export class InteractiveUpgrader {
 
   private async _getUserSelectedProjectForUpgradeAsync(): Promise<RushConfigurationProject> {
     const projects: RushConfigurationProject[] | undefined = this._rushConfiguration.projects;
-    const ui: Prompt = new Prompt({
-      list: SearchListPrompt
-    });
 
-    const { selectProject } = await ui.run([
-      {
-        name: 'selectProject',
-        message: 'Select a project you would like to upgrade',
-        type: 'list',
-        choices: projects.map((project) => {
-          return {
+    const { default: search } = await import('@inquirer/search');
+
+    return await search<RushConfigurationProject>({
+      message: 'Select a project you would like to upgrade',
+      source: (term) => {
+        const choices: { name: string; short: string; value: RushConfigurationProject }[] = projects.map(
+          (project) => ({
             name: Colorize.green(project.packageName),
+            short: project.packageName,
             value: project
-          };
-        }),
-        pageSize: 12
-      }
-    ]);
-
-    return selectProject;
+          })
+        );
+        if (!term) {
+          return choices;
+        }
+        const filter: string = term.toUpperCase();
+        return choices.filter((choice) => choice.short.toUpperCase().includes(filter));
+      },
+      pageSize: 12
+    });
   }
 
   private async _getPackageDependenciesStatusAsync(
diff --git a/libraries/rush-lib/src/utilities/InteractiveUpgradeUI.ts b/libraries/rush-lib/src/utilities/InteractiveUpgradeUI.ts
diff --git a/libraries/rush-lib/src/utilities/prompts/SearchListPrompt.ts b/libraries/rush-lib/src/utilities/prompts/SearchListPrompt.ts
