JavaScript中CommonJS怎么通过配置package.json中的main字段指定入口

夜杰酱_2732

夜杰酱_2732

2026-07-26

890人浏览

原创

main字段指定commonjs模块入口文件,值为相对于package.json的静态路径字符串,如"index.js"或"src/index.js",不支持"./"前缀、glob或变量,node.js通过require加载包时优先读取该字段指向的文件并返回其module.exports。

javascript中commonjs怎么通过配置package.json中的main字段指定入口

在 CommonJS 规范下,package.json 中的 main 字段用于指定模块的入口文件。Node.js 在通过 require() 加载一个包时(例如 require('some-package')),会优先读取该包 package.json 中 main 字段指向的文件路径,并将其作为模块导出内容。

这个字段的值是一个相对路径字符串,必须是相对于 package.json 所在目录的文件路径,通常指向一个 .js 文件(如 index.js、lib/index.js 或 dist/index.cjs 等)。


main 字段怎么写才有效

  • ✅ 正确示例:

    {
      "main": "index.js"
    }

    表示入口是 package.json 同级目录下的 index.js。

  • ✅ 带子目录也合法:

    {
      "main": "src/index.js"
    }

    表示入口是 src/index.js(只要该文件存在且可被 require)。

  • ❌ 错误写法(不会报错但无法加载):

    {
      "main": "./index.js"   // Node.js 不支持前缀 ./,会被忽略或解析失败
    }
  • ⚠️ 注意:路径不支持 glob、变量、条件判断,就是纯静态字符串。


main 字段和 CommonJS 的关系

  • main 是 Node.js 对 CommonJS 模块系统的约定,不是 ECMAScript 标准的一部分。

  • 当你执行 const pkg = require('my-package'),Node.js 就会:

    Wjs Uploading Video
    Wjs Uploading Video

    将一个或多个视频上传至YouTube。当用户想“上传到YouTube”“发YouTube”“批量上传”“upload to YouTube”“post videos to YouTube”或发布到YouTube时使用此技能。

    下载
    1. 找到 my-package 的 package.json
    2. 读取 main 字段(若不存在,则 fallback 到 index.js)
    3. 把对应文件 require 进来,并将它的 module.exports 作为返回值
  • 如果 main 指向的文件本身又 require 其他文件,这些依赖链仍遵循 CommonJS 规则(同步加载、缓存机制等)。


实际配置建议

  • 保持 main 指向一个能直接运行、导出合理 API 的文件;

  • 若项目同时支持 ESM,可额外配置 exports 字段(优先级高于 main)或 module 字段(某些打包工具识别);

  • 避免让 main 指向未编译的源码(如 TypeScript 文件),Node.js 默认不处理 .ts;

  • 可配合 types 字段提供类型提示(TypeScript 用户友好):

    {
      "main": "dist/index.cjs",
      "types": "dist/index.d.ts"
    }

验证 main 是否生效

在项目根目录运行:

node -p "require('./').default"

或写个测试脚本:

// test.js
const myLib = require('.');
console.log(myLib);

确保它输出的是你期望的 module.exports 内容。

不复杂但容易忽略细节。

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

相关专题

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

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

2023.06.20

4906

5

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

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

2023.07.04

1209

3

js四舍五入
js四舍五入

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

2023.07.04

4824

6

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

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

2023.09.01

960

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1876

5

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

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

2023.09.04

3465

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4513

6

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

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

2023.09.20

2960

5

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

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

2023.09.20

948

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习