name

必须字段。提示：

• 不要在name中包含 js、 node 字样；
• 这个名字最终会是 URL 的一部分，命令行的参数，目录名，所以不能以点号或下划线开头；
• 这个名字可能在 require 方法中被调用，所以应该尽可能短；
• 如果要发布为一个 NPM 包，则该名字必须为唯一；

version

必须字段，版本号，字符串格式，如：

"version": "1.0.0"

description

可选字段，字符串格式，如：

"description": "简单描述当前应用或 package"

keywords

可选字段，数组格式，如：

"keywords": [“关键字”,“keyword”]

homepage

可选字段，项目主页 URL，如：

"homepage": "https://github.com/github/github"

bugs

可选字段，问题追踪系统的URL或邮箱地址；npm bugs用的上。

{
  "url" :"http://github.com/owner/project/issues",
  "email" :"project@hostname.com"
}

license

可选字段。如果是使用一个普遍的license，比如 BSD-3-Clause 或 MIT，直接使用：

{ "license" : "BSD-3-Clause" }

author, contributors

都是可选字段。author 作者，contributors 贡献者。
author的格式如下：

{ 
  "name" : "Barney Rubble",
  "email" : "b@rubble.com",
  "url" : "http://barnyrubble.tumblr.com/"
}

这种格式也可以：

"Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)"

贡献者：

"contributors": [
    "Ændrew Rininsland <aendrew.rininsland@thetimes.co.uk> (http://www.aendrew.com)",
    "Aurelio De Rosa <a.derosa@audero.it> (http://www.audero.it/)",
    "Clay Reimann <clayreimann@gmail.com> (http://clayreimann.me)",
    "Michael Aufreiter (http://substance.io)",
    "Mathieu Dutour <mathieu@dutour.me> (https://github.com/mathieudutour)"
  ],

files

可选字段，项目包含的一组文件。如果是文件夹，文件夹下的文件也会被包含。如果需要把某些文件不包含在项目中，添加一个 .npmignore 文件。这个文件和.gitignore类似，如：

"files": [
  "dist/*"
],

main

可选字段，建议必填。这个字段的值是你程序主入口模块的ID。

• 如果其他用户需要你的包，当用户调用 require() 方法时，返回的就是这个模块的导出（exports）;
• 如果发布为一个 NPM Package，则 require 为该属性指定的文件；
• 如果未指定该属性，则默认为根目录下的 index.js 或 index.node；
  示例：

"main": "dist/components/GitHub.js",
"main": "index.js",
"main": "app.js",

scripts

可选，对象格式，如：

 "scripts":{
  "start": "node app.js",
  "server": "node server/server.js",
  "preinstall":"node-gyp rebuild"
}

可在终端使用 npm run start 来执行指定的脚本。如果包里有 binding.gyp，npm 默认在 preinstall 命令时，使用 node-gyp 做编译。

bin

可选字段。很多的包都会有执行文件需要安装到 PATH 中去。
这个字段对应的是一个Map，每个元素对应一个{ 命令名：文件名 }。

{
  "bin" : {
    "npm": "./cli.js"
  }
}

directories

用于指示包的目录结构：

directories.lib

指示库文件的位置。

directories.bin

和前面的bin是一样的，但如果前面已经有bin，那么这个就无效。
除了以上两个，还有Directories.doc、Directories.man、Directories.example。

repository

可选字段。用于指示代码存放的位置。

"repository": {
  "type": "git",
  "url": "http://github.com/npm/npm.git"
}

或使用SVN：

"repository": {
  "type": "svn",
  "url": "http://v8.googlecode.com/svn/trunk/"
}

config

可选字段，object。config 对象中的值在 Scripts 的整个周期中皆可用，专门用于给 Scripts 提供配置参数。

dependencies

可选字段，指示当前包所依赖的其他包。

{
  "dependencies": {
    "foo": "1.0.0 - 2.9999.9999",
    "bar": ">=1.0.2 <2.1.2"
  }
}

版本格式可以是下面任一种：

• version 完全匹配
• >version 大于这个版本
• >=version 大于或等于这个版本
• <version 小于这个版本
• <=version 小于或等于这个版本
• ~version 非常接近这个版本
• ^version 与当前版本兼容
• 1.2.x X代表任意数字，因此 1.2.1, 1.2.3 等都可以。
• http://... Unix 系统下使用的 tarball 的 URL。
• * 任何版本都可以
• "" 任何版本都可以
• version1 - version2 等价于 >=version1 <=version2
• range1 || range2 满足任意一个即可
• git... Git地址
• user/repo

devDependencies

可选字段，开发环境下的依赖包，格式同 dependencies 属性。

peerDependencies

可选字段。兼容性依赖。如果你的包是插件，适合这种方式。

bundledDependencies

可选字段。发布包时同时打包的其他依赖。

optionalDependencies

可选字段。如果你想在某些依赖即使没有找到，或则安装失败的情况下，npm 都继续执行。那么这些依赖适合放在这里。

engines

可选字段。既可以指定 node 版本：

{ "engines" : {"node" : ">=0.10.3 <0.12" } }

也可以指定npm版本：

{ "engines" : {"npm" : "~1.0.20" } }

engineStrick

可选字段，布尔值。如果你肯定你的程序只能在制定的 engine 上运行，设置为 true。

os

可选字段。指定模块可以在什么操作系统上运行：

"os" : [ "darwin","linux" ]
"os" : [ "!win32" ]

CPU

可选字段。指定CPU型号。

"cpu" : [ "x64","ia32" ]
"cpu" : [ "!arm","!mips" ]

preferGlobal

可选字段，布尔值。如果你的包是个命令行应用程序，需要全局安装，就可以设为 true。

private

可选字段，布尔值。如果 private 为 true，npm 会拒绝发布。这可以防止私有 repositories 不小心被发布出去，示例：

"private": true

publishConfig

可选字段。发布时使用的配置值。

资料

• package.json字段全解 作者：清箫
• 《Node.js 实战》 作者: 赵坤 / 寸志 / 雷宗民 / 吴中骅