0

0

TypeScript ESM 导入中自动解析 .ts 文件扩展名的解决方案

心靈之曲

心靈之曲

发布时间:2026-03-15 13:48:12

|

304人浏览过

|

来源于php中文网

原创

TypeScript ESM 导入中自动解析 .ts 文件扩展名的解决方案

在 typescript 项目切换为 esm("type": "module" + "module": "esnext")后,省略 .ts 扩展名的导入会失败;启用 allowimportingtsextensions 又会导致类型检查异常。本文提供符合标准、无需手动加扩展名的安全解决路径。

typescript 项目切换为 esm("type": "module" + "module": "esnext")后,省略 .ts 扩展名的导入会失败;启用 allowimportingtsextensions 又会导致类型检查异常。本文提供符合标准、无需手动加扩展名的安全解决路径。

当 TypeScript 项目从 CommonJS 迁移至原生 ESM(即设置 "type": "module" 且 tsc 的 module 选项为 "esnext")时,一个常见但易被忽视的兼容性问题是:Node.js 的 ESM 加载器默认不支持自动解析 .ts 源文件——它只识别 .js、.cjs、.mjs 等运行时有效扩展名,而 .ts 是编译期产物,不属于 Node.js 原生模块解析规则。

因此,以下写法会报错:

// getButton.ts
import { Button } from "../../../objects/Button"; // ❌ Node 报错:Cannot find module ".../Button"

即使 Button.ts 存在,Node.js ESM 加载器也无法自动补全 .ts 扩展名。而若强行写成:

import { Button } from "../../../objects/Button.ts"; // ❌ 编译报错(除非启用特定选项)

则会触发 TypeScript 编译错误:

An import path can only end with a '.ts' extension when 'allowImportingTsExtensions' is enabled.

⚠️ 关键误区澄清:allowImportingTsExtensions: true 并非推荐解。该选项虽允许 .ts 扩展名出现在 import 语句中,但它违背了 ESM 规范(ECMAScript 不定义 .ts 为合法模块扩展),且会导致构建工具链(如 Vite、Webpack、esbuild)行为不一致,还可能干扰类型检查与路径映射(如 paths 别名)。

正确且标准化的解决方案是:让 TypeScript 输出 .js 文件,并确保导入路径指向已生成的 .js(或 .mjs)产物,而非源码 .ts。具体分三步实现:

ChatDOC
ChatDOC

ChatDOC是一款基于chatgpt的文件阅读助手,可以快速从pdf中提取、定位和总结信息

下载
  1. 配置 tsconfig.json 输出 .js + 启用 verbatimModuleSyntax(推荐)

    {
      "compilerOptions": {
        "module": "esnext",
        "target": "es2020",
        "outDir": "./dist",
        "rootDir": "./src",
        "esModuleInterop": true,
        "verbatimModuleSyntax": true, // ✅ 关键:禁用自动扩展名补全,强制显式声明
        "allowImportingTsExtensions": false, // ✅ 显式关闭(默认即 false,但建议明确)
        "skipLibCheck": true,
        "forceConsistentCasingInFileNames": true
      }
    }
  2. 构建并运行时使用 .js 入口
    编译后,Button.ts → dist/objects/Button.js,此时应导入:

    // getButton.ts(源码中仍写逻辑路径,但需确保构建后对应 .js)
    import { Button } from "../../../objects/Button"; // ✅ 正确:TS 编译器根据声明文件(.d.ts)解析类型,Node 运行时加载 dist/objects/Button.js

    ? 原理:TypeScript 在编译阶段通过 rootDir/outDir 和声明文件(.d.ts)完成类型解析;而 Node.js 运行时实际加载的是 dist/objects/Button.js(由 tsc 或 tsup 等工具生成)。只要 package.json#main 或 exports 指向正确的 .js 入口,且 import 路径与 outDir 结构一致,即可无扩展名工作。

  3. 现代替代方案:使用 tsc --build + --preserveSymlinks 或工具链集成
    若采用 Vite / tsx / Bun 等开发环境,推荐直接启用 transpileOnly: true + esbuild 转译(跳过类型检查),或使用 tsx 运行时:

    npm install -D tsx
    # package.json scripts:
    "dev": "tsx watch src/index.ts"

    tsx 内置 ESM 支持,可自动解析 .ts 导入(底层通过 require.resolve + ts-node 式劫持),且不依赖 allowImportingTsExtensions。

? 总结

  • ❌ 避免启用 allowImportingTsExtensions —— 它是临时妥协,破坏标准化与工具链兼容性;
  • ✅ 坚持“源码无扩展名 + 构建产出 .js + 运行时加载 .js”的正交设计;
  • ✅ 使用 verbatimModuleSyntax: true 显式关闭 TS 的扩展名启发式补全,提升可预测性;
  • ✅ 开发阶段优先选用 tsx、bun run 或 Vite 等现代运行时,它们已内置对无扩展名 .ts 导入的健壮支持。

遵循以上实践,即可在 ESM 下优雅支持干净的 import { X } from './mod' 语法,兼顾类型安全、构建确定性与运行时稳定性。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

49

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

196

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

73

2026.03.13

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

549

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

337

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

83

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

510

2023.11.27

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

69

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
TypeScript 教程
TypeScript 教程

共19课时 | 3.5万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.2万人学习

TypeScript-45分钟入门
TypeScript-45分钟入门

共6课时 | 0.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号