发布自己的node模块

Author Avatar
Splendour 1月 05, 2016

用了那么多的 node_modules,想不想发布自己的模块呢?

在 GitHub(或者其他托管工具)创建一个项目

这可以方便用户报 bug,并且可以有其他开发者一起贡献代码。

初始化 package.json

进入目录后,执行 npm init,根据提示完成初始化,以下是 package.json 文件的几点说明

  • name: 项目名称,发布的时候要保证在 npmjs 上的唯一性
  • version: 版本号,有如下规则

版本格式:主版号.次版号.修订号,版号递增规则如下:
主版号:当你做了不相容的 API 修改,
次版号:当你做了向下相容的功能性新增,
修订号:当你做了向下相容的问题修正。
先行版号及版本编译资讯可以加到「主版号.次版号.修订号」的后面,作为延伸。

  • main: 入口文件,一般为 index.js
  • dependencies: 项目依赖

项目结构

  • lib: 存放业务逻辑温健
  • test: 存放单元测试用例
  • .npmignore: 记录哪些文件不需要被发布到 npmjs.org
  • index.js: 入口文件
  • README.md: 描述文件

持续集成

为保证模块的可用性,使用持续集成工具吧,在此不再赘述

发布

  • www.npmjs.org 注册一个账号
  • 添加 npm 本地配置
    $ npm adduser
    Username: your name
    Password: your password
    Email: yourmail
    
    成功之后,npm 认证信息会存放在 ~/.npmrc 下,我们可以使用命令 npm whoami 查看当前用户
  • 发布
    npm publish
    

至此,你的模块就发布成功了。还等什么,一起为好用的模块做出贡献吧。