同时使用mocha、jest类型定义时出现TS2403类型冲突问题
同时使用Jest与Mocha的TypeScript类型冲突合规解决方案
冲突根因
- 所有报错均来自全局作用域类型重名:Jest与Mocha的类型包都在全局作用域声明了
beforeEach/afterEach等测试钩子,二者类型定义不兼容 - Truffle类型包全局声明的
expect为Chai静态方法类型,与Jest全局声明的jest.Expect类型冲突 - 之前尝试的自定义类型覆盖方案失效,核心原因是未关闭TypeScript自动扫描加载所有
node_modules/@types包的默认逻辑,自定义覆盖的类型与原始包类型同时被加载,重复触发冲突
无skipLibCheck的分步落地操作
1. 关闭全局类型自动加载,从根源切断同时加载路径
修改tsconfig.json的compilerOptions配置,替换原有的typeRoots配置:
{ "compilerOptions": { // 禁止TypeScript自动扫描node_modules/@types下的所有包作为全局类型 "types": [], // 保留自定义覆盖目录、node_modules的类型扫描路径即可 "typeRoots": ["overrides", "node_modules/@types"] } }
该配置是之前自定义覆盖方案失效的核心补漏点:只要
types字段为空数组,TypeScript就不会自动把typeRoots下所有目录的类型包全局挂载,仅在文件显式引用时才会加载对应类型。
2. 按测试框架拆分类型加载入口
新建两个独立的类型声明文件,分别对应两个测试框架的类型:
types/jest.d.ts:
/// <reference types="@types/jest" />
types/mocha.d.ts:
/// <reference types="@types/mocha" />
写Jest测试文件时,在文件顶部引用Jest类型;写Mocha测试文件时,在文件顶部引用Mocha类型。两个框架的全局类型永远不会出现在同一个编译作用域中,从根源消除钩子函数的类型重复声明冲突。
3. 解决expect的类型冲突
- 调整Truffle类型的导出方式:在
overrides目录下新建truffle_typing.d.ts,重写该包的类型定义,把原全局声明改为模块导出形式:
declare module 'truffle_typing' { export const expect: Chai.ExpectStatic; }
- 写测试时如果需要使用Chai版本的
expect,通过显式导入的方式调用,不再依赖全局声明:
import { expect } from 'truffle_typing';
- Jest自带的
expect类型在显式引入Jest类型的文件作用域内生效,二者通过作用域隔离避免类型重名,不需要修改原始的node_modules文件。
4. 版本适配提醒
当前使用的依赖版本存在天然的全局声明冲突逻辑,无需强制升级大版本,仅需做小版本对齐:
@types/jest@20.0.6存在冗余的全局钩子声明,可升级到适配Jest 22.4.3的最新补丁版本,减少不必要的全局声明@types/mocha@5.2.5的类型定义本身无问题,只要不与Jest类型全局同时加载,就不会触发HookFunction与Lifecycle的类型不兼容报错
内容的提问来源于stack exchange,提问作者tbone
相关产品推荐
相关产品推荐

