package.json 中的字段都是干嘛的(简单介绍)

174 阅读2分钟

1、常规字段概述

name: 应用程序或软件包的名称  如果发布NPM包的时候这个字段是必须的
author: 软件包或应用程序的作者
version: 当前版本号
license: 软件包的许可证
description: 应用程序或软件包的简要描述
main: 程序的入口
private: boolean值,如果为true,可防止应用程序或软件包被意外发布到NPM
script: node运行脚步, 比如'npm run start / npm run build'等
dependencies: 依赖安装的 npm 软件包的列表, 简单来说就是程序在线上远行时必须使用的依赖列表
devDependencies: 程序本地开发时所需要的所有依赖
engines: 设置软件包/应用程序在哪个版本的 Node.js 上运行
browserslist: 这里设置所需要兼容(支持)的浏览器版本

参考出处: nodejs.cn/learn/the-p…

2、重点字段的解析

1、dependencies 和 devDependencies

  • dependencies 正式环境所需依赖,配置合理可节约服务器资源 --save
  • devDependencies 开发环境所需依赖 --save-dev

2、项目生成package.json 文件

// 根目录执行
npm init

3、script字段

简介:

// script对象每个属性代表每一段脚步
npm run build === node build.js


// 查看当前所有npm脚本
npm run

原理:

  • 每当执行npm run,就会自动新建一个 Shell,在这个 Shell 里面执行指定的脚本命令

注意⚠️:

npm run新建的这个 Shell,会将当前目录的node_modules/.bin子目录加入PATH变量,执行结束后,再将PATH变量恢复原样。

这意味着,当前目录的node_modules/.bin子目录里面的所有脚本,都可以直接用脚本名调用,而不必加上路径。比如,当前项目的依赖里面有 Mocha,只要直接写mocha test就可以了

 "test": "mocha test" 

而不需这样:

"test": "./node_modules/.bin/mocha test"
  • npm 脚本的唯一要求就是可以在 Shell 执行,因此它不一定是 Node 脚本,任何可执行文件都可以写在里面

执行顺序:


  • 并行执行 使用‘&’符号
  • 串连执行 使用‘&&’符号
// 并行
npm run script1 & npm run script2
// 串行
npm run script1 && npm run script2