npm 常用命令详解(小结)(3)

这块内容好多,国内有好心人整理:《npm的package.json中文文档》,从这份文档拷贝出一些比较常见的,如下:

默认值

npm会根据包内容设置一些默认值。

"scripts": {"start": "node server.js"}

如果包的根目录有server.js文件,npm会默认将start命令设置为node server.js。

"scripts":{"preinstall": "node-waf clean || true; node-waf configure build"}

如果包的根目录有wscript文件,npm会默认将preinstall命令用node-waf进行编译。

"scripts":{"preinstall": "node-gyp rebuild"}

如果包的根目录有binding.gyp文件,npm会默认将preinstall命令用node-gyp进行编译。

"contributors": [...]

如果包的根目录有AUTHORS文件,npm会默认逐行按Name <email> (url)格式处理,邮箱和url是可选的。#号和空格开头的行会被忽略。

name

在package.json中最重要的就是name和version字段。他们都是必须的,如果没有就无法install。name和version一起组成的标识在假设中是唯一的。改变包应该同时改变version。

name是这个东西的名字。注意:

version

version必须能被node-semver解析,它被包在npm的依赖中。(要自己用可以执行npm install semver)

可用的“数字”或者“范围”见semver(7).

description

放简介,字符串,方便在npm search中搜索

keywords

关键字,数组、字符串,方便在npm search中搜索

bugs

你项目的提交问题的url和(或)邮件地址

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

license

你应该要指定一个许可证,让人知道使用的权利和限制的。

最简单的方法是,假如你用一个像BSD或者MIT这样通用的许可证,就只需要指定一个许可证的名字,像这样:

{ "license" : "BSD" }

如果你又更复杂的许可条件,或者想要提供给更多地细节,可以这样:

"licenses" : [ { "type" : "MyLicense" , "url" : "http://github.com/owner/project/path/to/license" } ]

repository

指定你的代码存放的地方。这个对希望贡献的人有帮助。如果git仓库在github上,那么npm docs命令能找到你。

这样做:

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

URL应该是公开的(即便是只读的)能直接被未经过修改的版本控制程序处理的url。不应该是一个html的项目页面。因为它是给计算机看的。

scripts

“scripts”是一个由脚本命令组成的hash对象,他们在包不同的生命周期中被执行。key是生命周期事件,value是要运行的命令。

参考上面的npm start、npm test命令

更多详细请看npm-scripts(7)

config

"config" hash可以用来配置用于包脚本中的跨版本参数。在实例中,如果一个包有下面的配置:

{ "name" : "foo", "config" : { "port" : "8080" } }

然后有一个“start”命令引用了npm_package_config_port环境变量,用户可以通过npm config set foo:port 8001来重写他。

参见npm-config(7)npm-scripts(7)

dependencies

依赖是给一组包名指定版本范围的一个hash。这个版本范围是一个由一个或多个空格分隔的字符串。依赖还可以用tarball或者git URL。

请不要将测试或过渡性的依赖放在dependencieshash中。见下文的devDependencies

详见semver(7).

version 必须完全和version一致

>version 必须比version大

>=version 同上

<version 同上

<=version 同上

~version 大约一样,见semver(7)

1.2.x 1.2.0, 1.2.1, 等,但不包括1.3.0

见下文'依赖URL'

* 所有

"" 空,同*

version1 - version2 同 >=version1 <=version2.

range1 || range2 二选一。

git... 见下文'依赖Git URL'

user/repo 见下文'GitHub URLs'

比如下面都是合法的:

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:http://www.heiqu.com/d1396c9b6ea33e5ffedfd93b898d562d.html