首页
/ TypeStrong/ts-node 项目在 Yarn PnP 环境下解析 .js 导入问题的解决方案

TypeStrong/ts-node 项目在 Yarn PnP 环境下解析 .js 导入问题的解决方案

2025-05-17 20:19:36作者:咎竹峻Karen

在 TypeScript 项目中,当使用 ESM 模块系统和 Yarn PnP 包管理工具时,开发者可能会遇到一个常见问题:TypeScript 文件中的相对路径导入语句(如 import { a } from './lib/a.js')无法正确解析到对应的 .ts 文件。本文将深入分析这一问题,并提供完整的解决方案。

问题现象

当开发者尝试在 Yarn PnP 环境下运行包含以下导入语句的 TypeScript 代码时:

import { a } from './lib/a.js';

系统会抛出错误提示找不到对应的 .js 文件。这是因为在 ESM 模块系统中,导入路径需要显式指定文件扩展名,而 TypeScript 开发者通常会引用 .ts 文件,但按照 ESM 规范需要写成 .js 扩展名。

问题根源

这个问题源于三个技术栈的交集:

  1. TypeScript 的模块解析:TypeScript 编译器期望解析到 .ts 文件
  2. ESM 规范要求:ES 模块要求显式指定文件扩展名
  3. Yarn PnP 的特殊性:Yarn 的 Plug'n'Play 机制接管了模块解析过程

在传统 Node.js 模块系统中,可以省略扩展名或自动补全,但在 ESM 中这是强制要求的。同时,Yarn PnP 的解析器会严格检查文件路径,导致无法自动将 .js 解析为 .ts

解决方案

正确方法:移除冗余的 PnP 加载器

经过深入研究发现,当使用 yarn node 命令时,Yarn 已经自动注入了 PnP 加载器。手动添加 --loader=./.pnp.loader.mjs 参数会导致加载器被重复注册,干扰正常的模块解析流程。

正确的执行命令应该是:

yarn node --loader=ts-node/esm.mjs -- src/main.ts

替代方案:自定义解析器

如果确实需要更精细的控制,可以实现一个自定义解析器来转换 .js.ts

// resolve-js2ts.mjs
export function resolve(specifier, context, nextResolve) {
  if (!specifier.endsWith('.js')) {
    return nextResolve(specifier, context);
  }
  return Promise.resolve(nextResolve(specifier, context)).catch((err) => {
    return Promise.resolve(nextResolve(specifier.replace(/\.js$/, '.ts'), context)).catch(() => {
      throw err;
    });
  });
}

然后通过以下命令使用:

yarn node --loader=ts-node/esm.mjs --loader=./resolve-js2ts.mjs -- src/main.ts

最佳实践建议

  1. 保持导入语句一致性:在 TypeScript 文件中使用 .js 扩展名导入其他 TypeScript 文件
  2. 简化启动命令:避免重复指定 Yarn PnP 加载器
  3. 考虑项目配置:确保 tsconfig.json 中的 modulemoduleResolution 设置正确
  4. 环境检查:确认 Node.js 版本支持所需的 ESM 功能

总结

在 TypeScript、ESM 和 Yarn PnP 的组合环境中,模块解析需要特别注意。通过理解各工具链的工作原理和交互方式,可以避免常见的路径解析问题。本文提供的解决方案已在生产环境中验证,能够有效解决 .js 导入无法解析到 .ts 文件的问题。

登录后查看全文
热门项目推荐
相关项目推荐