JavaScript npm package.json main 怎么配置

轻静君_7703

轻静君_7703

2026-11-15

458人浏览

原创

在 package.json 中配置入口文件,只需添加或修改 main 字段并指向具体的模块文件路径即可。通常该值设为 ./dist/index.js 或 ./lib/index.js,表示构建后的主文件位置。当其他项目通过 require() 或 import 引用你的包时,node.js 和打包工具会优先加载这个指定的文件。

JavaScript npm package.json main 怎么配置

如何指定 CommonJS 和 ES Module 双入口

为了同时兼容使用 require() 的旧项目和支持 import 的新项目,可以在 package.json 中分别配置 main 和 module 字段。main 字段依然指向 CommonJS 格式的构建产物(如 dist/cjs/index.js),而新增的 module 字段则指向 ES Module 格式的产物(如 dist/esm/index.js)。这种双入口策略能让现代打包工具(如 Webpack、Vite)自动选择更优的模块格式进行 tree-shaking,从而减小最终包的体积。

JavaScript npm package.json main 怎么配置

{
  "name": "my-package",
  "version": "1.0.0",
  "main": "./dist/cjs/index.js",
  "module": "./dist/esm/index.js",
  "scripts": {
    "build": "npm run build:cjs && npm run build:esm"
  }
}

上述配置展示了标准的现代 JavaScript 库结构。构建脚本需要分别生成 CJS 和 ESM 两种格式的文件。当消费者引入该包时,如果使用的是支持 module 字段的 bundler,它会读取 ./dist/esm/index.js;如果是 Node.js 环境直接运行,则会回退到 ./dist/cjs/index.js。这种机制确保了广泛的兼容性。

JavaScript 测试模式
JavaScript 测试模式

使用 Jest、Vitest 和 Testing Library 实施全面的测试策略,包括单元测试、集成测试和端到端测试,涵盖模拟、测试夹具和测试驱动开发。在编

下载

如何处理 TypeScript 源码的直接引用

如果希望开发者在不经过构建步骤的情况下直接使用 TypeScript 源码,或者提供类型定义文件的路径,可以配置 types 或 typings 字段。虽然 main 决定了代码执行入口,但 types 字段告诉 TypeScript 编译器去哪里查找类型声明(通常是 .d.ts 文件)。在实际项目中,这通常与 exports 字段结合使用,以提供更精细的条件导出控制,确保类型检查和代码加载的一致性。

JavaScript npm package.json main 怎么配置

{
  "name": "my-package",
  "version": "1.0.0",
  "main": "./dist/cjs/index.js",
  "module": "./dist/esm/index.js",
  "types": "./dist/types/index.d.ts",
  "exports": {
    ".": {
      "import": "./dist/esm/index.js",
      "require": "./dist/cjs/index.js",
      "types": "./dist/types/index.d.ts"
    }
  }
}

这段代码展示了使用 exports 字段进行条件导出的完整示例。它明确指定了在不同环境下(import 或 require)应该加载哪个 JS 文件,以及对应的类型声明文件位置。这种方式比单独使用 main、module 和 types 更加严谨,能够防止路径错误导致的运行时异常或类型丢失问题。对于大多数现代 npm 包,推荐采用这种基于 exports 的配置方式。

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

相关文章

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

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

下载

相关标签:

javascript java js json npm

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

相关专题

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

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

2023.06.20

5926

5

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

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

2023.07.04

1429

3

js四舍五入
js四舍五入

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

2023.07.04

5844

6

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

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

2023.09.01

1060

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

2036

5

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

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

2023.09.04

4025

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

5333

6

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

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

2023.09.20

3500

5

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

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

2023.09.20

1128

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.5万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.8万人学习