發佈一款npm包幫助理解npm的使用

npm 在前端工程化中扮演着不可或缺的角色，前端工程師天天經過npm安裝項目依賴，經過npm發佈本身的包，更新包，經過npm 腳本運行開發環境，打包等。

平時專一於實現業務，一直沒有去了解一款包的發佈流程，忙裏偷閒，今天就體驗下編寫併發佈一個package的過程，記錄下來分享給你們。
一個包誕生的過程無非是：編寫-測試-發佈-迭代-測試-發佈...，
初始化項目
mkdir math-tool_demo 新建文件夾
npm init初始化package.json文件，根據提示輸入項目信息：

package name項目名
version 版本
description 描述
entry point 入口文件
test command 測試命令
git repository git倉庫地址
keywords 關鍵字信息
author 做者
協議等

npm init -y:添加 -y 標誌,直接默認生成.

編寫包裏的代碼
包含的功能：咱們實現一個加減乘除的小工具。
新建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')
  }
}

測試

測試無非就是引入編寫的模塊，並運行測試用例，此處再也不多說。

發佈

npm login 登陸。輸入帳戶密碼郵箱，若是你沒有帳戶，先申請：連接。

npm publish：發佈編寫的包
失敗：命名重複或相似: 修改一下包名。

再次發佈：npm publish:成功了！默認版本爲1.0.0

如何迭代發佈的包
包發佈出去了，bug是沒法避免的，固然做者也會考慮擴展功能，修復bug或功能迭代須要將代碼修改同步到遠程倉庫。

修改代碼
好比作出了下述的修改:

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')
  }
}

修改版本號

咱們能夠直接改package.json裏的version字段值.

不過最好仍是使用npm 提供的命令修改版本號(好比當前爲v1.0.0):

• npm version patch-->1.0.1：屬於小修改，不更改功能使用
• npm version minor-->1.1.0:可能添加了一些功能，不影響之前的使用。
• npm version major-->2.0.0:可能改了API，輸入大範圍的修改。

詳細移步：關於npm語義版本

發佈

npm publish

如何使用發佈的包

• 到npm倉庫搜索包名
• 而後，輸入npm install packageName -S [-D ]分別做爲依賴或開發依賴

下面以咱們剛發佈的包爲例：

首次使用該包
npm install -S math-tool_demo 安裝剛剛發佈的包

在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

正在使用，該包可能已經迭代更新
npm outdated檢查每一個定義在項目package.json中包在遠程倉庫是否有新版本

發現有新版本，目前使用的是1.0.0，最新的是2.0.0。
npm update [packageName]更新包

敲完，發現沒反應，並無更新包。

查看package.json中包的依賴定義

有三種版本定義：

• 直接寫準確的版本號：好比：1.0.0
• 大版本不動，有功能更新則用新版本：^1.0.0
• 更保守一點,只能小幅更新如bug修復等：~1.0.0

^1.0.0意爲>=1.0.0 < 1.2.0

~1.0.0意爲>=1.0.0 < 1.1.0

所以更新到2.0.0的是不容許的，只能手動更改package.json中的版本號,並更新了。

爲什麼弄成這樣？由於第一個數字意味着major改動，貿然的更新可能會帶來沒法預計的後果

傳送門：npm-outdated，npm-update

以上就是本文的所有內容，但願對你們的學習有所幫助
爲了學習工做與休閒娛樂互不衝突，現新建圈【碼農茶水鋪】用於程序員生活，愛好，交友，求職招聘，吐槽等話題交流，但願各位大神工做之餘到茶水鋪來喝茶聊天。瞭解更多