贴士:package.json 字段解析

name

必须字段。提示:

  • 不要在name中包含 jsnode 字样;
  • 这个名字最终会是 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-ClauseMIT,直接使用:

{ "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.docDirectories.manDirectories.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

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

资料

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,496评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,407评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,632评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,180评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,198评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,165评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,052评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,910评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,324评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,542评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,711评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,424评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,017评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,668评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,823评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,722评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,611评论 2 353

推荐阅读更多精彩内容

  • 原文链接:http://www.mujiang.info/translation/npmjs/files/pack...
    R_X阅读 1,028评论 0 1
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,250评论 2 36
  • linux资料总章2.1 1.0写的不好抱歉 但是2.0已经改了很多 但是错误还是无法避免 以后资料会慢慢更新 大...
    数据革命阅读 12,159评论 2 33
  • npm是什么 NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具...
    build1024阅读 7,876评论 0 9