最近,有很多人問如何從 github 上安裝 npm 包。在這篇文章中,我們將簡要介紹如何從 github 上直接安裝 npm 包,并且介紹一些需要注意的點(diǎn)。
首先,我們需要清楚從 GitHub 上安裝 npm 包的一個(gè)基本原理:npm 會將 GitHub 上的倉庫代碼 clone 到本地,然后運(yùn)行 npm install 命令安裝該倉庫中的 npm 包。因此,當(dāng)我們從 GitHub 上安裝 npm 包時(shí),需要注意以下幾點(diǎn):
- 先確認(rèn)你使用的 npm 版本是否支持從 Github 安裝依賴
從 npm 的官方文檔可知,從 npm 5.0.0 版本開始,npm 自帶了支持從 GitHub 安裝依賴的功能。因此,如果你的 npm 版本不夠新,建議先升級 npm 的版本。
- GitHub 上的倉庫中必須包含 package.json 文件
在介紹如何從 GitHub 上安裝 npm 包前,我們要先提醒一點(diǎn):我們只能從一個(gè)包含 package.json 文件的 GitHub 倉庫上安裝 npm 包。否則,npm 將無法確定該倉庫中的包依賴關(guān)系,無法正確安裝依賴。
因此,當(dāng)我們想要從 GitHub 上安裝 npm 包時(shí),需要先在該倉庫中檢查是否包含 package.json 文件。一般而言,GitHub 的倉庫中都會包含這個(gè)文件。如果沒有,就需要找其他能安裝的渠道。
- GitHub 倉庫所在位必須是公共的或者需要認(rèn)證
在默認(rèn)情況下,npm 是無法從未認(rèn)證的私有倉庫上下載依賴的。因此,當(dāng)我們從 GitHub 上安裝 npm 包時(shí),需要知道該倉庫所在位置的訪問權(quán)限:
- 如果該倉庫是公共的,那么我們可以直接從 GitHub 上安裝。
-
如果該倉庫位于私有倉庫中,我們有兩種方式安裝:
- 將該私有倉庫加入到 npm 的 .npmrc 文件中,同時(shí)登錄到該私有倉庫。
- 使用 GitHub Personal Access Token 來訪問私有倉庫。這需要從 GitHub 帳戶中生成 Personal Access Token,并將其用作命令行參數(shù)。
接下來,我們來看一下具體的安裝步驟。
步驟 1:找到 GitHub 倉庫的地址
首先,要從 GitHub 上安裝 npm 包,我們需要找到該倉庫的地址。一般而言,我們可以直接在 npm 的包列表中找到該倉庫的地址。
例如:
$ npm install https://github.com/user/repo.git
其中,https://github.com/user/repo.git 就是該倉庫的地址。
步驟 2:從 GitHub 上 clone 該倉庫
然后,我們需要使用 git 命令從 GitHub 中 clone 該倉庫。這可以通過下面的命令完成:
$ git clone https://github.com/user/repo.git
該命令會將倉庫中的代碼 clone 到本地。
步驟 3:安裝依賴
最后,我們需要進(jìn)入到該倉庫目錄中,并運(yùn)行 npm install 命令安裝依賴。
$ cd repo $ npm install
此時(shí),npm 會讀取該倉庫中的 package.json 文件,并自動安裝其依賴關(guān)系。
需要注意的是,在使用 git clone 命令后,我們得到的僅僅是該倉庫的代碼,該代碼并沒有發(fā)布到 npm 上。因此,如果我們想要發(fā)布自己的 npm 包,需要在該倉庫中創(chuàng)建注冊表文件(registry file)或者使用其他方法將其發(fā)布到 npm 上。
綜上所述,從 GitHub 上安裝 npm 包需要注意一些細(xì)節(jié),并確保該倉庫包含 package.json 文件。此外,我們也需要知道該倉庫的訪問權(quán)限,以避免出現(xiàn)安裝錯(cuò)誤。在正確理解這些細(xì)節(jié)后,我們就可以從 GitHub 安裝自己需要的 npm 包了。