发布node模块到npm

npm(Node Package Manager)是Node.js的包管理工具。npm社区有很多好用的模块。在开发过程中,我们也会在项目中提炼出一些有用的功能模块。这个时候可以发布到npm并开源到github,方便别人使用同时又进一步根据issue完善和健壮模块的功能。
下面我就根据自己的一个模块koa2-validation来简单介绍发布 npm 模块的方法步骤以及一些注意点。

创建项目

通常我们的项目要放到github上开源,便于别的同学提issue。所以可以创建一个github项目(这里默认大家清楚如何使用github,不明请google)。另外,默认本机已经安装node和npm(不清楚请参考使用nvm安装node)。

项目结构

github创建项目的时候,勾选默认的 .gitignore、License 和 README 文件。本地通过npm init 来创建 package.json 文件,需要数据一些模块的信息,如名称、版本、描述、作者、license等。

$ npm init

另外,需要一些 eslint 文件等,具体的目录结构如下:

.
├── .eslintrc.json   // eslint 文件
├── .git
├── .gitignore      // .gitignore
├── .npmignore      // .npmignore 不需要publish的文件
├── .travis.yml     // travis CI
├── LICENSE
├── README.md
├── index.js       // 入口文件
├── lib            // 主要逻辑代码
├── node_modules
├── package-lock.json
├── package.json
└── test          //测试用例

主要的逻辑代码放在lib目录下。不清楚的同学可以参考koa2-validation的目录结构。

测试

项目通常需要加入必要的单元测试。而且因为可能别的同学会用到,这一点尤为重要。
关于node的测试,大家根据自己的习惯会使用mocha、jest等。我个人偏向于使用ava来进行单元测试。不清楚如何使用ava测试的,可以参考这篇。 关于更多测试结构,参考这里
关于持续集成,在github上通常使用 travis 比较多。travis使用起来也很简单方便。首先需要将你的github 账号和travis关联,travis就会同步你的github repository。然后,你需要打开对应项目的CI 开关。最后在项目中定义对应的.travis.yml即可在项目push的时候自动运行测试脚本。
更多关于travis的使用可以参考这篇官方文档.以下是我的.travis.yml 文件。

#指定运行环境
language: node_js
#指定nodejs版本,可以指定多个
node_js:
  - "7.6.0"

before_script:
  - npm install

#运行的脚本命令
script:
  - npm run test

#指定分支,只有指定的分支提交时才会运行脚本
branches:
  only:
    - master

增加徽章

完成功能开发之后,最好在 README 中详细地介绍模块的使用说明。
另外,我们经常看到 github 项目有很多漂亮的badge, 例如下载量和 测试状况等。那如何添加这些徽章呢。可以参考 shields这篇文章

发布项目

项目完成之后,我们需要将模块发布到npmjs。通常我们需要先查找一下是否自己的模块已经被注册,并确定自己的模块名称。
首先,我们需要到npm官网 注册一个账号。然后添加到本地配置。

$ npm adduser   
Username: dennis.ge
Password: ****
Email: gedennis@163.com

然后验证自己的配置。

npm whoami

最后,在package.json 定义好版本,通过 npm publish 发布模块即可。

npm publish

npm publish的时候经常会遇到发布不成功的状况。

npm WARN adduser Incorrect username or password
npm WARN adduser You can reset your account by visiting:
npm WARN adduser 
npm WARN adduser     http://admin.npmjs.org/reset

这个时候通常可能是nvm安装的npm,或者你的 npm registry 不是npmjs,通过nrm修改npm源即可。

这里只是介绍了一些简单的发布步骤,关于更多版本定义以及升级,请参考这篇

至此,我们就成功发布了一个 npm 模块。

总结

这篇文章简单介绍了一下如何发布 npm 模块。包括如何创建项目,项目结构,测试,持续集成以及如何添加badge等一些内容。
关于发布npm 模块,需要进一步了解版本的定义,以及版本的升级等更深入的内容。

参考

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

推荐阅读更多精彩内容