nodejs進階教程,小白繞道!!!

npm使用技巧和最佳實踐

前提:請確保安裝了node.js

npm的最佳實踐

npm install是最常見的npm cli命令,但是它還有更多能力!接下來你會瞭解npm是如何在應用的整個生命週期幫助你的-從創建一個項目到開發和部署整個生命週期

認識npm

在開始之前,我們先來看看一些查看正在運行的npm版本的命令

npm version

獲取當前npm cli正在使用的版本,你可以執行命令 npm version,這條命令除了返回版本外,還可以返回很多信息-當前包的版本,你正在使用的node.js的版本,openSSL或者V8的版本,以我本地安裝的node為例,結果如下:

npm help

和大多數的命令行工具一樣,npm也有一個內置的幫助函數, 可以獲取命令的描述和提要,比入我們想看看npm test命令是做什麼的,執行 npm help test

1 使用 npm init創建新項目

使用 npm init命令可以幫助你互動式地創建 package.json文件,會彈出項目名稱和描述的問題,有一個快速的解決方法 npm init--yes(或者簡寫 npm init-y),那麼就不會彈出任何問題了,僅僅是使用默認配置創建一個 package.json, 使用下面的命令,你可以配置這些默認配置

  1. npm config set init.author.name YOUR_NAME
  2. npm config set init.author.email YOUE_EMAIL

2 查找正確的npm包

查找正確的npm包相當具有挑戰性-有成千上萬的包可供選擇,因此選擇正確的npm 包很令人苦惱了,然而,我們可以選擇一個模塊幫助我們發送HTTP請求 有一個網站可以幫助我們簡單地完成這個任務,它就是npms.io,它會展示包的質量,受歡迎度,和維護性,這些是通過一個模塊是否更新了依賴,是否有提示配置,是否做了測試覆蓋,最近有沒有提交記錄來綜合計算得出的

3 檢查npm包

一旦我們找到了我們的模塊(在我們的例子中是一個request模塊),我們應該看一下文檔,查看issues,以便更好地瞭解我們即將引入到應用中的包,不要忘記你使用的npm包越多,你的項目的風險就越高

如果你想在cli中打開這個模塊的首頁,執行

npm home request

打開模塊的issues

npm bugs request

或者你只是想查看模塊的git倉庫,執行下面的命令

npm repo request

4 保存依賴

npm採用semver進行控制

所謂SEMVER,指的是語義化版本,其規則概述如下: 版本格式:主版本號.次版本號.修訂號,版本號遞增規則如下:

  • 主版本號:新的架構調整,不兼容老版本
  • 次版本號:新增功能,兼容老版本
  • 修訂號:修復bug,兼容老版本。

一旦你決定將第三方包引入你的項目,你必須安裝和保存它,最常見的命令是 npm install some-package,如果你想自動將包信息添加進 package.json文件,你需要執行 npm install some-package--save

npm默認會帶著^』這個前綴保存你的包,具體的安裝規則如下:

^version

  1. 兼容某個版本
  2. 版本號中最左邊的非0數字的右側可以任意
  3. 如果缺少某個版本號,則這個版本號的位置可以任意
  4. 如:^1.1.2 ,表示>=1.1.2<2.0.0,
  5. 可以是1.1.2,1.1.3,.....,1.1.n,1.2.n,.....,1.n.n
  6. 如:^0.2.3 ,表示>=0.2.3 <0.3.0,
  7. 可以是0.2.3,0.2.4,.....,0.2.n
  8. 如:^0.0,表示 >=0.0.0 <0.1.0,
  9. 可以是0.0.0,0.0.1,.....,0.0.n

這也意味著當你下次執行 npm install的時候,即使主版本沒有更改,次版本或者修訂版本發生了改變,你的這個模塊會重裝,你可以執行下面的命令修改安裝包版本規則 npm configsetsave-prefix=~

這個包前綴的安裝規則如下:

~version

  1. 大概匹配某個版本
  2. 如果minor版本號指定了,那麼minor版本號不變,而patch版本號任意
  3. 如果minor和patch版本號未指定,那麼minor和patch版本號任意
  4. 如:~1.1.2,表示>=1.1.2 <1.2.0,可以是1.1.2,1.1.3,.....,1.1.n
  5. 如:~1.1,表示>=1.1.0 <1.2.0
  6. 如:~1,表示>=1.0.0<2.0.0,
  7. 可以是1.0.0,1.0.1,.....,1.1.n,1.2.n,.....,1.n.n

如果你想保存指定的版本號,執行 npm configsetsave-exacttrue

5 鎖定依賴

上面已經介紹過了,npm採用語義化的版本號 semver 進行控制,讓開發過程中依賴的獲取和升級變得非常容易,但不嚴格的版本號控制,也帶來了不確定性

  • npm建議使用semver版本,但是部分包不遵循semver;
  • package.json 可以使用精確的版本號控制你的直接依賴包,但第三方依賴的包無法管理;
  • 在開發階段執行得到的包的版本,和後續部署時得到的可能是不一致的,更不可控的是,你依賴的第三方包也有這樣的情況會導致潛在的上線風險。

可以用 npm shrinkwrap解決這個問題,這條命令會生成一個npm-shrinkwrap.json,這個文件裡面不僅包含了安裝在你機器上的指定版本的包,而且還有包的指定版的依賴包,一旦在項目的根目錄下有這個文件,你執行 npm install命令會重新生成一個相同的依賴樹

6 檢查項目的依賴包有無更新

npm有一個內置的工具方法命令 npm outdated可以檢查過時的包,在你項目下運行`npm outdated即可,但是手動執行檢查更新命令就很煩了,有一個可以自動執行包更新檢查的工具Greenkeeper,有興趣的童鞋可以戳進鏈接瞭解。

7 開發包

在本地開發npm包的時候,我們可以使用 npm link命令,將npm模塊鏈接到對應的運行項目中去,方便地對模塊進行調試和測試

舉個例子來說明是什麼意思以及怎麼使用吧

我們現在有兩個項目,分別是npm-link-module和npm-link-test,其中npm-link-module是我們要開發的npm包,npm-link-test用來測試我們開發的包

在npm-link-module下執行 npm init-y生成一個默認的包配置文件package.json,在目錄下新建index.js如下,寫個簡單的日期轉換函數

  1. function formateTime(date) {
  2. let year = date.getFullYear();
  3. let month = date.getMonth() + 1;
  4. let day = date.getDay();
  5. month = month < 10 ? 0 + month : month;
  6. day = day < 10 ? 0 + day : day;
  7. return year + - + month + - + day;
  8. }
  9. module.exports = formateTime

然後執行 npm link, 執行命令後,npm-link-module會根據package.json上的配置,被鏈接到全局,路徑是 {prefix}/lib/node_modules/<package>,這是官方文檔上的描述,我們可以使用npm config get prefix命令獲取到prefix的值(我使用的是windows,實際被鏈接到的路徑是 {prefix}/node_modules/<package>)

我們可以看到,已經在這個目錄下面生成了一個npm-link-module的快捷方式

再進入npm-link-test,執行 npm init-y生成包文件,接著執行 npm link npm-link-module 可以看到在這個項目的node_modules目錄下生產了一個npm-link-module的快捷方式

現在npm-link-test這個項目就可以引用這個 npm-link-module這個模塊了

我們在npm-link-test的目錄下新建index.js文件,內容如下

  1. let formateTime = require(npm-link-module);
  2. let date = new Date();
  3. console.log(formateTime(date));

然後執行node index.js,可以看到命令行已經列印出函數的執行結果了

然後,我們修改下npm-link-module中的index.js文件的日期函數,返回結果就修改成返回斜線格式的日期

  1. return year + / + month + / + day;

再回到npm-link-test目錄下執行index.js,可以看到,返回結果已經變成了斜線的日期

看到了吧,所有對npm-link-module的修改會被直接映射到npm-link-test/node_modules/npm-link-module

說明一下,這個nodejs進階教程計劃寫10篇左右,現在心中有大致的框架,所以準備邊寫邊梳理,寫完會將教程目錄列出來

下面是我的個人前端公眾號,歡迎大家掃碼關注,第一時間獲取教程的更新信息

推薦閱讀:

相關文章