Topwo博客-node_modules文件夹查找规则

您现在的位置是：Topwo博客>>JavaScript文章

node_modules文件夹查找规则

发布时间：2021-10-08作者：Topwo来源：原创点击：441

## 1、node_modules文件夹的问题
- 文件夹以及文件过多过碎，当我们将项目整体拷贝给别人的时候,，传输速度会很慢很慢.
- 复杂的模块依赖关系需要被记录，确保模块的版本和当前保持一致，否则会导致当前项目运行报错

## 2、package.json文件的作用
项目描述文件，记录了当前项目信息，例如项目名称、版本、作者、github地址、当前项目依赖了哪些第三方模块等。
项目根目录，使用`npm init -y`命令生成，-y使用默认值。
```json
{
  "name": "demo",
  "version": "1.0.0",
  "description": "", 描述
  "main": "index.js",主入口文件
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },命令的别名，命令比经长得时候起别名
  "keywords": [],用关键词来描述项目
  "author": "",
  "license": "ISC"默认协议，开放源代码
}
```
删除node_modules文件夹，别人拿到项目后
执行`npm install`
## 3、项目依赖
在项目的开发阶段和线上运营阶段，都需要依赖的第三方包，称为项目依赖
使用`npm install 包名 --save`命令下载的文件会默认被添加到package.json文件的 dependencies字段中
## 4、开发依赖
在项目的开发阶段需要依赖，线上运营阶段不需要依赖的第三方包，称为开发依赖
使用`npm install 包名 --save-dev`命令将包添加到package.json文件的devDependencies字段中
## 5、package-lock.json文件的作用
锁定包的版本，确保再次下载时不会因为包版本不同而产生问题
加快下载速度，因为该文件中已经记录了项目所依赖第三方包的树状结构和包的下载地址，重新安装时只需下载即可，不需要做额外的工作
## 6、模块查找规则
### 当模块拥有路径时
```javascript
require('./find.js');
require('./find');
```
- require方法根据模块路径查找模块
- 如果是完整路径，直接引入模块
- 如果模块后缀省略，先找同名JS文件再找同名JS文件夹
- 如果找到了同名文件夹，找文件夹中的index.js
- 如果文件夹中没有index.js就会去当前文件夹中的package.json文件中查找main选项中的入口文件
- 如果找指定的入口文件不存在或者没有指定入口文件就会报错，模块没有被找到

### 当模块没有路径且没有后缀时
```javascript
require('find');
```
- Node.js会假设它是系统模块
- 去node_modules文件夹中查找（node_modules查找规则见7）
- 首先看是否有该名字的JS文件
- 再看是否有该名字的文件夹
- 如果是文件夹看里面是否有index.js
- 如果没有index.js查看该文件夹中的package.json中的main选项确定模块入口文件
- 否则找不到报错

## 7、node_modules查找规则
- 沿路径向上逐级递归，直到根目录下的node_modules目录

webpack可以配置模块的查找路径
```javascript
resolve: {
    modules: [path.resolve(__dirname, 'node_modules')]
}
```

上一篇：mysql修改自增值auto_increment

下一篇：如何确定包应该放在dependencies还是devDependencies