Jest中Mock fs模块遇TypeScript错误及参数问题求助

我来帮你搞定这个问题！你遇到的TypeScript错误和path参数undefined的问题，大多是因为mock后的fs模块类型没有正确断言，或者mock函数的默认行为不符合预期导致的。下面一步步给你解决：

1. 基础Mock设置（快速解决TypeScript类型问题） #

当你用jest.mock('fs')之后，TypeScript并不知道原本的fs函数已经被替换成了jest.Mock类型，所以会抛出类型错误。你需要手动给mock后的fs做类型断言：

首先在测试文件顶部导入fs，然后断言它的方法为jest.Mock：

import fs from 'fs';

// 断言fs的方法为jest.Mock类型，让TypeScript识别mock函数
const mockFs = fs as jest.Mocked<typeof fs>;

之后你就可以正常设置mock返回值或自定义实现了，比如：

beforeEach(() => {
  // 重置所有mock，避免测试用例之间互相影响
  jest.clearAllMocks();
  
  // 设置existsSync的mock返回值
  mockFs.existsSync.mockReturnValue(false);
  // 自定义mkdirSync的空实现（避免触发默认校验逻辑）
  mockFs.mkdirSync.mockImplementation(() => undefined);
});

这样TypeScript就不会再抛出类型相关的错误了，因为你明确告诉它这些方法是Jest的mock函数。

2. 使用__mocks__文件夹自定义Mock #

如果你想用__mocks__文件夹统一管理fs的mock，先确保文件结构正确：

src/
  __mocks__/
    fs.ts
  your-class.ts
  your-class.test.ts

然后在__mocks__/fs.ts里导出一个全mock版本的fs模块，所有用到的方法都用jest.fn()实现：

const mockFs = {
  existsSync: jest.fn(),
  mkdirSync: jest.fn(),
  // 你业务代码中用到的其他fs方法都要在这里定义
};

export default mockFs;

之后在测试文件里依然可以用类型断言来让TypeScript识别mock函数，或者你也可以给mock文件添加类型定义，进一步优化类型提示。

3. 验证函数调用（次数、参数） #

当你需要验证mkdirSync的调用次数或传入参数时，直接用mock函数的断言方法即可：

比如验证mkdirSync被调用了一次，且传入的路径是'/test/target'：

test('should call mkdirSync with correct path', () => {
  // 实例化你的类并触发相关业务方法
  const yourClassInstance = new YourClass();
  yourClassInstance.createTargetDirectory('/test/target');

  // 断言调用次数
  expect(mockFs.mkdirSync).toHaveBeenCalledTimes(1);
  // 断言传入的参数（第二个参数如果有默认值可以用expect.anything()匹配）
  expect(mockFs.mkdirSync).toHaveBeenCalledWith('/test/target', expect.anything());
});

4. 排查"The 'path' argument must be one of type string..."错误 #

这个错误通常有两种原因：

• 业务代码传入了undefined的path：检查你的类在调用fs方法时，是否确保path参数是有效的字符串/Buffer/URL，比如有没有可能是变量未初始化导致的undefined。
• Mock函数的触发意外：你可以在测试中打印mock函数的调用记录，查看实际传入的参数是什么，快速定位问题：

console.log(mockFs.mkdirSync.mock.calls); // 打印所有调用的参数数组

按照上面的步骤来，应该就能解决你遇到的所有问题啦！

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