如何为npm包Inquirer.js编写单元测试？求可行实现方案

我来帮你搞定Inquirer.js的单元测试！核心思路很简单：Inquirer的prompt是异步交互方法，测试时咱们不需要真的在终端输入，只要模拟用户的输入行为或者直接mock掉prompt的返回结果就行。下面用最常用的Jest框架来一步步演示：

步骤1：准备测试依赖 #

先确保你装好了测试相关的包：

# 纯JS项目只需安装jest
npm install --save-dev jest
# TypeScript项目额外装类型包
npm install --save-dev jest @types/jest @types/inquirer

步骤2：Mock Inquirer核心方法（最简方案） #

这种方法不需要额外工具，直接用Jest的mock功能就能完成测试。假设你的业务代码放在cli.js里：

你的业务代码（cli.js） #

const inquirer = require('inquirer');

const questions = [
  {
    type: 'input',
    name: 'email',
    message: "What's your email ?",
  },
  {
    type: 'password',
    name: 'password',
    message: 'Enter your password (it will not be saved neither communicate for other purpose than archiving)'
  }
];

async function getUserCredentials() {
  const answers = await inquirer.prompt(questions);
  // 这里是你后续处理answers的业务逻辑
  return answers;
}

module.exports = { getUserCredentials };

测试代码（cli.test.js） #

const inquirer = require('inquirer');
const { getUserCredentials } = require('./cli');

// 直接mock整个inquirer模块
jest.mock('inquirer');

describe('getUserCredentials 测试', () => {
  it('应该正确返回用户输入的邮箱和密码', async () => {
    // 模拟prompt方法的返回值
    const mockAnswers = {
      email: 'test@example.com',
      password: 'test123456'
    };
    inquirer.prompt.mockResolvedValue(mockAnswers);

    // 调用待测试的函数
    const result = await getUserCredentials();

    // 断言结果是否符合预期
    expect(result).toEqual(mockAnswers);
    // 还可以验证prompt是否被传入了正确的questions数组
    expect(inquirer.prompt).toHaveBeenCalledWith(questions);
  });
});

步骤3：模拟真实输入流程（进阶方案） #

如果需要测试更复杂的交互场景（比如用户输入错误后重新输入），可以用mock-inquirer包模拟终端输入流：

安装mock-inquirer #

npm install --save-dev mock-inquirer

进阶测试示例 #

const mockInquirer = require('mock-inquirer');
const { getUserCredentials } = require('./cli');

describe('getUserCredentials 复杂场景测试', () => {
  it('应该处理用户先输入空邮箱，再输入正确值的情况', async () => {
    // 模拟用户依次输入：空字符串 → 正确邮箱 → 密码
    mockInquirer.mockAnswers(['', 'test@example.com', 'test123456']);
    
    // 假设你的业务代码会循环询问直到邮箱非空
    const result = await getUserCredentials();
    
    expect(result.email).toBe('test@example.com');
    expect(result.password).toBe('test123456');
  });
});

常见坑点排查 #

• 如果测试一直卡住不动，大概率是真实的Inquirerprompt方法没被mock住，导致测试在等待终端输入。一定要确认jest.mock('inquirer')生效，或者用mock-inquirer替换掉真实的inquirer实例。
• TypeScript项目记得配置jest.config.js，用ts-jest来处理TS文件的编译。

内容的提问来源于stack exchange，提问作者Oscar