JavaScript 中 ESModule 怎么在包发布(NPM Publish)时正确配置 exports 字段映射

夜强大大_2458

夜强大大_2458

2026-08-28

175人浏览

原创

正确配置exports字段是让npm包被现代工具(如vite、webpack 5+、node.js 12.20+/14.13+)正确识别esm入口的关键,它决定import行为及node.js的esm解析规则;双模式包推荐用exports精确映射import/require入口,并保留main/module作兼容回退。

javascript 中 esmodule 怎么在包发布(npm publish)时正确配置 exports 字段映射

在发布支持 ESModule 的 npm 包时,正确配置 exports 字段是让模块被现代工具(如 Vite、Webpack 5+、Node.js 12.20+/14.13+)正确识别 ESM 入口的关键。它不仅影响 import 行为,还决定是否触发 Node.js 的 ESM 解析规则(比如自动匹配 .js → .mjs 或根据 "type": "module" 切换解析逻辑)。

明确包的模块类型和目标环境

先确认你的包是纯 ESM、兼容 CJS/ESM,还是需双包输出:

  • 纯 ESM 包:不提供 require() 入口,package.json 中必须包含 "type": "module",且所有源码用 .js(或 .mjs)按 ESM 语法编写;
  • 双模式包(推荐多数情况):同时提供 ESM 和 CommonJS 入口,通过 exports 精确映射,不依赖 "type": "module",兼容更广(包括旧版 Webpack、Jest 等);
  • 注意:不要混用 "type": "module" + exports 指向 .cjs 文件,Node.js 会报错。

exports 字段的最小可用结构(双模式示例)

以下是一个兼顾 Node.js、Vite、Webpack 的典型 exports 配置(假设入口文件为 index.js 和 dist/index.mjs):

{
  "name": "my-lib",
  "type": "commonjs",
  "main": "./dist/index.cjs",
  "module": "./dist/index.mjs",
  "exports": {
    ".": {
      "import": "./dist/index.mjs",
      "require": "./dist/index.cjs"
    },
    "./package.json": "./package.json"
  }
}

说明:

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • "." 表示包的默认入口(即 import "my-lib" 或 require("my-lib"));
  • "import" 对应 ESM 加载器(如 import、Vite、Node.js ESM 模式);
  • "require" 对应 CommonJS 加载器(如 require()、Webpack 4、Node.js CJS 模式);
  • "./package.json" 显式放行,避免 exports 封闭后读取失败(尤其被其他工具如 TypeScript 引用时);
  • "type": "commonjs" 是安全默认,即使你有 ESM 输出也不必设为 "module"。

支持子路径导入(如 import { foo } from "my-lib/utils")

若希望用户能直接导入内部模块,需在 exports 中显式声明子路径:

"exports": {
  ".": {
    "import": "./dist/index.mjs",
    "require": "./dist/index.cjs"
  },
  "./utils": {
    "import": "./dist/utils.mjs",
    "require": "./dist/utils.cjs"
  },
  "./utils/*": {
    "import": "./dist/utils/*.mjs",
    "require": "./dist/utils/*.cjs"
  },
  "./package.json": "./package.json"
}

注意:

  • 子路径必须以 "./" 开头,否则会被视为外部依赖;
  • 通配符 * 需配合 "./xxx/*" 形式,且只在 Node.js 14.13+ / 16.14+ 支持;
  • Vite/Webpack 通常能识别这种映射,但部分老 bundler 可能忽略 exports,此时仍需靠 module/main 回退。

构建与发布前检查要点

确保实际发布的 dist/ 目录中存在对应文件,并验证解析行为:

  • 运行 node --experimental-conditional-exports -e "import('my-lib')" 测试 ESM 导入;
  • 运行 node -e "require('my-lib')" 测试 CJS 导入;
  • 用 npx ts-node 或 vite dev 验证 TypeScript/Vite 下能否正确解析类型和代码;
  • 检查 npm pack 打出的 tarball 是否包含 dist/ 文件及 package.json 的 exports 字段;
  • 避免在 exports 中引用未发布的路径(如 src/),否则安装后会报 ERR_PACKAGE_PATH_NOT_EXPORTED。

不复杂但容易忽略:exports 不是“锦上添花”,而是现代 JS 生态里控制模块可见性的核心开关。配错会导致用户 import 失败、类型丢失、tree-shaking 失效,甚至整个包无法在 ESM 环境下工作。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

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

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

2023.06.20

4186

5

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

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

2023.07.04

1069

3

js四舍五入
js四舍五入

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

2023.07.04

4084

6

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

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

2023.09.01

840

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1736

5

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

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

2023.09.04

3065

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

3973

6

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

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

2023.09.20

2540

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

828

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 11.9万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.5万人学习