如何用 package.json 的 exports 字段配置跨平台导入规则

风婷同学_8625

风婷同学_8625

2026-04-05

667人浏览

原创

exports 字段必须是对象,不能是数组或字符串;顶层键必须以.开头,值为字符串、对象或null,如".": "./dist/index.cjs";需用conditions(import/require/browser/types等)区分模块类型与环境,路径须用正斜杠且注意大小写。

如何用 package.json 的 exports 字段配置跨平台导入规则

exports 字段必须是对象,不能是数组或字符串

很多人在第一次写 exports 时直接复制旧版 main 或 module 的写法,结果 npm install 后报错 Invalid "exports" main export。这是因为 exports 是一个严格结构的映射对象,顶层只能是键值对,键必须以 . 开头(如 "./index.js"),值必须是字符串、对象或 null。

常见错误写法:

"exports": "./dist/index.cjs"

这会直接导致 Node.js 加载失败——即使你只用一个入口,也得包一层 ".":
"exports": {
  ".": "./dist/index.cjs"
}
  • 顶层 "." 是默认入口,等价于以前的 main
  • 任何其他导出路径(如 "./esm"、"./package.json")都必须显式声明
  • 不声明的路径一律被禁止访问(这是设计意图,不是 bug)

用条件导出(conditions)区分 ESM/CJS/Node/Browser

跨平台的核心不是“写一堆路径”,而是用 import / require / browser 等条件关键字控制解析逻辑。Node.js 和现代 bundler(Vite、Webpack 5+)都支持这些字段,但行为有差异。

典型配置示例:

js2java
js2java

JavaScript 到 Java 全栈翻译助手,专为前端开发者学习 Java 或快速实现后端业务逻辑而设计。当用户提到以下场景时必须使用此技能: - "帮我把这段 JS 代码转成 Java" - "用 Java 怎么写这个逻辑" - "我习惯用 JS 写,想翻译成 Java" - "教我 Java,我要写后端接...

下载
"exports": {
  ".": {
    "import": "./dist/index.mjs",
    "require": "./dist/index.cjs",
    "browser": "./dist/index.browser.js",
    "node": "./dist/index.node.js"
  }
}
  • import 条件匹配 ES 模块导入(import x from "pkg"),优先返回 .mjs 或带 "type": "module" 的 .js
  • require 条件匹配 require("pkg"),必须返回 CommonJS(.cjs 或 .js 且无 type: module)
  • browser 在 Vite/Webpack 中会被识别;但注意:Node.js 完全忽略 它,只看 import/require
  • 多个条件可共存,运行时按顺序匹配第一个满足的(顺序不重要,语义优先)

动态条件(如 types、development)需要显式声明

TypeScript 类型提示、开发环境专用代码这些不是默认条件,必须手动加进 exports 并确保工具链支持。比如没配 "types",VS Code 就找不到类型定义,即使 index.d.ts 文件存在。

安全写法:

"exports": {
  ".": {
    "types": "./dist/index.d.ts",
    "import": "./dist/index.mjs",
    "require": "./dist/index.cjs",
    "development": "./dist/index.dev.js",
    "production": "./dist/index.prod.js"
  }
}
  • types 不影响运行时,但 tsc、IDE 依赖它定位类型 —— 键名必须是 "types",拼错(如 "typings")无效
  • development/production 被 Vite、Webpack、esbuild 支持,但 Node.js 原生不识别;若想在纯 Node 环境也生效,得靠 process.env.NODE_ENV + 动态 require 回退,exports 本身做不到
  • 条件之间无继承关系:写了 "import" 不代表自动 fallback 到 "require",未匹配条件会报 ERR_PACKAGE_PATH_NOT_EXPORTED

Windows 路径分隔符和大小写敏感性容易引发本地测试误判

开发时在 macOS/Linux 下一切正常,CI(尤其是 Windows runners)却报 Cannot find module 'xxx',大概率是 exports 里用了反斜杠 \ 或大小写不一致的文件名。

  • 所有路径必须用正斜杠 /,Node.js 的 exports 解析器不处理 \(即使你在 Windows 上生成路径)
  • 文件系统大小写敏感性:macOS 默认不敏感,Linux/CI 通常敏感。确保 "./dist/Index.mjs" 对应的文件名真是大写 I,否则 Linux 下直接 404
  • 验证方式:在目标平台跑 node -e "console.log(require('your-pkg'))" 和 node -e "import('your-pkg')",别只信本地 import 语法高亮

最麻烦的点其实是嵌套导出和条件组合:比如同时要支持 import "pkg/subpath" + types + browser,就得为每个子路径重复写一遍条件对象。一不留神就漏掉某个组合,而错误信息又极其笼统 —— 此时别猜,直接用 node --trace-module-resolutions 看它到底卡在哪一层解析。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.06.20

3049

3

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

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

2023.07.25

2268

9

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

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

2023.08.02

1220

5

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

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

2023.08.09

1158

4

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

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

2023.09.05

1336

5

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

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

2023.09.20

2118

7

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

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

2023.09.20

3360

8

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

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

2023.09.22

15115

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

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

共101课时 | 20.9万人学习

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

共39课时 | 4.8万人学习