npm-developers

开发指南

关于文档

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-foobar-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上聊。
告诉世界安装你的程序多么的容易

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

推荐阅读更多精彩内容

  • 1、npm是什么? NPM (node package manager),通常称为node包管理器。顾名思义,它的...
    徐国军_plus阅读 7,050评论 1 6
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,248评论 2 36
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,600评论 18 139
  • Node.js使得在服务器端使用JavaScript编写应用程序成为可能。它是基于V8Javascript运行时并...
    间阳幕宾阅读 1,570评论 0 5
  • npm是什么 NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具...
    build1024阅读 7,860评论 0 9