package.json 里 main 字段引发的血案：你的模块还正常吗？

「小墨是前端」致力于分享实用前端技术、挖掘优秀的开源项目，带你探索前端的奇妙世界，共同学习进步。

解锁 package.json 中 main 字段的正确姿势

Node.js项目的标配package.json，管理着项目的各种元数据和依赖信息。但main字段，很多小伙伴可能并不完全清楚它的真正作用，以至于在模块导入时经常遇到一些意想不到的问题。本文就来详细探讨下main字段的功用，并提供清晰的解决方案来避免可能发生的导入错误。

main字段的功能不难理解：它指定了模块的入口文件。 当一个模块被其他程序通过require（在CommonJS中）或import（在ES模块中）引入时，Node.js会根据main字段指定的路径去加载模块的入口。

如果不设置main字段呢？系统有一个默认的规则：它会尝试加载模块根目录下的index.js文件作为入口。

场景一：CommonJS 模块中的 main

假设我们有一个工具模块utils，它的目录结构如下：

utils模块有一个package.json文件，专门来指明入口文件位置：

calc.js中写一个简单的减法函数：

在index.js中，写一些不被执行的代码。：

为了验证main字段的作用，我们在app.js中使用require导入这个模块，看看能否得到这个subtract 函数：

在命令行运行node app.js。 可以看到，虽然我们require的是./utils这个目录，但由于utils/package.json中指定了main字段为./calc.js，所以实际加载的是calc.js文件，而不是默认的index.js。

场景二：ES 模块中 main 的特殊之处

ES模块（ESM）与CommonJS规范在处理模块导入方面有所不同。如果将上述的CommonJS的例子简单改为ES模块，直接执行会遇到一个报错：ERR_UNSUPPORTED_DIR_IMPORT。为了让项目支持ES模块，并在使用时指明模块入口文件，需要在根目录下的package.json里声明这是一个ES模块，代码如下：

同时，在文件夹my-esm-project下的app.js文件改成如下代码：

my-esm-project/utils/目录下的package.json文件里声明为 ES 模块，代码如下：

my-esm-project/utils/目录下的calculator.js文件里声明 subtract 函数，代码如下：

my-esm-project/utils/目录下的index.js里的内容实际上并不会被执行，代码如下：

按照场景一中的方式使用，使用import语法直接导入会触发一个报错。为了解决这个问题，在运行 Node.js 应用时需要加入--experimental-specifier-resolution=node标识：

通过添加这个标识，Node.js就能够正确解析ES模块的目录导入，并根据main字段找到入口文件，进而正确的加载模块。

避免错误的实用建议

根据上面的实践，总结了以下两点：

1.CommonJS项目，使用require引入文件夹时，如果文件夹中package.json文件设置了main字段，则会加载main字段指定的入口文件；没有设置则加载文件夹下的index.js文件。

2.ES项目，如果使用了import引入文件夹时，会报错ERR_UNSUPPORTED_DIR_IMPORT。需要添加--experimental-specifier-resolution=node参数运行项目。另外使用import语句时，也可以不省略文件后缀。比如 import subtract from './utils/calculator.js';import语法可以直接使用，不用配置--experimental-specifier-resolution=node

正确理解和使用package.json的main字段，可以更好地组织和管理Node.js项目的模块依赖。不同的模块规范有不同的行为，了解差异是正确加载的关键！。