NPM實用指北

賈順名發表於2018-04-21
NPM

npm作為下載node附送的大禮包，大家一定不會陌生。

然而關於npm，估計大量的只是用到npm install XXX以及npm run XXX。

其實這裡邊還有很多有意思的命令&引數。
關於npm，大概有兩個作用：

  1. 能讓我們很方便的從網上下載第三方包進行實現功能
  2. 能夠讓我們自己編寫包，並上傳到網上供其他人下載

下載相關的操作

下載主要就是圍繞著install這一個命令來的。

install 可以簡寫為 i

安裝原有的依賴包

當我們處於一個專案下時，執行npm i即可安裝當前專案所有的依賴包。
包含dependencies、devDependencies、optionalDependencies和bundleDependencies中的所有。
如果我們在執行npm i時新增--production的引數，則表示是線上環境，將會忽略devDependencies下的所有依賴。

現在我們有如下的package.json檔案：

{
  "dependencies": {
    "koa": "^2.5.0"
  },
  "devDependencies": {
    "eslint": "^4.19.1"
  }
}

 

如果執行npm i，則會安裝所有的依賴。

> npm ls --depth=0
├── eslint@4.19.1
└── koa@2.5.0

 

然後我們再嘗試新增--production引數，使用--only=prod[uction]同樣可以實現效果。

> npm ls --depth=0
└── koa@2.5.0

 

使用--only=dev[elopment]則用來僅安裝devDependencies的依賴。

–depth=XXX 用來設定顯示路徑的深度，預設會遞迴將所有的依賴都列印出來。

新增依賴的安裝

上邊是直接安裝專案原有依賴的操作，如果我們要新增一些依賴，這裡有一些選項可以瞭解一下。
如果我們在執行install新增--no-save、--save-dev之類的flag時，不會直接寫入到dependencies中，而是有一些其他的處理。

各種選項：

flag description
--save-prod 預設選項 對應dependencies
--no-save 不將依賴寫進package.json
--save-dev、-D 對應devDependencies
--save-optional、-O 對應optionalDependencies，在安裝時可以通過指定--no-optional來忽略該模組下的依賴
--save-bundle、-B 對應bundleDependencies，貌似已經被廢棄了-.-
--save-exact、-E 安裝精準的某個版本，在版本號處不會新增^之類的標識
--global、-g 全域性安裝包，一般來說需要管理員許可權

更多的引數請查閱：https://docs.npmjs.com/cli/install

在package.json中經常能看到依賴的版本號前邊有一個^或~。
^和~會導致重新安裝依賴的時候，按照規則安裝最新版。
比如版本號為^2.1.0，則會匹配>=2.1.0 <3.0.0的所有包
如果版本號為~2.1.0，則會匹配>=2.1.0 <2.2.0的所有包
這兩個標識的好處是：一個包進行修復bug，只更新了最後一位版本號，所有依賴它的包不需要重新上傳自己的package.json
所以說，涉及到可能產生不相容後果的更新，請一定要修改前兩位版本號。。否則就是坑人了-.-

以及我們可以指定安裝包時候的tag或者version

npm i koa@next
npm i koa@2.0.0
npm i koa@">=2.0.0 <2.5.0"

 

這裡的next就是一個tag 如果不指定的話，有一個預設的latest。
以及第二條指定安裝2.0.0版本的koa。
最後一條則會在範圍規則內選擇最新的版本進行安裝。

上傳相關的操作

要上傳，肯定就要先進行開發。
所以我們上傳的整個流程大概是這樣的：

  1. npm init建立package.json
  2. 進行開發
  3. npm show <你的包名>，如果404，那麼恭喜你，這個名字還沒有被佔用。
  4. npm publish，上傳包。

npm init

其實有很多情況下，我們建立package.json只是為了安裝依賴，但是執行了npm init以後卻要確認好多次選填內容。
其實如果你新增了一個引數以後，npm就不會讓你確認這些選填內容了。
npm init -f，--force、-y和--yes都可以實現這個效果。
當然，如果你是要將這個資料夾作為一個pacakge發出去，則這些選填內容都是需要的。

開發包的過程

如何進行本地debug

在開發過程中，為了本地快速進行除錯，可以執行這樣的命令：
npm link <你的包名>
如果在當前包的資料夾中，可以直接執行npm link

可以簡寫為npm ln

然後在要除錯的專案中執行npm link <你的包名>
即可建立一個引用本地的連結。
在除錯完畢後，執行npm unlink來刪除連結。

如何建立命令列可執行模組

我們可以在package.json中新增bin欄位，用來指定一個檔案。

{
  "bin": {
    "sayhi": "bin/hi"
  }
}

 

檔案./bin/hi：

#!/usr/bin/env node

console.log(`hi there`)

 

如果用過-g進行全域性安裝，就會註冊對應的命令，我們在terminal中就可以直接執行了。
#!/usr/bin/env node為必須的，路徑可能會變

npm show

這個方法貌似沒有被寫在文件裡。。但它確實是存在的。
執行npm show XXX會返回這個包對應的資訊，也可以直接在後邊按照JSON的格式來進行取值：

npm show koa version
npm show koa dist-tags.latest

 

npm publish

當我們的包開發完畢後，就可以執行publish來進行上傳了。

npm publish

 

你同樣可以在後邊指定一個資料夾路徑或者壓縮包，但都需要這兩者包含package.json檔案（npm包的資訊都在這裡）

以及，我們可以在後邊拼接--tag=XXX來上傳一個對應的tag，如果不寫的話，預設會上傳到latest下。
寫tag的好處是，我們可以同時維護多份程式碼，兩者互不影響（但是要小心publish的時候一定不要忘記tag）
就比如去年的node.js穩定版還是6，但是koa已經開始使用7.6+的async/await特性，所以他們就釋出了koa@next，也就是現在的2.x，用來支援新的語法。

之後的版本更新

如果我們的包放到線上以後，發現了bug，我們需要修復它，因為npm的限制，所以每次publish必須保證version的一致性。
npm給我們提供了這樣三個命令：

  1. npm version patch
  2. npm version minor
  3. npm version major

三個命令依次會修改version的第3.2.1位。
major.minor.patch

patch

patch為改動最小的，也就是我們上邊提到過的bug修復，^和~都會相容的版本號。

minor

如果是minor，則會修改中間的版本號，一般來講，新功能的增加需要修改這個版本號，因為可能會造成之前的使用方式改變。

major

最後一個則是很大的更新才會去修改的版本號，例如我們親愛的koa，在拋棄Generator擁抱async/await就是直接釋出了koa2.x。

執行這三個命令的先提條件是，你當前倉庫是不存在未提交的修改的。
因為npm會直接幫你修改version並增加一條commit記錄，如果有未提交的修改，可能會導致版本衝突。
在執行完這些命令（或者手動修改版本號也是沒問題的），再執行npm publish即可上傳更新包了。

如果想要自定義這次提交的資訊的話，可以這樣：
npm version patch -m "Upgrade version to %s"
%s會自動被npm替換為更新後的版本號提交上去。

更新時一定記得加對應的--tag，否則預設會推到@latest上

npm scripts

關於package.json中的scripts，不知道大家瞭解多少。
如果你的包是上傳到npm上的，那麼其實有很多scripts是類似鉤子的存在。

publish

當你的包執行了publish上傳到伺服器後，這個指令碼會執行。
其實我們可以在這個地方執行git push操作來將本次的修改直接推到GitHub倉庫上，節省了一次不必要的命令鍵入。
或者如果你這個包同時還上傳到apm或者之類的同型別倉庫，也可以直接在這裡進行處理（省去多次繁瑣的操作）

install

這個指令碼會在包被安裝後執行。
比如說我們使用Flowtype開發了一個包，我們可以直接將原始碼傳到npm上，然後在install命令中執行編譯，去除flow comments。

一些依賴於node-gyp的包都會有install: node-gyp rebuild的操作。

uninstall

如果你的包會對一些全域性的資料造成影響（比如某些包可能會去改寫.bashrc之類的檔案）。
這時你可以在uninstall指令碼中將那些修改項進行還原（良心操作）。

更多的scripts鉤子：https://docs.npmjs.com/misc/scripts

小記

最近翻看了一下npm的文件，發現了很多之前很少用的命令&引數。
覺得npm做的真心很不錯，原來的一些重複性的工作，其實可以很輕鬆的使用npm相關的命令來解決。
希望大家不要只拿來進行npm install。
最後：NPM Loves You。

參考資料

https://docs.npmjs.com/cli/init
https://docs.npmjs.com/misc/developers
https://docs.npmjs.com/cli/version

相關文章