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

如何通过静态分析技术自动将老旧项目的 CommonJS 语法迁移至标准 ESM

梦萱姑娘_9995

梦萱姑娘_9995

发布时间:2026-05-13 08:54:01

|

995人浏览过

|

来源于php中文网

原创

不能全自动迁移CommonJS到ESM,因require支持动态路径而import必须静态;需“静态分析+人工校验”,跳过动态require、循环依赖等场景,jscodeshift是实用起点。

如何通过静态分析技术自动将老旧项目的 commonjs 语法迁移至标准 esm

不能全自动,但能覆盖 80% 以上可确定性转换;关键在“静态分析 + 人工校验”双阶段,跳过动态 require、module.exports 赋值表达式、循环依赖等无法推断的场景。

为什么不能全靠工具自动迁移

CommonJS 的 require 是运行时调用,支持字符串拼接、变量拼路径、条件加载(如 require(env === 'dev' ? './a' : './b')),而 ESM 的 import 必须是静态字符串字面量。静态分析器无法安全推断这类表达式的实际目标模块,强行替换会导致运行时报错 Cannot find module 或导入空对象。

常见无法自动处理的情形包括:

  • require('./' + name + '.js')
  • module.exports = {}; module.exports.fn = () => {};(非直接赋值)
  • exports.default = class X {}(与 ESM export default 语义不等价)
  • 跨文件的 require / module.exports 链式赋值(如 A.js require B.js,B.js 又 require C.js 并修改其 exports)

jscodeshift + 自定义 codemod 是最实用的起点

它基于 AST 操作,比正则更可靠,且社区已有成熟模板。以将 const fs = require('fs') → import fs from 'fs' 为例:

先安装:npx jscodeshift -t https://raw.githubusercontent.com/benjamn/recast/master/scripts/codemod.js ./src(基础准备)

再运行自定义迁移脚本(保存为 cjs-to-esm.js):

module.exports = function(fileInfo, api) {
  const j = api.jscodeshift;
  const root = j(fileInfo.source);
<p>// 替换顶层 require 调用
root.find(j.CallExpression, {
callee: { name: 'require' },
arguments: [{ type: 'StringLiteral' }]
}).replaceWith(p => {
const arg = p.node.arguments[0].value;
if (arg.startsWith('./') || arg.startsWith('../') || arg.startsWith('/')) {
return j.importDeclaration(
[j.importDefaultSpecifier(j.identifier('default'))],
j.stringLiteral(arg + '.js')
);
} else {
return j.importDeclaration(
[j.importDefaultSpecifier(j.identifier('default'))],
j.stringLiteral(arg)
);
}
});</p><p>return root.toSource();
};

执行命令:npx jscodeshift -t cjs-to-esm.js ./src --extensions=js --dry --verbose=2

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载

注意点:

  • 必须加 --extensions=js,否则默认只处理 .js 但忽略 .cjs 或无扩展名配置文件
  • --dry 先预览,确认无误再删掉它执行真实写入
  • 该脚本不处理 require.resolve、require.cache 等特殊用法,需单独 grep 排查

package.json 的 "type": "module" 不是开关,而是约束开关

加了它之后,所有 .js 文件被强制视为 ESM —— 这意味着你不能混用 require() 和 import 在同一个文件里,也不能在未改写前的旧文件中直接运行 node index.js。

实操建议:

  • 先在 package.json 中添加 "type": "module",再批量跑 codemod,避免中途出现 “ERR_REQUIRE_ESM” 错误
  • 若项目含 CLI 工具或测试入口(如 test/index.js),它们也必须同步改为 ESM 导入,否则 npm test 会失败
  • 不推荐用 .mjs 扩展名方案:它虽绕过 "type" 限制,但会导致 Jest、Vitest 默认不识别(需额外配 transform),增加维护成本

第三方依赖的兼容性必须手动验证

即使你的代码全转成 ESM,只要依赖里有纯 CommonJS 包(如某些老版本 lodash、mysql),Node.js 仍允许 import 它们 —— 但行为不一致:

  • import pkg from 'pkg' 得到的是 pkg.default(如果它用了 module.exports = xxx)
  • import * as pkg from 'pkg' 得到的是 { default: xxx },不是 CommonJS 下的 { ...xxx }
  • 某些包(如 sqlite3)在 ESM 下需显式 import('sqlite3').then(...) 动态加载,否则报 ERR_UNKNOWN_FILE_EXTENSION

验证方法:

  • 运行 node --experimental-loader=@esbuild-kit/esm-loader --eval "import('lodash').then(x => console.log(x))" 看输出结构
  • 检查 node_modules/pkg/package.json 是否含 "type": "module" 或 "exports" 字段
  • 对关键依赖,搜索 GitHub issues 关键词 “ESM support” 或 “v3 breaking changes”

真正麻烦的不是语法转换,而是 __dirname、__filename、require.resolve 这类 Node.js 特有 API 的重写 —— 它们没有一一对应的 ESM 原生替代,必须结合 import.meta.url + fileURLToPath 手动重构,且每个用到的地方逻辑都可能不同。

热门AI工具

更多
WorkBuddy

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Seko
Seko Hot

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

豆包大模型

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3309

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2348

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1280

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1238

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1376

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2238

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3600

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

16615

2023.09.22

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习

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

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