發(fā)布一款npm包幫助理解npm的使用
npm 在前端工程化中扮演著不可或缺的角色,前端工程師每天通過(guò)npm安裝項(xiàng)目依賴,通過(guò)npm發(fā)布自己的包,更新包,通過(guò)npm 腳本運(yùn)行開發(fā)環(huán)境,打包等。
平時(shí)專注于實(shí)現(xiàn)業(yè)務(wù),一直沒有去了解一款包的發(fā)布流程,忙里偷閑,今天就體驗(yàn)下編寫并發(fā)布一個(gè)package的過(guò)程,記錄下來(lái)分享給大家。
一個(gè)包誕生的過(guò)程無(wú)非是:編寫-測(cè)試-發(fā)布-迭代-測(cè)試-發(fā)布...,
初始化項(xiàng)目
mkdir math-tool_demo 新建文件夾
npm init初始化package.json文件,根據(jù)提示輸入項(xiàng)目信息:
- package name項(xiàng)目名
- version 版本
- description 描述
- entry point 入口文件
- test command 測(cè)試命令
- git repository git倉(cāng)庫(kù)地址
- keywords 關(guān)鍵字信息
- author 作者
- 協(xié)議等

npm init -y:添加 -y 標(biāo)志,直接默認(rèn)生成.
編寫包里的代碼
包含的功能:我們實(shí)現(xiàn)一個(gè)加減乘除的小工具。
新建index.js入口文件
module.exports = {
add:add,
minus:minus
}
function add(num1,num2) {
if(typeof num1 === 'number' && typeof num2 === 'number'){
return num1 + num2;
}else{
throw('arguments must be number')
}
}
function minus(left,right){
if(typeof left === 'number' && typeof right === 'number'){
return left - right;
}else{
throw('arguments must be number')
}
}
測(cè)試
測(cè)試無(wú)非就是引入編寫的模塊,并運(yùn)行測(cè)試用例,此處不再多說(shuō)。
發(fā)布
npm login 登錄。輸入賬戶密碼郵箱,如果你沒有賬戶,先申請(qǐng):鏈接。

npm publish:發(fā)布編寫的包
失?。好貜?fù)或類似: 修改一下包名。

再次發(fā)布:npm publish:成功了!默認(rèn)版本為1.0.0

如何迭代發(fā)布的包
包發(fā)布出去了,bug是無(wú)法避免的,當(dāng)然作者也會(huì)考慮擴(kuò)展功能,修復(fù)bug或功能迭代需要將代碼修改同步到遠(yuǎn)程倉(cāng)庫(kù)。
修改代碼
比如做出了下述的修改:
module.exports = {
add:add,
minus:minus
}
function add() {
var left = arguments[0];
var right = arguments[1];
if(typeof left === 'number' && typeof right === 'number'){
return left + right;
}else{
throw('arguments must be number')
}
}
function minus(){
var left = arguments[0];
var right = arguments[1];
if(typeof left === 'number' && typeof right === 'number'){
return left - right;
}else{
throw('arguments must be number')
}
}
修改版本號(hào)
我們可以直接改package.json里的version字段值.
不過(guò)最好還是使用npm 提供的命令修改版本號(hào)(比如當(dāng)前為v1.0.0):
- npm version patch-->1.0.1:屬于小修改,不更改功能使用
- npm version minor-->1.1.0:可能添加了一些功能,不影響以前的使用。
- npm version major-->2.0.0:可能改了API,輸入大范圍的修改。
詳細(xì)移步:關(guān)于npm語(yǔ)義版本
發(fā)布
npm publish
如何使用發(fā)布的包
- 到npm倉(cāng)庫(kù)搜索包名
- 然后,輸入
npm install packageName -S [-D ]分別作為依賴或開發(fā)依賴
下面以我們剛發(fā)布的包為例:
首次使用該包
npm install -S math-tool_demo 安裝剛剛發(fā)布的包
在index.js里引入并使用:
var math = require('math-tool_demo')
var addRes = math.add(1,2);
var minusRes = math.minus(1,2);
console.log(
addRes,
minusRes,
)//輸出:3,-1
正在使用,該包可能已經(jīng)迭代更新
npm outdated檢查每個(gè)定義在項(xiàng)目package.json中包在遠(yuǎn)程倉(cāng)庫(kù)是否有新版本

發(fā)現(xiàn)有新版本,目前使用的是1.0.0,最新的是2.0.0。
npm update [packageName]更新包

敲完,發(fā)現(xiàn)沒反應(yīng),并沒有更新包。
查看package.json中包的依賴定義

有三種版本定義:
- 直接寫準(zhǔn)確的版本號(hào):比如:1.0.0
- 大版本不動(dòng),有功能更新則用新版本:^1.0.0
- 更保守一點(diǎn),只能小幅更新如bug修復(fù)等:~1.0.0
^1.0.0意為>=1.0.0 < 1.2.0
~1.0.0意為>=1.0.0 < 1.1.0
因此更新到2.0.0的是不允許的,只能手動(dòng)更改package.json中的版本號(hào),并更新了。
為何弄成這樣?因?yàn)榈谝粋€(gè)數(shù)字意味著major改動(dòng),貿(mào)然的更新可能會(huì)帶來(lái)無(wú)法預(yù)計(jì)的后果
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
npm?install安裝報(bào)錯(cuò):gyp?info?it?worked?if?it?ends?with?
今天新啟動(dòng)一個(gè)項(xiàng)目,在 npm install 安裝依賴項(xiàng)時(shí)出現(xiàn)報(bào)錯(cuò),所以下面這篇文章主要給大家介紹了關(guān)于npm?install安裝報(bào)錯(cuò):gyp?info?it?worked?if?it?ends?with?ok的解決方法,需要的朋友可以參考下2022-07-07
Express 框架中使用 EJS 模板引擎并結(jié)合 silly-datetime
這篇文章主要介紹了Express 框架中使用 EJS 模板引擎并結(jié)合 silly-datetime 庫(kù)進(jìn)行日期格式化的實(shí)現(xiàn)方法,結(jié)合具體實(shí)例形式分析了express框架引入EJS模版以及導(dǎo)入 silly-datetime 庫(kù)的格式化方法傳遞給EJS模版使用的相關(guān)操作技巧,需要的朋友可以參考下2023-05-05
NodeJS創(chuàng)建最簡(jiǎn)單的HTTP服務(wù)器
這篇文章主要介紹了NodeJS創(chuàng)建最簡(jiǎn)單的HTTP服務(wù)器的相關(guān)資料,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-05-05
node實(shí)現(xiàn)socket鏈接與GPRS進(jìn)行通信的方法
這篇文章主要介紹了node實(shí)現(xiàn)socket鏈接與GPRS進(jìn)行通信的方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-05-05
深入解析桶排序算法及Node.js上JavaScript的代碼實(shí)現(xiàn)
桶排序Radix Sort算法利用分治思想將元素分入各桶中排序后匯總,以下我們就來(lái)深入解析桶排序算法及Node.js上JavaScript的代碼實(shí)現(xiàn),需要的朋友可以參考下2016-07-07
使用nodejs搭建微信小程序支付接口的詳細(xì)過(guò)程
前段時(shí)間做微信支付,遇到了很多坑,網(wǎng)上也沒有講解的特別明白的,通過(guò)借鑒各路人才的經(jīng)驗(yàn),最后也完成了,下面這篇文章主要給大家介紹了關(guān)于使用nodejs搭建微信小程序支付接口的詳細(xì)過(guò)程,需要的朋友可以參考下2022-12-12
Node.js版本發(fā)布策略頻率與穩(wěn)定性的平衡
這篇文章主要為大家介紹了Node.js版本發(fā)布策略頻率與穩(wěn)定性的平衡,幫助大家大家更清晰了解node發(fā)展史,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-10-10

