npm - package.json 配置项详解

前言

它是一个位于 Node.js 项目根目录中的配置文件，管理整个项目的依赖项和元数据。

例如，您拿到项目后，一定使用过如下命令安装过项目依赖：

npm install

像 npm / yarn 这类包管理工具，通过 package.json 文件识别项目并了解如何处理项目的依赖关系。

官方文档

https://docs.npmjs.com/cli/v8/configuring-npm/package-json

name（必填）

项目名称，全部小写字母，不能超过 214 个字符，允许使用下划线和中横线，但不允许使用空格或其它字符。

version（必填）

版本号，格式 x.y.z，符合 NPM 语义版本控制 要求。

• x：主版本号，新增功能，不兼容之前版本。
• y：次版本号，新增功能，但兼容之前版本。
• z：PATCH 补丁版本号，修复 BUG，且兼容之前版本

description

项目描述，用于描述项目及 npm 收录检索，用户搜索时会列为关键字。

license

软件许可证，值通常是许可证的标识符代码，如 BSD / MIT 等。

author

项目作者，一个人。

"author": "李拴蛋"

也可以是一个 JSON 对象：

"author": {
    "name": "李拴蛋",
    "email": "wangjiabinweb@163.com",
    "url": "https://www.baidu.com"
}

contributors

项目作者，一组人（组织），数组类型，数组中每项和 author 格式一致。

"contributors": [
	{
		"name": "李拴蛋",
	    "email": "wangjiabinweb@163.com",
	    "url": "https://www.baidu.com"
	},
	...
]

private

如果这个属性被设置为 true，npm 将拒绝发布它，这是为了防止一个私有模块被无意间发布出去。

如果只想让模块被发布到一个特定的 npm 仓库，如一个内部的仓库，可与在下面的 publishConfig 中配置仓库参数。

publishConfig

这个配置是会在模块发布时用到的一些值的集合。如果不想模块被默认被标记为最新的，或者默认发布到公共仓库，可以在这里配置 tag 或仓库地址。

keywords

字符串数组，用于 npm 搜索关键字。

main

指定加载的入口文件，使用 require('moduleName') 时便会加载此文件，默认值为模块根目录下的 index.js。

browser 浏览器环境和 node 环境均可使用。

browser

定义了 npm 包在 browser 浏览器环境下的入口文件。

scripts

指定运行脚本命令的 npm 命令行缩写，比如 serve 指定了运行 npm run serve 时真正执行的命令。

以下设置指定了运行 npm run serve / npm run lint / npm run mock 时要执行的命令。

"scripts": {
    "serve": "concurrently