Day 27 - 三周目 - 五分鐘建立私有 NPM: verdaccio

2019鐵人賽 verdaccio 私有 npm

eugenechen

2018-10-27 10:43:41

10421 瀏覽

分享至

回憶

昨天介紹 Docker 的基本使用，那些內容已足夠你下載映像檔並建立容器執行它們。

目標

今天要使用 Docker 基本操作，安裝使用私有 NPM：verdaccio

verdaccio 是一個輕量級的私有NPM proxy registry，你可以：

發佈自己的私有套件，不用上傳到 npmjs
跟往常一樣下載 npm registry (https://registry.npmjs.org) 的套件，而不用刻意切換 registry
不同的專案可以使用同一個套件，以後更新只要重發佈套件，使用的專案只要 npm upgrade 就可以更新套件。
你的套件就有版本號管理

架設 verdaccio 伺服器並建立一個帳號

安裝 verdaccio 映像檔
```
docker pull verdaccio/verdaccio
```
執行 verdaccio 伺服器
```
docker run -d --name verdaccio -p 4873:4873 verdaccio/verdaccio
```
若不懂參數請見 Day 26 - 三周目 - Docker 基本使用：看完就會架 docker 化的服務
用瀏覽器打開 http://localhost:4873，看到畫面就安裝完成了
之後的 npm 操作需要帳號登入，所以為 verdaccio 伺服器加入一個帳號
```
npm adduser --registry  http://localhost:4873
```
接下來按照指示建立一個帳號就可以了

有了一個帳號才可以做登入網站、發佈的動作。

我們接下來 npm 指令的動作都會加 --registry http://localhost:4873，這因為要指定使用我們 verdaccio 伺服器，不加的話就是預設的 https://registry.npmjs.org

發佈套件

建立一個套件 `mylog`

我們隨便開一個 Node.js 專案叫 mylog

開一個資料夾 mylog 並初始化

npm init

package.json 的內容如下：

{
  "name": "mylog",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

注意看 "main": "index.js"，這行是指：當我們 const mylog = require('mylog') 的入口檔就是根目錄的 index.js。

建立兩個檔案，當作套件實作：lib 資料夾放實作的檔案 mylog.js， index.js 負責做對外的接口

lib/mylog.js

function mylog() {
    console.log('mylog: ', ...arguments);
}

module.exports = mylog;

index.js

const mylog = require('./lib/mylog');

module.exports = {mylog};

發佈

接下來我們要登入帳號後才能發佈到 verdaccio 伺服器。只要登入過一次以後就不用了，除非你 npm logout 登出。

登入 verdaccio 伺服器
```
npm login --registry  http://localhost:4873
```
npm whoami --registry http://localhost:4873 可以確入登入帳號

發佈

npm publish --registry  http://localhost:4873

這樣就發佈完成了，刷新網站就會出現了

別人只要 npm install mylog --registry http://localhost:4873 就可以安裝私有套件。

更新版號

當套件要更新，需要更新版號後，再發佈一次。

npm 使用 Semantic Versioning (版號是有語義的)。見下表：

程式碼狀態	階段(Stage)	規則	範例	用途
第一次釋出	New product	從 1.0.0 開始	1.0.0	第一次釋出套件
bug 修正且向後相容	Patch release	增加第三碼	1.0.1	微小的修正或更改
新功能增加且向後相容	Minor release	增加第二碼且第三碼重設成 0	1.1.0	新的功能出現或修正
可能會有無法向後相容	Major release	增加第一碼且第二、三碼重設成 0	2.0.0	可能有巨大的改變，可能無法向後相容

你可以手動改版號(改 package.json 的 version)，也可以用 npm version 指令：

`npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]`

例如：原來是 1.0.0，用 npm version minor 後就變成 1.1.0

請注意，若你有用 git， npm version 除了改 package.json 的 version 還會 git commit

改成版號後，請記得重新發佈 npm publish --registry http://localhost:4873。之後使用套件的人 npm upgrade <package> 就可以升級套件。

發佈要注意

你可以加入 README.md 檔說明套件
不能重覆發佈同樣的版號，你的版號一般要遞增，雖然可以 unpublish 但還往上加比較單純。
好好決定你的版號，這會影響到用你套件的人，如何進行更新。
使用你套件的人若版號是從 1.0.4 開始，他可以在 package.json 中 dependencies 設定更新套件版號的範圍，例如：
- 1.0 或 1.0.x or ~1.0.4 : 表示只可以做 Patch releases 。如：1.0.5, 1.0.6 可更新， 1.1.0 不更新。
- 1 or 1.x or ^1.0.4：表示只可以做 Minor releases。如：1.0.5, 1.1.0 可更新， 2.0.0 不更新。
- * or x：表示可以做 Major releases。任何版號都可以更新。