package.json exports 定义双入口模块方法
2026-05-01 09:03:48
0浏览
收藏
本文详解如何通过 package.json 的 exports 字段优雅实现 Node.js 模块的“双重入口”——让同一个 npm 包无缝支持 ESM(import)和 CommonJS(require),无需构建工具介入,兼顾现代环境(Node.js 12+、Vite、Webpack 5)与旧版生态(Node.js 10–14、Webpack 4),并通过 type: "module"、条件导出、手写 .cjs/.mjs 入口文件及兼容性字段(main/module)协同工作,确保 API 一致、逻辑复用、零配置降级,是构建高兼容性 TypeScript/JavaScript 库的实用范式。

通过 package.json 的 exports 字段定义“双重入口”模块,核心是让同一包同时支持 ESM(现代浏览器/Node.js)和 CommonJS(旧版 Node.js、某些构建工具),且不依赖构建步骤。关键在于正确声明条件导出(conditional exports),并确保入口文件在两种环境下的行为一致。
明确双重入口的目标场景
所谓“双重入口”,通常指:
- ESM 入口:供
import使用,支持顶层 await、动态import(),应为纯 ESM 格式(无require或module.exports) - CJS 入口:供
require()使用,兼容 Node.js 10–14 及 Webpack 4 等老工具 - 二者导出的 API 表面一致(如相同函数名、类型签名),内部可按需做轻量适配(如默认导出包装)
配置 exports 字段的最小可行结构
在 package.json 中使用 "exports" 对象,按条件匹配环境。推荐如下写法:
{
"type": "module",
"exports": {
".": {
"import": "./dist/index.mjs",
"require": "./dist/index.cjs"
}
},
"main": "./dist/index.cjs",
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts"
}
说明:
"type": "module"声明包默认为 ESM,避免 Node.js 将.js文件误判为 CJS"import"条件匹配所有 ESM 加载场景(import、import()、type: "module"的package.json)"require"条件匹配所有 CJS 加载场景(require()、Webpack 4 默认模式)"main"和"module"是向后兼容字段,供不支持exports的旧工具(如 Webpack 4、Rollup 插件)降级使用
准备两个物理入口文件(无需构建时生成)
不必用打包器生成 .cjs 和 .mjs——手写即可,保持轻量:
dist/index.cjs:使用module.exports =导出,默认导出可包装为命名导出对象dist/index.mjs:使用export default和export const xxx,若需兼容 CJS 用户的require("pkg").default,可在 ESM 入口显式导出default- 两者都应引用同一份逻辑(如
./lib/core.js),仅做导出形式转换,避免逻辑重复
示例 dist/index.cjs:
const { foo, bar } = require('../lib/core.js');
module.exports = { foo, bar };
module.exports.default = { foo, bar };
示例 dist/index.mjs:
import { foo, bar } from '../lib/core.js';
export { foo, bar };
export default { foo, bar };
验证跨平台兼容性
手动测试三类典型调用方式:
- Node.js ESM:
node --experimental-specifier-resolution=node -e "import('your-pkg').then(console.log)" - Node.js CJS:
node -e "console.log(require('your-pkg'))" - Webpack 5(开箱即用)或 Vite(默认 ESM)中
import和require混用
注意:若发布到 npm,确保 files 字段包含 dist/ 目录,且未意外忽略 .cjs 或 .mjs 扩展名。
以上就是本文的全部内容了,是否有顺利帮助你解决问题?若是能给你带来学习上的帮助,请大家多多支持golang学习网!更多关于文章的相关知识,也可关注golang学习网公众号。
Linux使用tar排除目录打包方法
- 上一篇
- Linux使用tar排除目录打包方法
- 下一篇
- Win11打印机后台处理错误解决方法
查看更多
最新文章
-
- 文章 · 前端 | 15小时前 | 前端 · javascript · JavaScript DOM遍历 NodeIterator referenceNode
- JavaScript NodeIterator.referenceNode 怎样读取迭代器当前参照的节点
- 326浏览 收藏
-
- 文章 · 前端 | 16小时前 | 前端 · JavaScript Event defaultPrevented
- JavaScript Event.defaultPrevented 怎样判断事件默认行为是否已经被取消
- 391浏览 收藏
-
- 文章 · 前端 | 16小时前 | 前端 · javascript · 浏览器API · JavaScript Selection focusNode focusOffset DOM Node 文本选择
- JavaScript Selection.focusNode 怎样取得用户当前延伸选择的端点节点
- 492浏览 收藏
-
- 文章 · 前端 | 17小时前 | 前端 · javascript · JavaScript CSSOM CSSStyleSheet CSSRule parentStyleSheet cssRules parentRule
- JavaScript CSSRule.parentStyleSheet 怎样取得一条规则所属的样式表
- 323浏览 收藏
-
- 文章 · 前端 | 19小时前 | javascript · JavaScript 滚动条 Element.clientLeft 左边框
- JavaScript Element.clientLeft 怎样理解左边框宽度与滚动条占位
- 290浏览 收藏
-
- 文章 · 前端 | 20小时前 | 前端 · javascript · JavaScript Shadow DOM Event.composed
- JavaScript Event.composed 怎样判断事件能否跨越影子根边界
- 149浏览 收藏
-
- 文章 · 前端 | 21小时前 | javascript · JavaScript dom Selection anchorOffset
- JavaScript Selection.anchorOffset 怎样理解选择起点在文本与元素中的偏移
- 496浏览 收藏
-
- 文章 · 前端 | 22小时前 | javascript · JavaScript CSSStyleSheet ownerRule CSSImportRule
- JavaScript StyleSheet.ownerRule 怎样取得导入样式表对应的规则对象
- 357浏览 收藏
-
- 文章 · 前端 | 22小时前 | html · 前端 · javascript · 表单 · JavaScript id for label 表单控件 Control HTMLLabelElement
- JavaScript HTMLLabelElement.control 怎样取得标签实际关联的表单控件
- 338浏览 收藏
-
- 文章 · 前端 | 23小时前 | 前端 · javascript · JavaScript DOM遍历 TreeWalker NodeFilter whatToShow
- JavaScript TreeWalker.whatToShow 怎样区分节点类型掩码与自定义过滤器
- 223浏览 收藏
-
- 文章 · 前端 | 1天前 | 前端 · range · javascript · JavaScript dom range 富文本 isPointInRange 节点偏移
- JavaScript Range.isPointInRange 怎样判断指定节点偏移是否落在范围内
- 145浏览 收藏
查看更多
课程推荐
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
查看更多
AI推荐
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1115次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1104次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1275次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1218次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1065次使用
查看更多
相关文章
-
- JavaScript函数定义及示例详解
- 2025-05-11 502浏览
-
- 智能体安全引领产业升级——国内AI安全产品市场深度分析
- 2026-08-21 501浏览
-
- CSS变量简化按钮悬停效果技巧
- 2026-05-31 501浏览
-
- JavaScript符号类型详解与应用
- 2026-05-31 501浏览
-
- HTML剪贴板复制粘贴怎么用
- 2026-05-26 501浏览
