配置和使用 npm - Amazon CodeCatalyst

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

配置和使用 npm

若要npm搭配使用 CodeCatalyst,您必須連線npm至套件儲存庫,並提供個人存取權杖 (PAT) 以進行驗證。您可以在 CodeCatalyst 主控台中檢視連線npm至套裝程式儲存區域的指示。

使用 npm 配置 CodeCatalyst

下列指示說明如何驗證並連線npm至 CodeCatalyst 套件儲存庫。有關 npm 的更多信息,請參閱官方的 npm 文檔

連線npm至您的 CodeCatalyst 套裝程式儲存區域
  1. 開啟主 CodeCatalyst 控台,網址為 https://codecatalyst.aws/

  2. 導航到您的項目。

  3. 在導覽窗格中,選擇 Packages (套件)

  4. 從清單中選擇您的套裝程式儲存區域。

  5. 選擇「Connect 至儲存庫」。

  6. 配置詳細信息的 P ackage 管理器客戶端中,選擇 npm 客戶端

  7. 選擇您的作業系統以檢視對應的組態步驟。

  8. 需要個人訪問令牌(PAT)來驗證 npm CodeCatalyst。如果您已經有令牌,則可以使用它。如果沒有,您可以使用以下步驟創建一個。

    1. (可選):更新名PAT稱到期日

    2. 選擇 [建立權杖]。

    3. 複製並存儲PAT在安全的位置。

      警告

      關閉對話方塊後,您將無法PAT再次看到或複製您的。認證應該很短,以盡量減少攻擊者盜用憑證後可以使用憑證的時間長度。

  9. 從項目的根目錄運行以下命令,以使用您的包存儲庫配置 npm。這些命令將執行以下操作:

    • 如果您的專案沒有專.npmrc案層級檔案,請建立專案層級檔案。

    • 將套件存放庫端點資訊新增至您的專案層級.npmrc檔案。

    • 將您的憑據(PAT)添加到用戶級.npmrc文件中。

    取代下列值。

    注意

    如果您是從主控台指示複製,則會為您更新下列指令中的值,而且不需要變更。

    • Replace (取代) username 使用您的 CodeCatalyst 使用者名稱。

    • Replace (取代) PAT 與您的 CodeCatalyst PAT.

    • Replace (取代) space_name 使用您的 CodeCatalyst 空間名稱。

    • Replace (取代) proj_name 用你的 CodeCatalyst 項目名稱。

    • Replace (取代) repo_name 使用您的 CodeCatalyst 軟件包存儲庫名稱。

    npm set registry=https://packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/ --location project npm set //packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/:_authToken=username:PAT

    對於 npm 6 或更低版本:要使 npm 始終將身份驗證令牌傳遞給甚至對於GET請求,請按如下方式設置始終身份驗證配置變量。 CodeCatalyst npm config set

    npm set //packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/:always-auth=true --location project

從套件儲存庫安裝 npm 套件 CodeCatalyst

按照中的步驟將 npm 連接到儲存庫之後使用 npm 配置 CodeCatalyst,您就可以在存放庫上執行npm命令。

您可以使用npm install指令來安裝 CodeCatalyst 套件儲存庫或其上游儲存庫中的 npm 套件。

npm install lodash

通過以下方式從 npmjs 安裝 npm 軟件包 CodeCatalyst

您可以透過儲存庫使用連線至 npmjs.com 的閘道 CodeCatalyst 儲存庫的上游連線來設定儲存庫,從 npmjs.com 安裝 npm 套件。npm-public-registry-gateway從 npmjs 安裝的套件會擷取並儲存在閘道儲存庫和最遠的下游套件儲存區域中。

若要從 npmjs 安裝套件
  1. 如果您尚未這麼做,請依照中的步驟npm使用 CodeCatalyst套件儲存庫進行設定使用 npm 配置 CodeCatalyst

  2. 檢查您的存放庫是否已將閘道儲存庫新增為上游連線。npm-public-registry-gateway您可以按照中的指示新增上游存放庫並選擇npm-public-registry-gateway存放庫,來檢查要新增或新增哪些上游來源npm-public-registry-gateway作為上游來源。

  3. 使用npm install指令安裝套件。

    npm install package_name

如需有關從上游存放庫要求套件的詳細資訊,請參閱請求具有上游存儲庫的軟件包版本

將 npm 套件發佈到您的 CodeCatalyst 套件存放庫

完成後使用 npm 配置 CodeCatalyst,您可以執行npm命令。

您可以使用npm publish指令將 npm 套件發佈至 CodeCatalyst 套件儲存庫。

npm publish

如需如何建立 npm 套件的詳細資訊,請參閱在 npm 文件上建立 Node.js 模組

npm 命令支持

下列段落摘要說明 CodeCatalyst套裝程式儲存區域支援的命令,並列出不支援的特定命令。npm

支援與套件儲存庫互動的指令

本節列出npmnpm戶端對其設定的登錄發出一或多個要求的命令 (例如,npm config set registry)。這些指令已經過驗證,在針對 CodeCatalyst 套件儲存區域叫用時可以正確運作。

Command 描述

蟲子

猜測套件錯誤追蹤器的位置URL,然後嘗試開啟它。

CI

使用乾淨的石板安裝專案。

棄用

棄用套件的版本。

死亡標籤

修改封裝發佈標籤。

文件

猜測軟件包文檔的位置URL,然後嘗試使用 --browser config 參數打開它。

醫生

執行一組檢查,以驗證您的 npm 安裝是否可以管理您的 JavaScript 套件。

安裝

安裝套件。

install-ci-test

使用乾淨的平板安裝項目並運行測試。別名:npm cit。此命令運行npm ci,然後立即運行npm test.

安裝測試

安裝軟件包並運行測試。運行npm install,然後立即執行npm test.

過時

檢查設定的登錄,以判斷是否有任何已安裝的套件已過期。

ping 配置或給定的 npm 註冊表並驗證身份驗證。

發佈

將套件版本發佈至登錄。

update

猜測套件存放庫的位置URL,然後嘗試使用 --browser config 參數來開啟它。

檢視

顯示套件中繼資料。也可用於列印中繼資料屬性。

支援的用戶端命

這些命令不需要與套件儲存庫進行任何直接互動,因此 CodeCatalyst不需要任何東西來支援它們。

Command 描述

垃圾桶 (舊版)

顯示 NPM bin 目錄。

建立

構建一個包。

快取

操作套件快取。

完成

在所有 npm 命令中啟用選項卡完成。

配置

更新使用者和全域npmrc檔案的內容。

刪除

搜尋本機套件樹狀結構,並嘗試將相依性往上移動樹狀結構,以便讓多個相依套件更有效地共用這些相依性。

編輯

編輯已安裝的套件。選取目前工作目錄中的相依性,並在預設編輯器中開啟套件目錄。

探索

瀏覽已安裝的套件。在指定的已安裝套件的目錄中產生一個子 shell。如果指定了一個命令,那麼它在子 shell 中運行,然後立即關閉。

help

獲取關於 npm 的幫助。

幫助搜索

搜索 npm 幫助文檔。

初始化

建立package.json檔案。

鏈接

符號鏈接一個包目錄。

ls

列出已安裝的套件。

從封裝建立壓縮包。

prefix

顯示首碼。除非另外指定,否則這-g是包含package.json文件的最接近父目錄。

修剪

移除父套件相依性清單中未列出的套件。

重建

在相符的資料夾上執行npm build命令。

重啟

執行套件的停止、重新啟動和啟動指令碼,以及相關的前置指令碼和後置指令碼。

將有效目node_modules錄打印為標準輸出。

運行腳本

執行任意套件指令碼。

shrinkwrap

鎖定要發佈的相依性版本。

卸載

解除安裝套件。

不支援的命

CodeCatalyst 套件儲存區域不支援這些npm指令。

Command 描述 備註

存取

設定已發佈封裝的存取層級。

CodeCatalyst 使用與公共 npmjs 存儲庫不同的權限模型。

添加用戶

新增登錄使用者帳戶

CodeCatalyst 使用與公共 npmjs 存儲庫不同的用戶模型。

審計

執行安全稽核。

CodeCatalyst 目前沒有出現安全漏洞數據。

掛鉤

管理 npm 掛鉤,包括添加,刪除,列出和更新。

CodeCatalyst 目前不支援任何變更通知機制。

登入

驗證使用者。這是 npm adduser 的別名。

CodeCatalyst 使用與公共 npmjs 存儲庫不同的身份驗證模型。如需相關資訊,請參閱 使用 npm 配置 CodeCatalyst

登出

登出登錄。

CodeCatalyst 使用與公共 npmjs 存儲庫不同的身份驗證模型。無法從 CodeCatalyst 存儲庫註銷,但是身份驗證令牌在其可配置的到期時間後過期。默認令牌持續時間為 12 小時。

所有者

管理套件擁有者。

CodeCatalyst 使用與公共 npmjs 存儲庫不同的權限模型。

profile

變更登錄設定檔的設定。

CodeCatalyst 使用與公共 npmjs 存儲庫不同的用戶模型。

search

在登錄中搜尋符合搜尋字詞的套件。

CodeCatalyst 不支援該search指令。

明星

標記您最喜歡的軟件包。

CodeCatalyst 目前不支持任何收藏夾機制。

星星

檢視標記為我的最愛的套件。

CodeCatalyst 目前不支持任何收藏夾機制。

團隊

管理團隊和團隊成員資格。

CodeCatalyst 使用與公共 npmjs 存放庫不同的使用者和群組成員資格模型。

token

管理您的身份驗證令牌。

CodeCatalyst 使用不同的模型來獲取身份驗證令牌。如需相關資訊,請參閱 使用 npm 配置 CodeCatalyst

取消發佈

從登錄中移除套件。

CodeCatalyst 不支持使用 npm 客戶端從存儲庫中刪除軟件包版本。您可以在主控台中刪除套件。

哇美

顯示 npm 使用者名稱。

CodeCatalyst 使用與公共 npmjs 存儲庫不同的用戶模型。