这里只截取了部分常用的选项，全部内容戳这里
概述
注意package.json必须是纯JSON的，而不仅仅是一个JavaScript对象字面量。
该文件描述的很多行为都受npm-config中的配置影响。
下面分别介绍package.json中常用字段的含义和用法。
name
name和version字段是package.json文件中最重要的字段。这是必须的字段，如果你的npm包没有指定这两个字段，将无法被安装。name和version字段被假定组合成一个唯一的标识符。包内容的更改和包版本的更改是同步的。
version
name和version字段是package.json文件中最重要的字段。这是必须的字段，如果你的npm包没有指定这两个字段，将无法被安装。name和version字段被假定组合成一个唯一的标识符。包内容的更改和包版本的更改是同步的。
version字段必须能够被node-semver解析，node-semver作为依赖项被捆绑进了npm中。(可以使用npm install semver来使用)
description
npm包的描述，description是一个字符串。它可以帮助人们在使用npm search时找到这个包。
keywords
npm包的关键字，keywords是一个字符串的数组。它可以帮助人们在使用npm search时找到这个包。
license
你应该对你的包指定一个license来让用户知道他们的使用权利和和任何限制。
如果你正在使用BSD-2-Clause或MIT这样的通用许可证，可以为你的license添加一个当前SPDX的许可证标识符，比如：
{ "license" : "ISC" }
如果你不希望授权别人以任何形式使用私有包或未发布的包，可以这样写：
{ "license": "UNLICENSED"}
或者
"private": true
来防止意外的发布。
关于人的字段: author, contributors
author是一个人，contributors是一些人的数组。person是一个对象，拥有必须的name字段和可选的url和email字段，像这样：
{
"name": "BB",
"email": "bb@react.com",
"url": "http://bb.cc.com/"
}
或者你也可以使用单个字符串的精简形式，npm会帮你解析它：
"BB <bb@react.com> (http://bb.cc.com/)"
main
main字段指定了模块的入口程序文件。就是说，如果你的模块名叫"foo"，用户安装了它，并且调用了 require("foo")，则这个main字段指定的模块的导出对象会被返回。
这应该是一个相对于包根目录的模块标识。
对于大部分模块来说，main字段除了指定一个主入口文件以外没什么其他用处了。
scripts
scripts字段是一个由脚本命令组成的字典，这些命令运行在包的各个生命周期中。这里的键是生命周期事件名，值是要运行的命令。可以参考npm-scripts获取配置scripts的更多信息。
dependencies
dependencies字段是一个对象，它指定了依赖的包名和其版本范围的映射。版本范围是个有一个或多个空白分隔描述符的字符串。dependencies字段还可以用tarball或者git URL。
请不要将测试或过渡性的依赖放到dependencies中，请参考下面的devDependencies。
可以参考semver获取更多关于指定版本范围的细节信息。
- version 必须确切匹配这个version
- >version 必须大于这个version
- >=version 必须大于等于这个version
- < version 必须小于这个version
- <=version 必须小于等于这个version
- ~version 大约相当于version，参考semver
- ^version 与version兼容，参考semver
- 1.2.x 可以是1.2.0、1.2.1等，但不能是1.3.0
- http://... 参考下面的URL作为依赖项
- * 匹配任何版本
- ""(空字符串) 匹配任何版本，和*一样
- version1 - version2 相当于 >=version1 <=version2
- range1 || range2 range1或range2其中一个满足时采用该version
- git... 参考下面的Git URL作为依赖项
- user/repo 参考下面的GitHub URLs
- tag 一个以tag发布的指定版本，参考npm-tag
- path/path/path 参考下面的本地Paths
举个栗子，下面这种写法是合法的：
{
"dependencies": {
"foo": "1.0.0 - 2.9999.9999",
"bar": ">=1.0.2 <2.1.2",
"baz": ">1.0.2 <=2.3.4",
"boo": "2.0.1",
"qux": "<1.0.0 || >=2.3.1 <2.4.5 || >=2.5.2 <3.0.0",
"asd": "http://asdf.com/asdf.tar.gz",
"til": "~1.2",
"elf": "~1.2.3",
"two": "2.x",
"thr": "3.3.x",
"lat": "latest",
"dyl": "file:../dyl"
}
}
devDependencies
如果有人计划在他们的项目中下载和使用你的模块，但他们可能并不想或并不需要你开发所使用的外部测试和文档框架。
在这种情况下，最好将这些附加的项放在devDependencies中。
这些项将会在根目录下执行npm link或npm install时被安装，并且可以像其他npm配置参数一样被管理。可以参考npm-config获得更多信息。
对于那些非特定平台的构建步骤，比如编译CoffeeScript或把其他语言转换成JavaScript，可以使用prepublish脚本来处理，并且把这个过程的依赖包放在devDependencies中。
os
可以指定模块运行的操作系统：
"os" : [ "darwin", "linux" ]
也可以使用操作系统黑名单来替代白名单，只要在前面加个'!'：
"os" : [ "!win32" ]
主机的操作系统可以通过process.platform来确定。
虽然找不到什么很好的理由支持这么做，但是这里还可以黑名单和白名单混用。
private
如果你在包的package.json中设置"private": true，则npm会拒绝发布它。
这是防止私有包被以外发布的一种方法。如果你希望包装某个包只能被发布到特定的一个registry中(比如，一个内部的registry)，则可以使用下面的publishConfig字典来描述以在publish-time重写registry配置参数。
网友评论