讲师中心 微信公众号
AI工具推荐 视频效率加速

TypeScript 中 Vite 怎么处理 CommonJS 依赖的兼容性转换

阿芳同学_4769

阿芳同学_4769

发布时间:2026-08-02 18:11:18

|

213人浏览过

|

来源于php中文网

原创

Vite 默认不支持 CommonJS,需通过预构建(optimizeDeps.include)、插件转换(@rollup/plugin-commonjs)和 TS 配置(module: "ESNext")三层协同解决;特殊情况用动态导入兜底。

typescript 中 vite 怎么处理 commonjs 依赖的兼容性转换

Vite 本身不直接处理 CommonJS(CJS)模块的运行时转换,它默认只支持原生 ES 模块(ESM)。当项目中引入了仅提供 CommonJS 格式的第三方包(如某些老旧工具库),就会出现 require is not defined 或 Cannot resolve 'xxx' 等错误。解决的关键在于分阶段干预:预构建阶段做 ESM 转换,运行时阶段补足 CJS 兼容逻辑。

预构建阶段:让 CJS 包被 Vite 正确解析

Vite 的 optimizeDeps 会将 node_modules 中的依赖提前转为 ESM 形式供开发服务器使用。但默认只处理 .js/.ts 文件,且对混合模块(含 require/module.exports)识别有限。
你需要显式声明哪些 CJS 包必须参与预构建:

export default defineConfig({
  optimizeDeps: {
    include: ['lodash', 'pica', 'tinycolor2'] // 列出已知 CJS 包名
  }
})

⚠️ 注意:如果包内含 .vue、.html 或其他非 JS 资源,Vite 无法预构建它们,此时需排除——否则报 No loader is configured for ".vue" 错误:

optimizeDeps: {
  exclude: ['some-cjs-package-with-vue-files']
}

运行时阶段:用插件补全 CJS 执行能力

被 exclude 掉的 CJS 包,或预构建后仍残留 require 调用的代码,需要在构建流程中动态转换。推荐使用 @rollup/plugin-commonjs:

import commonjs from '@rollup/plugin-commonjs'

export default defineConfig({
  plugins: [
    commonjs({
      transformMixedEsModules: true, // 允许同时存在 import/export 和 require/module.exports
      include: /node_modules\/(lodash|moment|some-cjs-pkg)\// // 精确匹配路径,避免全量扫描
    })
  ]
})

✅ 它会在 Rollup 打包阶段(生产构建)或 Vite 插件链中,把 require('x') 替换为等效的 ESM 动态导入或静态导入,再注入必要的 require shim(仅限浏览器环境模拟)。

TypeScript 编译层:避免生成 CJS 语法

TS 配置不当也会“制造” CJS 问题。确保 tsconfig.json 中:

Add Typescript Best Practices
Add Typescript Best Practices

在 CLAUDE.md 中配置 TypeScript 最佳实践和代码风格规则

下载
  • module 设为 "ESNext"(不是 "CommonJS")
  • moduleResolution 设为 "Bundler"(适配 Vite/Rollup 的解析逻辑)
  • 启用 allowJs: true 时,务必配合 checkJs: true,防止 JS 文件里混用 require 未被检查

这样 TS 编译输出的是标准 ESM,不会额外引入 require,从源头减少兼容负担。

特殊情况:纯 CJS 包 + 动态导入兜底

若某个包完全不可预构建、插件也无法转换(如含 __dirname、fs 等 Node.js API),唯一安全方式是动态导入 + 条件判断:

// 在组件或工具函数中
if (typeof window !== 'undefined') {
  const { default: someCjsLib } = await import('some-cjs-only-lib')
  someCjsLib.doSomething()
}

利用 await import() 触发 Vite 的异步加载机制,绕过静态分析限制,且只在浏览器环境执行。

Vite 对 CommonJS 的兼容不是开箱即用的魔法,而是靠预构建 + 插件 + TS 配置三层协同完成的。核心思路是:能预构建的尽量预构建,不能的交给插件转换,实在不行就动态加载。

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

4746

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1189

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

4684

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

940

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1836

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3385

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4393

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2880

2023.09.20

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

40

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二期_大前端线上班
第二期_大前端线上班

共345课时 | 80.8万人学习

WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn