ESMify

将常用 CJS 包转换为 ESM 格式，大幅度缩减包体积

Important

自动化与透明度声明

本仓库所有模块的转换和发布流程均通过 GitHub Actions 实现自动化，所有操作日志和构建过程均可在仓库的 Actions 页面查看，确保完全透明。

使用风险提示

转换后的模块虽然经过基础测试，但仍建议用户在生产环境使用前进行充分测试。由于模块转换的复杂性，我们无法保证转换后的模块与原模块 100% 兼容。用户在使用过程中遇到任何问题，本仓库及开发团队不承担任何责任。

简介

ESMify 是一个将 CommonJS 包转换成 ESM（ECMAScript Modules）模块的仓库，这是一项持续进行的计划，使用 vite+tsup 实现，旨在显著减小包的体积，提高应用性能。

系统要求

• Node.js >= 18.0.0

包体积对比

以下是各个包转换前后的体积对比（数据参考自 @pkg-size.dev）：

原始包名称	原始体积	转换后包名称	转换后体积	减少比例	types
lodash-es	~636KB	@karinjs/lodash	~210KB	~67%	❌
express	~2.2MB	@karinjs/express	~828KB	~62%	❌
dotenv	~76KB	@karinjs/dotenv	~20kB	~73.7%	✅
jsonwebtoken	~298KB	@karinjs/jsonwebtoken	~141KB	~52.7%	✅
log4js	~519KB	@karinjs/log4js	~225KB	~56.6%	✅
redis	~991KB	@karinjs/redis	~1MB	~0%	✅
sqlite3	~6.9MB	@karinjs/sqlite3	~2.1MB	~69.6%	✅
moment	~4.4MB	@karinjs/moment	~526KB	~88%	✅
art-template	~8.3MB	@karinjs/art-template	~400KB	~95.2%	✅
node-schedule	~4.6MB	@karinjs/node-schedule	~323KB	~93%	✅
ws	~147KB	@karinjs/ws	~154KB	~0%	✅
axios	~2.7MB	@karinjs/axios	~100KB	~96.3%	✅

无缝升级指南

你可以通过以下方式无缝升级到 ESM 版本，无需修改任何代码：

npm

npm install lodash@npm:@karinjs/lodash

yarn

yarn add lodash@npm:@karinjs/lodash

pnpm

pnpm add lodash@npm:@karinjs/lodash

这种方式可以让你在不修改任何代码的情况下，将依赖替换为 ESM 版本。例如，如果你的代码中使用了 import _ from 'lodash'，它会自动使用 @karinjs/lodash 的 ESM 版本。

package

![IMPORTANT] 版本号映射和一些备注。

lodash-es

此包的类型转换存在问题，请单独安装@types/lodash

版本	原始版本	备注
1.1.1	4.17.21

express

此包的类型转换存在问题，请单独安装@types/express

版本	原始版本	备注
1.0.3	4.18.2

dotenv

内置类型

版本	原始版本	备注
1.1.2	16.3.1

jsonwebtoken

内置类型

版本	原始版本	备注
1.1.1	9.0.2

log4js

内置类型

版本	原始版本	备注
1.1.4	6.9.1

redis

内置类型

版本	原始版本	备注
1.1.3	4.6.11

sqlite3

内置类型

版本	原始版本	备注
0.1.3	5.1.7

moment

内置类型 仓库地址: https://github.com/KarinJS/moment

版本	原始版本	备注
1.1.0	2.30.1

art-template

内置类型 仓库地址: https://github.com/KarinJS/art-template

版本	原始版本	备注
1.1.0	4.13.2

node-schedule

内置类型 仓库地址: https://github.com/KarinJS/node-schedule | 版本 | 原始版本 | 备注 | | ----- | -------- | ---- | | 1.1.0 | 2.1.1 | |

ws

内置类型 仓库地址: https://github.com/KarinJS/ws

版本	原始版本	备注
1.1.0	8.16.0

axios

内置类型 仓库地址: https://github.com/KarinJS/axios

参与开发

如果你想要参与开发，请按照以下步骤进行：

环境要求

• Node.js >= 18.0.0
• pnpm v9.x

安装依赖

pnpm install

新增一个包

要新增一个包，请运行以下命令：

pnpm run init <name>

其中 <name> 是你要转换的包的名称。例如，要转换 axios 包，请运行：

pnpm run init axios

此命令会自动创建必要的目录结构和配置文件：

1. 在 packages/<name> 目录下创建基本文件结构
2. 生成 package.json 配置
3. 生成 vite.config.ts 和 tsup.config.ts 构建配置
4. 更新 .release-please-config.json 和 .release-please-manifest.json
5. 自动安装原始包作为开发依赖

开发流程

1. 修改 packages/<name>/src/index.ts 文件，编写转换逻辑
2. 修改 packages/<name>/index.js 文件
3. 运行 pnpm run build -F @karinjs/<name> 构建包
4. 测试包的功能和体积
5. 提交代码并发起 Pull Request

免责声明

1. 本仓库提供的所有模块均为自动化转换生成，可能存在与原模块不完全兼容的情况。
2. 用户在使用这些模块时，应当自行进行充分测试，确保满足生产环境需求。
3. 本仓库及开发团队不对使用这些模块产生的任何问题负责。
4. 建议在非关键业务场景下使用，或在充分测试后用于生产环境。
5. 如遇到问题，建议回退使用原模块，或自行修复问题。