如何发布自己开发的npm包

原文地址: 如何发布自己开发的npm包

前一段时间开发了一些基于Vue的插件,感觉还挺好用的,就发布到npm,希望大家都能使用。

下面说一下发布npm 的流程:

注册一个npm账号

进入网址: https://www.npmjs.com 注册一个npm账号。

本人的npm地址为: https://www.npmjs.com/~quanzaiyu

注册后如果需要进行头像设置,需要到 https://en.gravatar.com 注册一个账号(使用的是WordPress账号),添加头像。

开发一个npm包

初始化仓库

每一个npm包都需要一个package.json文件,进行常规配置。

首先进入需要发布npm的目录,输入

npm init

进行包初始化,自动生成一个package.json文件,填写一些简单的选项,包括: 包名、版本号、主入口文件、描述、作者、脚本 等。

最终文件大致如下:

{
  "name": "qzy-npm-test",
  "version": "1.0.0",
  "description": "一个npm测试包",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "quanzaiyu",
  "license": "ISC"
}

主入口文件

可以看到,在package.json中指定主入口文件为index.js,那么,就得在项目下创建一个名为index.js的文件。比如:

function hello(name){
  console.log("hello "+ name);
}
exports.hello = hello;

可以看到,此文件导出了一个名叫hello的函数。

测试此包

将整个文件夹丢到node_modules目录下,在node_modules同级目录下使用npm init 创建 package.json,内容大体如下:

{
  "name": "projects",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "dependencies": {
    "qzy-npm-test": "^1.0.1"
  },
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

再在同级目录下创建一个test.js,内容如下:

var h = require('qzy-npm-test');
h.hello('Jarrick');

执行node test,控制台输出hello Jarrick。说明此包测试成功。

创建的目录结构如下:

projects/ # 测试项目目录
    node_modules/ # 包目录
        qzy-npm-test/ # 插件目录
            index.js # 插件入口文件
            package.json # 插件配置文件
    test.js # 测试文件
    package.json # 测试配置文件

发布一个npm包

以下操作都在 projects/node_modules/qzy-npm-test/ 目录下进行。

添加npm用户

使用之前注册的npm账号进行登录

$ npm adduser
username: xxx
password: xxx
email: xxx

发布npm包

$ npm publish

发布后可在自己的npm主页看到

更新npm包

如果之后修改过此包,需要修改package.json中的版本号字段version,使其大于当前版本,然后npm publish即可。

如果未更改版本号,会报错:

npm ERR! publish Failed PUT 403
npm ERR! code E403
npm ERR! You cannot publish over the previously published version 1.0.0. : qzy-npm-test

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\quanzaiyu\AppData\Roaming\npm-cache\_logs\2017-09-12T07_59_18_829Z-debug.log

修改版本号后则成功:

$ npm publish
+ qzy-npm-test@1.0.1

删除npm包

$ npm unpublish
$ npm unpublish --force

安装使用npm包

安装使用方法很简单,跟以前安装npm包同样的使用即可。

npm i <packageName>

比如安装刚才发布的包:

npm i qzy-npm-test --save

使用刚才发布的包:

let a = require('qzy-npm-test')
a.hello('qzy')

执行node index即可看见输出了hello qzy

详细的使用请访问本人的npm: https://www.npmjs.com/~quanzaiyu

参考资料

npm-参考手册

手把手教你用npm发布一个包

怎样删除npm里已经发布的包?

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

推荐阅读更多精彩内容

  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,245评论 2 36
  • 什么是npm? npm是javascript的包管理工具,是前端模块化下的一个标志性产物简单地地说,就是通过npm...
    雪夜酱阅读 1,210评论 0 0
  • 大家好,我是IT修真院深圳分院第3期的学员,一枚正直纯洁善良的前端程序员,今天给大家分享一下,修真院官网前端工程师...
    大大头大阅读 2,932评论 0 1
  • npm是什么 NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具...
    build1024阅读 7,844评论 0 9
  • 六级考试剩下不到半个月的时间,但是依然龟速的做题速度,不禁深深担忧,有必要好好的反思与明确剩下的两个星期如何更高效...
    逃离地球的小鬼阅读 163评论 0 0