开发指南
关于文档
These are man pages.如果安装npm,应该可以用man npm-thing
去获取特定主题的文档,或者通过npm help thing
查看相同的信息
包是什么
- a) 一个目录包含一个被package.json文件描述的程序
- b) 一个包含(a)的gzip压缩文件
- c) 一个指向(b)的url
- d) 一个带着(c)的发布到registry的<name>@<version>
- e) 一个<name>@<tag>指向(d)
- f) 一个有着latest标记满足(e)的<name>
- g) 一个cloned的giturl,就成为了(a)这样
即使你从来不发布包,如果只是写一个node程序(a)的话或者如果想在压缩成(b)后能很方便的到处安装,依然可以使用npm得到很多收益。
Git urls是这种形式:
git://github.com/user/project.git#commit-ish
git+ssh://user@hostname:project.git#commit-ish
git+http://user@hostname/project/blah.git#commit-ish
git+https://user@hostname/project/blah.git#commit-ish
commit-ish
可以是任何能作为git checkout
参数引用的,比如tag,sha或者branch。默认的是master
.
package.json文件
想要使用npm做更多的事情,在项目的根目录里得需要一个package.json。这基本是整个界面
查看package.json获取更多知识。至少,你需要:
-
name: 定义项目的名字。不需要指定它的名字是在node上运行,还是js里的。可以使用
engines
字段显示的表明程序使用的node(或者其他的什么)版本,也很容易知道它是js。没必要和github repository名字匹配
所以,
need-foo
和bar-js
不是一个好名字。foo
或者bar
就更好。 -
version: semver兼容的版本。
-
engines:指定程序运行的node的版本。node API改了很多,bugs和新功能共存。自己把握。
-
author: 带点信用
-
scripts: 如果有指定的编译器或者安装脚本,那应该把它放到
scripts
对象里。至少一定要有基本的smoke-test命令作为scripts.test
。查看npm-scripts -
main:如果程序有个模块是服务入口。那就需要指定这个
main
字段 -
directories: 这是映射到文件夹的对象名。最好的是包括"lib"和"doc",但是如果使用了
man
指定了都是man pages的文件夹,就像想这些安装
可以使用npm init
获取一个还不错的基本package.json文件。查看npm-init获取更多。
让文件在包之外
使用.npmignore
文件让一些文件不在包里。如果没有.npmignore
,但是有.gitignore
文件,那就会根据.gitignore
匹配不要的文件。如果还有.gitignore
不满足,就得需要.npmignore
来覆盖了。就像git,npm会在所有的子目录里寻找.gitignore
和.npmignore
文件,而不只是根目录。
.npmgnore
文件和.gitignore
文件的规则一样:
- 空白行或者以
#
开头的行会被忽略 - 标准的glob默认工作
- 通过
/
结尾来表示一个目录 - 通过以
!
开头来取反
默认的会忽略掉以下文件,所以不需要明确的在.npmignore
里加上他们:
- .*.swp
- ._*
- .DS_Store
- .git
- .hg
- .npmrc
- .lock-wscript
- .svn
- .wafpickle-*
- config.gypi
- CVS
- npm-debug.log
还有,所有在node_modules
里的也会被忽略掉,除了bundled dependencies.npm自动的为你做这个,所以不用麻烦把node_modules
添加到.npmignore
了。
下面的文件和路径是永远不会被忽略的,所以把他们加入到.npmignore
也没用:
-
package.json
-
README(和它的变体)
-
CHANGELOG(和它的变体)
-
LICENSE / LICENCE
链接包
npm link被设计成安装开发包并且不需要重装实时查看变化(当然,需要re-link或者npm rebuild -g
更新编译的包)
more info at npm-link
发布前:保证包是可以安装和工作的
这很重要
如果局部不能安装,试图发布时会有问题。或者,更坏的是,你可以发布包,但是发布的是坏的或者没有用的包。所以不要这样做。
在包的根路径,这样做:
npm install . -g
这回显示它是否正常。如果刚好创建了一个sysmlink包指向工作目录。可以这样:
npm link
使用npm ls -g
查看是否在那。
测试安装,去其他目录,然后:
cd ../some-other-folder
npm install ../my-package
在其他地方局部安装到node_modules
然后进node-repl,试着使用require("my-thing")来让你的模块的主模块
创建一个用户账户
使用adduser 命令创建用户。
npm adduser
接着按提示来。
查看文档npm-adduser
发布包
这部分就简单咯,在根目录:
npm publish
可以发布链接到压缩包,或者压缩包的名字,或者文件的目录。
注意默认的所有在这个目录的都会被暴露,所以如果有些私人文件在里面,记得使用.npmignore
来忽略掉,或者从一个新的chekout发布。
宣传
发邮件、写博客、在IRC上聊。
告诉世界安装你的程序多么的容易
网友评论