如何發(fā)布自己開發(fā)的npm包

原文地址: 如何發(fā)布自己開發(fā)的npm包

前一段時間開發(fā)了一些基于Vue的插件涡扼,感覺還挺好用的摘投,就發(fā)布到npm妄帘,希望大家都能使用唆鸡。

下面說一下發(fā)布npm 的流程:

注冊一個npm賬號

進入網(wǎng)址: https://www.npmjs.com 注冊一個npm賬號名斟。

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

注冊后如果需要進行頭像設(shè)置脑慧,需要到 https://en.gravatar.com 注冊一個賬號(使用的是WordPress賬號),添加頭像砰盐。

開發(fā)一個npm包

初始化倉庫

每一個npm包都需要一個package.json文件闷袒,進行常規(guī)配置。

首先進入需要發(fā)布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,那么古劲,就得在項目下創(chuàng)建一個名為index.js的文件斥赋。比如:

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

可以看到,此文件導出了一個名叫hello的函數(shù)产艾。

測試此包

將整個文件夾丟到node_modules目錄下疤剑,在node_modules同級目錄下使用npm init 創(chuàng)建 package.json,內(nèi)容大體如下:

{
  "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"
}

再在同級目錄下創(chuàng)建一個test.js闷堡,內(nèi)容如下:

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

執(zhí)行node test隘膘,控制臺輸出hello Jarrick。說明此包測試成功缚窿。

創(chuàng)建的目錄結(jié)構(gòu)如下:

projects/ # 測試項目目錄
    node_modules/ # 包目錄
        qzy-npm-test/ # 插件目錄
            index.js # 插件入口文件
            package.json # 插件配置文件
    test.js # 測試文件
    package.json # 測試配置文件

發(fā)布一個npm包

以下操作都在 projects/node_modules/qzy-npm-test/ 目錄下進行棘幸。

添加npm用戶

使用之前注冊的npm賬號進行登錄

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

發(fā)布npm包

$ npm publish

發(fā)布后可在自己的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>

比如安裝剛才發(fā)布的包:

npm i qzy-npm-test --save

使用剛才發(fā)布的包:

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

執(zhí)行node index即可看見輸出了hello qzy

詳細的使用請訪問本人的npm: https://www.npmjs.com/~quanzaiyu

參考資料

npm-參考手冊

手把手教你用npm發(fā)布一個包

怎樣刪除npm里已經(jīng)發(fā)布的包?

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末栽烂,一起剝皮案震驚了整個濱河市躏仇,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌腺办,老刑警劉巖焰手,帶你破解...
    沈念sama閱讀 216,744評論 6 502
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異怀喉,居然都是意外死亡书妻,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,505評論 3 392
  • 文/潘曉璐 我一進店門躬拢,熙熙樓的掌柜王于貴愁眉苦臉地迎上來躲履,“玉大人,你說我怎么就攤上這事聊闯」げ拢” “怎么了?”我有些...
    開封第一講書人閱讀 163,105評論 0 353
  • 文/不壞的土叔 我叫張陵菱蔬,是天一觀的道長篷帅。 經(jīng)常有香客問我,道長汗销,這世上最難降的妖魔是什么犹褒? 我笑而不...
    開封第一講書人閱讀 58,242評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮弛针,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘李皇。我一直安慰自己削茁,他們只是感情好,可當我...
    茶點故事閱讀 67,269評論 6 389
  • 文/花漫 我一把揭開白布掉房。 她就那樣靜靜地躺著茧跋,像睡著了一般。 火紅的嫁衣襯著肌膚如雪卓囚。 梳的紋絲不亂的頭發(fā)上瘾杭,一...
    開封第一講書人閱讀 51,215評論 1 299
  • 那天,我揣著相機與錄音哪亿,去河邊找鬼粥烁。 笑死贤笆,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的讨阻。 我是一名探鬼主播芥永,決...
    沈念sama閱讀 40,096評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼钝吮!你這毒婦竟也來了埋涧?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,939評論 0 274
  • 序言:老撾萬榮一對情侶失蹤奇瘦,失蹤者是張志新(化名)和其女友劉穎棘催,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體耳标,經(jīng)...
    沈念sama閱讀 45,354評論 1 311
  • 正文 獨居荒郊野嶺守林人離奇死亡醇坝,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,573評論 2 333
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了麻捻。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片纲仍。...
    茶點故事閱讀 39,745評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖贸毕,靈堂內(nèi)的尸體忽然破棺而出郑叠,到底是詐尸還是另有隱情,我是刑警寧澤明棍,帶...
    沈念sama閱讀 35,448評論 5 344
  • 正文 年R本政府宣布乡革,位于F島的核電站,受9級特大地震影響摊腋,放射性物質(zhì)發(fā)生泄漏沸版。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,048評論 3 327
  • 文/蒙蒙 一兴蒸、第九天 我趴在偏房一處隱蔽的房頂上張望视粮。 院中可真熱鬧,春花似錦橙凳、人聲如沸蕾殴。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,683評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽钓觉。三九已至,卻和暖如春坚踩,著一層夾襖步出監(jiān)牢的瞬間荡灾,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,838評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留批幌,地道東北人础锐。 一個月前我還...
    沈念sama閱讀 47,776評論 2 369
  • 正文 我出身青樓,卻偏偏與公主長得像逼裆,于是被迫代替她去往敵國和親郁稍。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,652評論 2 354

推薦閱讀更多精彩內(nèi)容