如何解決全局NPM模塊依賴性問題

Node 包管理器 (npm) 為 Web 開發人員提供了許多便捷的 JavaScript 模塊，極大地簡化了應用程序依賴項的查找和管理。它也方便開發者創建和發布自己的模塊，其他開發者只需使用 npm install -g your-tool 即可輕鬆獲取並使用。聽起來很完美，對吧？

呃，其實……並非如此。

關鍵要點

• 過度使用 -g 選項安裝 npm 模塊會導致問題，因為即使項目依賴於全局模塊，這些模塊也不會列為項目的依賴項。這會增加其他使用該應用程序的人員的工作量，並可能導致版本衝突。
• 為避免全局 npm 模塊依賴項帶來的問題，建議在安裝模塊時移除 -g，並替換為 --save-dev。這會將模塊保存為開發依賴項，並確保在運行 npm install 時安裝它。
• 在本地安裝依賴項後，任何打算從命令行運行的腳本都將放置在 ./node_modules/.bin/ 目錄下。使用 npm 腳本可以簡化此過程，並允許使用較短的命令運行模塊的本地版本。
• 雖然可能有點多餘，但建議將 Node 和 npm 作為項目的依賴項，並將其本地安裝到項目中。但是，這可能很複雜，因為 Node 在每個操作系統上都不相同，而且沒有簡單的方法可以保證每個人都將 Node 和 npm 的本地副本路徑添加到他們的 PATH 環境變量中。

我們遇到了一些問題

我不會說永遠不要使用 -g 選項安裝 npm 模塊，但我必須說，過度使用它會導致問題。我認為我們應該減少使用全局模塊安裝，尤其是在構建、測試或代碼檢查工具（如Gulp、Karma、JSHint 等）的情況下，原因如下：本文主要討論Gulp，因為它非常流行，而且讀起來朗朗上口，但如果您不喜歡Gulp，只需在腦海中將其替換為您喜歡的任何工具即可。

首先，全局模塊不會列為項目的依賴項，即使您的項目依賴於它們，這也會增加其他使用您的應用程序的人員的工作量。您知道需要使用 Gulp 來準備項目的生產環境，因此您全局安裝並使用它。當其他人想要開始使用或處理您優秀的開源項目時，他們不能只鍵入 npm install 然後開始工作。您最終需要在 README 文件中添加說明，例如：

要使用此項目，請按照以下步驟操作：

• git clone 倉庫
• 運行 npm install
• 運行 npm install -g gulp
• 運行 gulp 進行構建

我看到了兩個問題：首先，您增加了全局安裝 Gulp 的額外步驟；其次，您直接運行 gulp。我看到一個本可以避免的額外步驟（全局安裝 Gulp），並且我看到用戶需要知道您的應用程序使用 Gulp 來構建項目。本文主要討論第一個問題，雖然第二個問題不是那麼嚴重，但如果您最終切換工具，則需要更新說明。稍後我將討論的解決方案應該可以解決這兩個問題。

與全局安裝模塊相關的第二個主要問題是，由於安裝了錯誤的模塊版本，您可能會遇到衝突。以下兩個示例說明了這一點：

• 您六個月前創建了您的項目，當時您使用了最新版本的 Gulp。今天，有人克隆了您的項目的倉庫並嘗試運行 gulp 來構建它，但遇到了錯誤。這是因為克隆您項目的人正在運行較舊版本的 Gulp 或具有某些重大差異的較新版本的 Gulp。
• 您六個月前創建了一個使用 Gulp 的項目。從那時起，您轉到了其他項目並在您的機器上更新了 Gulp。現在您回到這個舊項目並嘗試運行 gulp，您會遇到錯誤，因為自從上次接觸該項目以來您已經更新了 Gulp。現在，您被迫更新構建過程以與新版本的 Gulp 一起使用，然後才能在項目上取得更多進展，而不是將其推遲到更方便的時間。

這些問題都可能非常嚴重。但是，正如我之前所說，我不會籠統地說永遠不要全局安裝某些東西。有些例外情況。

關於安全性的簡短說明

默認情況下，在某些系統上，全局安裝 npm 模塊需要提升的權限。如果您發現自己正在運行類似 sudo npm install -g a-package 的命令，則應更改此命令。我們的 npm 初學者指南將向您展示如何操作。

例外情況

那麼，您可以全局安裝什麼呢？簡而言之：任何您的項目不依賴的東西。例如，我安裝了一個名為 local-web-server 的全局模塊。每當我只需要查看瀏覽器中的一些HTML 文件時，我都會運行ws（這是local-web-server 的命令），它會將當前文件夾設置為localhost:8000 的根目錄，然後我可以在瀏覽器中打開那裡的任何文檔並對其進行測試。

我還遇到過想要壓縮不屬於項目一部分的 JavaScript 文件的情況，或者至少不屬於允許我設置正式構建過程的項目的情況（出於愚蠢的“公司”原因）。為此，我安裝了 uglify-js，我可以輕鬆地在幾秒鐘內從命令行壓縮任何腳本。

解決方案

既然我們知道問題可能出現在哪裡，我們該如何預防呢？您需要做的第一件事是在安裝模塊時移除 -g。您應該將其替換為 --save-dev，以便您可以將模塊保存為開發依賴項，並且在有人運行 npm install 時始終會安裝它。這只會解決我前面提到的一個次要問題，但這只是一個開始。

您需要知道的是，當您在本地安裝依賴項時，如果它有任何打算從命令行運行的腳本，它們將被放置在 ./node_modules/.bin/ 目錄中。因此，現在，如果您只是在本地安裝 Gulp，您可以通過在命令行中鍵入 ./node_modules/.bin/gulp 來運行它。當然，沒有人想輸入所有這些內容。您可以使用 npm 腳本解決此問題。

在您的 package.json 文件中，您可以添加一個類似於以下內容的 scripts 屬性：

{
    ...
    "scripts": {
        "gulp": "gulp"
    }
}

現在，您可以隨時運行 npm run gulp 來運行 Gulp 的本地版本。 npm 腳本會在檢查 PATH 環境變量之前查找 ./node_modules/.bin/ 目錄中可執行命令的本地副本。如果需要，您甚至可以通過在這些參數之前添加 -- 來將其他參數傳遞給 Gulp，例如 npm run gulp -- build-dev 等效於 gulp build-dev。

您仍然需要鍵入比全局使用 Gulp 更多的內容，但這很糟糕，但有兩種方法可以解決這個問題。第一種方法（也解決了前面提到的一個問題）是使用 npm 腳本創建別名。例如，您不一定要將您的應用程序綁定到 Gulp，因此您可以創建運行 Gulp 但不提及 Gulp 的腳本：

{
    ...
    "scripts": {
        "build": "gulp build-prod",
        "develop": "gulp build-dev"
    }
}

這樣，您可以使對 Gulp 的調用更短，並且可以使您的腳本保持通用性。通過保持通用性，您可以隨時透明地刪除Gulp 並將其替換為其他內容，而沒有人需要知道（除非他們處理構建過程，在這種情況下，他們應該已經知道它，並且可能應該參與遷移離開Gulp 的討論）。或者，您甚至可以在其中添加一個 postinstall 腳本，以便在有人運行 npm install 後立即自動運行構建過程。這將大大簡化您的 README 文件。此外，通過使用 npm 腳本，任何克隆您項目的人都應該在 package.json 文件中直接獲得關於您在項目上運行的所有過程的簡單且直接的文檔。

除了使用 npm 腳本外，還有另一個技巧可以讓您使用命令行工具的本地安裝：相對 PATH。我將 ./node_modules/.bin/ 添加到我的 PATH 環境變量中，因此只要我在項目的根目錄中，我就可以通過鍵入命令的名稱來訪問命令工具。我從我寫的另一篇文章的評論中學到了這個技巧（感謝 Gabriel Falkenberg）。

這些技巧不能完全替代您想要使用 Gulp 等工具的每種情況，它們確實需要一些工作才能設置，但我確實認為將這些工具列為您的依賴項應該是一種最佳實踐。這將防止版本衝突（這首先是依賴項管理器的主要原因之一），並將有助於簡化其他人獲取您的項目所需的步驟。

更進一步

這可能有點多餘，但我認為 Node 和 npm 也是您的項目的依賴項，它們有幾個不同的版本可能會衝突。如果您想確保您的應用程序對每個人都有效，那麼您需要某種方法來確保用戶也安裝了正確的 Node 和 npm 版本。

您可以將 Node 和 npm 的本地副本安裝到您的項目中！但這並不能解決所有問題。首先，Node 在每個操作系統上都不相同，因此每個人仍然需要確保他們下載與他們的操作系統兼容的版本。其次，即使有一種方法可以安裝通用的Node，您也需要確保每個人都有一個簡單的方法可以從他們的命令行訪問Node 和npm，例如確保每個人都將Node 和npm 本地副本的路徑添加到他們的PATH 環境變量中。沒有簡單的方法可以保證這一點。

因此，儘管我很想能夠為每個項目強制執行特定版本的 Node 和 npm，但我無法想到一個好的方法來做到這一點。如果您認為這是一個好主意並想出了一個好的解決方案，請在評論中告訴我們所有人。我很想看到一個足夠簡單的解決方案，讓這成為一種標準做法！

結語

我希望您現在能夠理解將工具列為項目的版本化依賴項的重要性。我還希望您願意為在您自己的項目中實施這些實踐而付出努力，以便我們可以將這些實踐作為標準推廣。除非您有更好的主意，否則請說出來，讓全世界都知道！

關於全局 NPM 模塊依賴項問題的常見問題解答 (FAQ)

什麼是全局 NPM 模塊依賴項問題？

全局 NPM 模塊依賴項問題是開發人員在全局安裝 Node.js 包時遇到的一個常見問題。當安裝的全局包無法訪問其本地安裝的依賴項時，就會出現此問題。這會導致應用程序功能出現錯誤和問題。該問題是由於 Node.js 處理模塊解析的方式造成的，這對於開發人員來說可能非常複雜和令人困惑。

如何解決全局 NPM 模塊依賴項問題？

有幾種方法可以解決全局 NPM 模塊依賴項問題。最有效的方法之一是本地安裝包，而不是全局安裝。這確保了該包可以訪問其所有依賴項。另一種方法是使用 npm link 命令，它會在全局包及其本地依賴項之間創建一個符號鏈接。這允許全局包訪問其依賴項，就像它們全局安裝一樣。

全局和本地安裝 Node.js 包有什麼區別？

全局安裝 Node.js 包時，它會安裝在您系統的中央位置，所有 Node.js 應用程序都可以訪問它。另一方面，當您本地安裝包時，它會安裝在您當前項目的 node_modules 目錄中，並且只有該項目可以訪問它。雖然全局安裝很方便，但它可能會導致全局 NPM 模塊依賴項問題。

什麼是 npm link 命令以及它是如何工作的？

npm link 命令是由 npm 提供的工具，用於在全局包及其本地依賴項之間創建符號鏈接。當您在包的目錄中運行 npm link 時，它會從全局 node_modules 目錄到本地包創建一個符號鏈接。這允許全局包訪問其依賴項，就像它們全局安裝一樣。

為什麼會發生全局 NPM 模塊依賴項問題？

全局 NPM 模塊依賴項問題是由於 Node.js 處理模塊解析的方式造成的。當全局安裝包時，Node.js 會在全局 node_modules 目錄中查找其依賴項。但是，如果依賴項是本地安裝的，Node.js 則找不到它們，從而導致全局 NPM 模塊依賴項問題。

我能否通過始終本地安裝包來避免全局 NPM 模塊依賴項問題？

是的，避免全局 NPM 模塊依賴項問題最有效的方法之一是始終本地安裝包。這確保了這些包可以訪問其所有依賴項。但是，這可能並不總是實用或方便，特別是如果您需要在多個項目中使用該包時。

有什麼工具或包可以幫助我管理我的 Node.js 依賴項？

是的，有幾個工具和包可以幫助您管理您的 Node.js 依賴項。例如，npm 本身提供了幾個命令，例如 npm install、npm update 和 npm outdated，可以幫助您管理您的依賴項。還有 Yarn 和 Greenkeeper 等第三方工具，它們提供了額外的功能。

不解決全局 NPM 模塊依賴項問題有哪些風險？

如果不解決全局 NPM 模塊依賴項問題，可能會導致應用程序功能出現錯誤和問題。它還會使管理和更新依賴項變得困難，從而導致潛在的安全風險和過時的包。

全局 NPM 模塊依賴項問題會影響我的應用程序的性能嗎？

是的，全局 NPM 模塊依賴項問題可能會影響應用程序的性能。如果包無法訪問其依賴項，則它可能無法正常或有效地運行。這可能會導致應用程序出現性能問題和錯誤。

如何檢查包是全局安裝還是本地安裝？

您可以使用 npm list 命令檢查包是全局安裝還是本地安裝。如果您運行 npm list -g，它將顯示所有全局安裝的包。如果您在項目的目錄中運行 npm list，它將顯示該項目本地安裝的所有包。

以上是如何解決全局NPM模塊依賴性問題的詳細內容。更多資訊請關注PHP中文網其他相關文章！