npm search

npm 搜尋

新專案管理↔️ Algolia 複製工具。由 Algolia 和 jsDelivr 維護。

&

這是一個故障復原 npm 註冊表到 Algolia 索引複製過程。它將所有 npm 套件複製到 Algolia 索引並保持最新。複製的狀態保存在 Algolia 索引設定中。

複製應該始終運行。每個 Algolia 索引只能同時執行一個實例。如果該過程失敗，請重新啟動它，複製過程將在它記住的最後一點繼續。

• ？ npm-搜尋 ⛷ ？
  • 阿爾戈利亞指數
    • 使用公共索引
    • 模式
    • 排行
      • 文字相關性
        • 可搜尋的屬性
        • 前綴搜尋
        • 錯字容忍
        • 精確提升
      • 客製化/業務相關性
        • 下載次數
        • 熱門套餐
  • 用法
    • 生產
    • 重新啟動
  • 它是如何運作的？
  • 貢獻

阿爾戈利亞指數

使用公共索引

Algolia 索引目前由一些選定的項目免費使用（例如：yarnpkg.com、codesandbox.io、jsdelivr.com 等）。

如果您想將此索引包含到您的專案中，請在此處建立支援請求：Algolia 支援。

該產品是社區的開源產品，不受 Algolia 支援。

要符合資格，您的專案必須滿足以下要求：

• 公開可用：該項目必須可公開使用，如果適用，還應包含有關社區如何使用它的文件或說明。
• 非商業性：專案不能用於推廣產品或服務；它必須免費為社區提供有價值的東西。由商業實體支持的非商業項目的申請將根據具體情況進行審查。

您也可以使用程式碼或公用 docker 映像來執行您自己的映像（截至 2021 年 9 月，它將建立約 300 萬筆記錄 x4）。

模式

對於每個 NPM 包，我們都會在 Algolia 索引中建立一筆記錄。產生的記錄具有以下架構：

 {
  name : 'babel-core' ,
  downloadsLast30Days : 10978749 ,
  downloadsRatio : 0.08310651682685861 ,
  humanDownloadsLast30Days : '11m' ,
  jsDelivrHits : 11684192 ,
  popular : true ,
  version : '6.26.0' ,
  versions : {
    // [...]
    '7.0.0-beta.3' : '2017-10-15T13:12:35.166Z' ,
  } ,
  tags : {
    latest : '6.26.0' ,
    old : '5.8.38' ,
    next : '7.0.0-beta.3' ,
  } ,
  description : 'Babel compiler core.' ,
  dependencies : {
    'babel-code-frame' : '^6.26.0' ,
    // [...]
  } ,
  devDependencies : {
    'babel-helper-fixtures' : '^6.26.0' ,
    // [...]
  } ,
  repository : {
    url : 'https://github.com/babel/babel/tree/master/packages/babel-core' ,
    host : 'github.com' ,
    user : 'babel' ,
    project : 'babel' ,
    path : '/tree/master/packages/babel-core' ,
    branch : 'master' ,
  } ,
  readme : '# babel-corenn> Babel compiler core.nnn [... truncated at 200kb]' ,
  owner : {
    // either GitHub owner or npm owner
    name : 'babel' ,
    avatar : 'https://github.com/babel.png' ,
    link : 'https://github.com/babel' ,
  } ,
  deprecated : 'Deprecated' , // This field will be removed, please use `isDeprecated` instead
  isDeprecated : true ,
  deprecatedReason : 'Deprecated' ,
  isSecurityHeld : false , // See https://github.com/npm/security-holder
  badPackage : false ,
  homepage : 'https://babeljs.io/' ,
  license : 'MIT' ,
  keywords : [
    '6to5' ,
    'babel' ,
    'classes' ,
    'const' ,
    'es6' ,
    'harmony' ,
    'let' ,
    'modules' ,
    'transpile' ,
    'transpiler' ,
    'var' ,
    'babel-core' ,
    'compiler' ,
  ] ,
  created : 1424009748555 ,
  modified : 1508833762239 ,
  lastPublisher : {
    name : 'hzoo' ,
    email : '[email protected]' ,
    avatar : 'https://gravatar.com/avatar/851fb4fa7ca479bce1ae0cdf80d6e042' ,
    link : 'https://www.npmjs.com/~hzoo' ,
  } ,
  owners : [
    {
      email : '[email protected]' ,
      name : 'thejameskyle' ,
      avatar : 'https://gravatar.com/avatar/8a00efb48d632ae449794c094f7d5c38' ,
      link : 'https://www.npmjs.com/~thejameskyle' ,
    } ,
    // [...]
  ] ,
  lastCrawl : '2017-10-24T08:29:24.672Z' ,
  dependents : 3321 ,
  types : {
    ts : 'definitely-typed' , // definitely-typed | included | false
    definitelyTyped : '@types/babel__core' ,
  } ,
  moduleTypes : [ 'unknown' ] , // esm | cjs | none | unknown
  styleTypes : [ 'none' ] , // file extensions like css, less, scss or none if no style files present
  humanDependents : '3.3k' ,
  changelogFilename : null , // if babel-core had a changelog, it would be the raw GitHub url here
  objectID : 'babel-core' ,
  // the following fields are considered internal and may change at any time
  _downloadsMagnitude : 8 ,
  _jsDelivrPopularity : 5 ,
  _popularName : 'babel-core' ,
  _searchInternal : {
    alternativeNames : [
      // alternative versions of this name, to show up on confused searches
    ] ,
  } ,
}

排行

如果您想了解有關 Algolia 排名演算法如何運作的更多信息，您可以閱讀這篇文章。

文字相關性

可搜尋的屬性

我們將搜尋限制為僅使用屬性的子集：

• _popularName
• name
• description
• keywords
• owner.name
• owners.name

前綴搜尋

Algolia 提供預設的前綴搜尋功能（僅符合開頭的單字）。對於owner.name和owners.name屬性停用此功能。

錯字容忍

Algolia 提供預設的拼字錯誤容忍度。

精確提升

使用 Algolia 的optionalFacetFilters功能，我們可以增強套件名稱的精確匹配，以便始終位於結果的頂部。

客製化/業務相關性

下載次數

對於每個包，我們使用過去 30 天內的下載次數作為 Algolia 的customRanking設定。這將用於對彼此具有相同文字相關性的結果進行排序。

例如，搜尋babel並符合babel-core和babel-messages 。從文字相關性的角度來看，這兩個包以相同的方式完全匹配。在這種情況下，Algolia 將依賴customRanking設置，因此將過去 30 天內下載次數最多的軟體包放在前面。

熱門套餐

如果某些軟體包比其他軟體包下載“更多”，則它們將被視為受歡迎。目前，如果滿足以下任一條件，我們認為某個軟體包很受歡迎：

• 佔 npm 下載總數的0.005%以上，
• 位於 jsDelivr 的前 1000 個軟體包中。

這個popular標誌也用於提高一些記錄而不是非流行的記錄。

用法

生產

yarn
apiKey=... yarn start

重新啟動

若要從特定點（或從頭開始）重新啟動：

seq=0 apiKey=... yarn start

當您想要完全重新同步 npm 註冊表時，這非常有用，因為：

• 您更改了格式化包的方式
• 您新增了更多元資料（例如 GitHub star）
• 你處於一種不確定的狀態，你只想重新開始一切

seq表示 CouchDB 術語中的更改序列。

它是如何運作的？

我們這個計畫的目標是：

• 能夠快速進行完整的重建
• 對失敗有彈性
• 清理包數據

當進程以seq=0開始時：

• 儲存 npm 註冊表中的目前序列狀態（Algolia 設定）
• 使用 /_all_docs 引導初始索引內容
• 複製自當前序列以來的註冊表更改
• 持續監視註冊表更改並複製它們

複製和監視是分開的，因為：

1. 在複製中，我們希望快速複製一批文檔
2. 在手錶方面，我們希望盡快做出新的改變，一項一項。如果手錶要求批量為 100 個，則新包添加到索引中的時間會太晚

貢獻

請參閱 CONTRIBUTING.md