nodejs進階(1)——npm使用技巧和最佳實踐

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

npm使用技巧和最佳實踐

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

npm的最佳實踐

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

認識npm

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

npm version

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

npm help

和大多數的命令行工具同樣,npm也有一個內置的幫助函數, 能夠獲取命令的描述和提要,比入咱們想看看npm test命令是作什麼的,執行 npm help testnpm

1 使用npm init建立新項目

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

npm config set init.author.name YOUR_NAME
npm config set init.author.email YOUE_EMAIL
複製代碼

2 查找正確的npm包

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

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

兼容某個版本

版本號中最左邊的非0數字的右側能夠任意

若是缺乏某個版本號,則這個版本號的位置能夠任意

如:^1.1.2 ,表示>=1.1.2<2.0.0,
能夠是1.1.2,1.1.3,.....,1.1.n,1.2.n,.....,1.n.n

如:^0.2.3 ,表示>=0.2.3 <0.3.0,
能夠是0.2.3,0.2.4,.....,0.2.n

如:^0.0,表示 >=0.0.0 <0.1.0,
能夠是0.0.0,0.0.1,.....,0.0.n
複製代碼

這也意味着當你下次執行npm install的時候,即便主版本沒有更改,次版本或者修訂版本發生了改變,你的這個模塊會重裝,你能夠執行下面的命令修改安裝包版本規則 npm config set save-prefix='~'

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

~version

大概匹配某個版本

若是minor版本號指定了,那麼minor版本號不變,而patch版本號任意

若是minor和patch版本號未指定,那麼minor和patch版本號任意

如:~1.1.2,表示>=1.1.2 <1.2.0,能夠是1.1.2,1.1.3,.....,1.1.n 

如:~1.1,表示>=1.1.0 <1.2.0

如:~1,表示>=1.0.0<2.0.0,
能夠是1.0.0,1.0.1,.....,1.1.n,1.2.n,.....,1.n.n
複製代碼

若是你想保存指定的版本號,執行 npm config set save-exact true

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以下,寫個簡單的日期轉換函數

function formateTime(date) {
    let year = date.getFullYear();
    let month = date.getMonth() + 1;
    let day = date.getDay();
    month = month < 10 ? '0' + month : month;
    day = day < 10 ? '0' + day : day;
    return year + '-' + month + '-' + day;
}
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文件,內容以下

let formateTime = require('npm-link-module');
let date = new Date();
console.log(formateTime(date));
複製代碼

而後執行node index.js,能夠看到命令行已經打印出函數的執行結果了

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

return year + '/' + month + '/' + day;
複製代碼

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

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

說明一下,這個nodejs進階教程計劃寫10篇左右,如今心中有大體的框架,因此準備邊寫邊梳理,寫完會將教程目錄列出來

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

相關文章
相關標籤/搜索