package.json 文件详解
前言
一、package.json 文件作用
二、package.json 文件创建
三、package.json 文件示例
四、package.json 文件配置说明
五、项目依赖
六、开发依赖
七、Node.js中模块的加载机制
前言
每个项目的根目录下面都有一个package.json文件，定义了这个项目所需要各种模块，以及项目的配置信息（比如名称、版本、许可证等元数据）。npm install 命令根据这个配置文件，自动下载所需要的模块，也就是配置项目所需的运行和开发环境
node_modules文件夹的问题
- 文件夹以及文件过多过碎，当我们将项目整体拷贝给别人的时候，传输速度会很慢
- 复杂的模块依赖关系需要被记录，确保模块的版本和当前保持一致，否则会导致当前项目运行报错
一.package.json文件的作用
项目描述文件，记录了当前项目信息，例如项目名称、版本、作者、github地址、当前项目依赖了哪些第三方模块，使用npm init -y命令生成。
二、package.json 文件创建
package.json 文件创建有两种方式，手动创建或者自动创建。
手动创建
直接在项目根目录新建一个 package.json 文件，然后输入相关的内容。
自动创建
也是在项目根目录下执行 npm init，然后根据提示一步步输入相应的内容完成后即可自动创建。
三、package.json 文件示例
{
"name": "exchange",
"version": "0.1.0",
"author": "zhangsan <zhangsan@163.com>",
"description": "第一个node.js程序",
"keywords":["node.js","javascript"],
"private": true,
"bugs":{"url":"http://path/to/bug","email":"bug@example.com"},
"contributors":[{"name":"李四","email":"lisi@example.com"}],
"repository": {
"type": "git",
"url": "https://path/to/url"
},
"homepage": "http://necolas.github.io/normalize.css",
"license":"MIT",
"dependencies": {
"react": "^16.8.6",
"react-dom": "^16.8.6",
"react-router-dom": "^5.0.1",
"react-scripts": "3.0.1"
},
"devDependencies": {
"browserify": "~13.0.0",
"karma-browserify": "~5.0.1"
},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
},
"bin": {
"webpack": "./bin/webpack.js"
},
"main": "lib/webpack.js",
"module": "es/index.js",
"eslintConfig": {
"extends": "react-app"
},
"engines" : {
"node" : ">=0.10.3 <0.12"
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"style": [
"./node_modules/tipso/src/tipso.css"
],
"files": [
"lib/",
"bin/",
"buildin/",
"declarations/",
"hot/",
"web_modules/",
"schemas/",
"SECURITY.md"
]
}
四、package.json 文件配置说明
name：项目/模块名称，长度必须小于等于214个字符，不能以"."(点)或者"_"(下划线)开头，不能包含大写字母。
version：项目版本。
author：项目开发者，它的值是你在https://npmjs.org网站的有效账户名，遵循“账户名<邮件>”的规则，例如：zhangsan zhangsan@163.com。
description：项目描述，是一个字符串。它可以帮助人们在使用npm search时找到这个包。
keywords：项目关键字，是一个字符串数组。它可以帮助人们在使用npm search时找到这个包。
private：是否私有，设置为 true 时，npm 拒绝发布。
license：软件授权条款，让用户知道他们的使用权利和限制。
bugs：bug 提交地址。
contributors：项目贡献者 。
repository：项目仓库地址。
homepage：项目包的官网 URL。
dependencies：生产环境下，项目运行所需依赖。
devDependencies：开发环境下，项目所需依赖。
scripts：执行 npm 脚本命令简写，比如 “start”: “react-scripts start”, 执行 npm start 就是运行 “react-scripts start”。
bin：内部命令对应的可执行文件的路径。
main：项目默认执行文件，比如 require(‘webpack’)；就会默认加载 lib 目录下的 webpack.js 文件，如果没有设置，则默认加载项目跟目录下的 index.js 文件。
module：是以 ES Module(也就是 ES6)模块化方式进行加载，因为早期没有 ES6 模块化方案时，都是遵循 CommonJS 规范，而 CommonJS 规范的包是以 main 的方式表示入口文件的，为了区分就新增了 module 方式，但是 ES6 模块化方案效率更高，所以会优先查看是否有 module 字段，没有才使用 main 字段。
eslintConfig：EsLint 检查文件配置，自动读取验证。
engines：项目运行的平台。
browserslist：供浏览器使用的版本列表。
style：供浏览器使用时，样式文件所在的位置；样式文件打包工具parcelify，通过它知道样式文件的打包位置。
files：被项目包含的文件名数组。
五、项目依赖
- 在项目的开发阶段和线上运营阶段，都需要依赖的地三方包，称为项目依赖
- 使用 npm install 包名命令下载的文件会默认被添加到package.json文件的dependencies字段中
{
"dependencies": {
"jquery": "^3.3.1"
}
}
六、开发依赖
- 在项目的开发阶段需要依赖，线上运营不需要依赖的第三方包，称为开发依赖
- 使用npm install 包名 --save-dev命令将包添加到package.json文件的devDepend
{
"devDependencies": {
"dulp": "^3.9.1"
}
}
package-lock.json文件的作用
记录模块与模块之间的关系
- 锁定包的版本，确保再次下载时不会因为包版本不同而产生问题
- 加快下载速度，因为该文件中已经记录了项目所依赖第三方包的树状结构和包的下载地址，重新安装只需下载即可，不需要做额外的工作
七、Node.js中模块的加载机制
5.1 模块查找规则-当模块拥有路径没有后缀时
require('./find.js');
1. require方法根据模块路径查找模块，如果是完整路径，直接引入模块
require('./find');
2. 如果模块后缀省略，先找同名JS文件再找同名JS文件夹
3. 如果找到了同名文件夹，找文件夹中的index.js
4. 如果文件夹中没有index.js就会去当前文件夹中的package.js文件中查找main选项中的入口文件
5. 如果找指定的入口文件不存在或者没有指定入口文件就会报错，模块没有被找到
5.2 模块查找规则-当模块没有路径没有后缀时
require('find');
- Node.js会假设他是系统模块
- Node.js会去node_modules文件夹中
- 首先看是否有该名字的JS文件
- 再看是否有该名字的文件夹
- 如果是文件夹看里面是否有index.js
- 如果没有index.js查看文件夹中的package.json中的main选项确定模块入口文件
- 否则找不到报错
