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