如何在Visual Studio Code中用Mocha对TypeScript进行测试

mkdir ts-mocha-demo && cd ts-mocha-demo
npm init -y  # 生成package.json，-y表示使用默认配置

# 安装开发依赖
npm install --save-dev \
  typescript \  # TypeScript编译器
  mocha \       # 测试框架
  ts-node \     # 直接运行TypeScript文件（无需预编译）
  @types/mocha \ # Mocha的TypeScript类型定义
  @types/node \  # Node.js的TypeScript类型定义
  chai \        # 断言库（可选，替代Node内置assert）
  @types/chai   # Chai的TypeScript类型定义

{
  "compilerOptions": {
    "target": "ES2020",          // 编译目标ES版本（根据项目需求调整）
    "module": "CommonJS",        // 模块系统（Mocha默认支持CommonJS）
    "outDir": "./dist",          // 编译输出目录
    "rootDir": "./src",          // 源代码根目录
    "strict": true,              // 启用严格模式（推荐）
    "esModuleInterop": true,     // 允许CommonJS和ES模块互操作
    "skipLibCheck": true,        // 跳过库类型检查（加速编译）
    "forceConsistentCasingInFileNames": true  // 强制文件名大小写一致
  },
  "include": ["src/**/*"],       // 包含的源代码文件
  "exclude": ["node_modules", "**/*.test.ts"]  // 排除测试文件（测试文件由ts-node直接处理）
}

{
  "extension": ["ts"],          // 测试文件扩展名
  "spec": "src/**/*.test.ts",   // 测试文件路径匹配模式（** 表示递归子目录）
  "require": ["ts-node/register"],  // 运行前加载ts-node/register，用于解析TypeScript
  "timeout": 5000,              // 单测超时时间（默认2000ms，异步测试可适当延长）
  "ui": "bdd",                  // 测试接口风格（BDD：describe/it，TDD：suite/test等）
  "reporter": "spec"            // 测试报告格式（spec：详细输出，dot：简洁点模式等）
}

{
  "scripts": {
    "test": "mocha",                  // 运行所有测试
    "test:watch": "mocha --watch",    // 监听文件变化并重新运行测试
    "test:grep": "mocha --grep '关键词'"  // 只运行名称包含"关键词"的测试
  }
}

// src/utils/math.ts
export function add(a: number, b: number): number {
  return a + b;
}
 
export function multiply(a: number, b: number): number {
  return a * b;
}
 
export function divide(a: number, b: number): number {
  if (b === 0) {
    throw new Error("除数不能为0");
  }
  return a / b;
}

// src/utils/math.test.ts
import { expect } from "chai";  // 引入Chai的expect断言
import { add, multiply, divide } from "./math";
 
// 测试套件（describe块）：对math模块的测试
describe("math工具函数", () => {
  // 测试用例（it块）：测试add函数
  it("add(2, 3) 应返回5", () => {
    expect(add(2, 3)).to.equal(5);
  });
 
  // 测试multiply函数
  it("multiply(4, 5) 应返回20", () => {
    expect(multiply(4, 5)).to.equal(20);
  });
 
  // 测试divide函数（正常情况）
  it("divide(10, 2) 应返回5", () => {
    expect(divide(10, 2)).to.equal(5);
  });
 
  // 测试divide函数（异常情况：除数为0）
  it("divide(10, 0) 应抛出错误", () => {
    expect(() => divide(10, 0)).to.throw("除数不能为0");
  });
});

npm test  # 运行所有测试

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Mocha 测试",
      "type": "node",
      "request": "launch",
      "runtimeArgs": ["--require", "ts-node/register", "node_modules/mocha/bin/mocha"],
      "args": ["src/**/*.test.ts"],  // 测试文件路径
      "console": "integratedTerminal",
      "internalConsoleOptions": "neverOpen"
    }
  ]
}

describe("测试钩子示例", () => {
  let num: number;
 
  // 每个it执行前重置num
  beforeEach(() => {
    num = 0;
  });
 
  it("num初始值为0", () => {
    expect(num).to.equal(0);
  });
 
  it("修改num后应为1", () => {
    num = 1;
    expect(num).to.equal(1);
  });
});

npm install --save-dev nyc @istanbuljs/nyc-config-typescript

{
  "scripts": {
    "test:coverage": "nyc --reporter=html mocha"
  }
}

"compilerOptions": {
  "sourceMap": true  // 生成.map文件，用于调试映射
}