“无关紧要”的小知识点：“xx Packages Are Looking for Funding”—

“无关紧要”的小知识点：“xx Packages Are Looking for Funding”——npm fund命令及运行机制

“无关紧要”的小知识点：“xx Packages Are Looking for Funding”——npm fund 命令及运行机制

在 Node.js 和 npm 生态系统中，开源项目的持续发展和维护常常依赖于贡献者的支持和资助。为了让开发者更容易了解他们依赖的项目哪些有资金支持选项，npm 在6.13.0版本起引入了 npm fund 命令并默认在npm install安装依赖时触发。本文将详细介绍 npm fund 的作用、运行机制、触发时机、如何避免触发以及相关的副作用和改进建议。

什么是 npm fund 命令？

在日常npm install安装依赖的过程中，我们可能都忽略了 command 最后输出的一些信息，比如本文相关的 funding 信息，如：

3 packages are looking for funding.
Run "npm fund" to find out more.

npm fund 命令是在 npm 6.13.0 版本中首次引入的，旨在帮助开发者识别其项目依赖中可以资助的开源包。运行该命令时，npm 会列出所有包含资助选项的包及其相关链接，便于开发者快速访问这些页面并提供支持。

命令起源

在 2019 年 8 月份时，Standard JS 在其开源项目中内置广告的事件引发热议，这些广告通过一个名为 Funding 的 npm 软件包展示在终端，该软件包包含在 Standard 的代码库中。之后 npm 公司宣布将禁止此类终端广告行为。

此事件后，npm 公司表示，它打算在年底前为开源开发人员开发一个众筹平台，于是乎在npm 6.13.0版本上提供了相应支持，这就是npm fund命令的主要由来。

命令作用

显示资助信息：npm fund 会扫描项目中的 node_modules 目录，查找每个包的 package.json 文件中是否包含 funding 字段。它会将有资助选项的包及其资助链接列出。
支持开源生态：通过此功能，npm 提高了对开源项目资助的透明度，鼓励开发者参与到开源项目的资助中，帮助维护者获得资金支持。

使用方法

基本用法非常简单，只需在项目根目录中运行：

npm fund

命令将输出形如：

xx packages are looking for funding
run `npm fund` for details

再运行 npm fund，就会显示类似如下的详细信息：

package-name   https://example.com/donate

如：

├─┬ https://opencollective.com/typescript-eslint
│ │ └── @typescript-eslint/eslint-plugin@4.28.5, @typescript-eslint/experimental-utils@4.28.5, @typescript-eslint/types@4.28.5, @typescript-eslint/typescript-estree@4.28.5, @typescript-eslint/visitor-keys@4.28.5, @typescript-eslint/scope-manager@4.28.5, @typescript-eslint/parser@4.28.5
│ └─┬ https://opencollective.com/eslint
│   │ └── eslint@6.8.0
│   ├── https://github.com/sponsors/epoberezkin
│   │   └── ajv@6.12.6
│   ├── https://github.com/sponsors/sindresorhus
│   │   └── globals@12.4.0, import-fresh@3.3.0, strip-json-comments@3.1.1, ansi-escapes@4.3.2, type-fest@0.21.3, figures@3.2.0, onetime@5.1.2, globby@11.0.4
│   ├── https://github.com/sponsors/isaacs
│   │   └── glob@7.2.3
│   ├─┬ https://github.com/chalk/chalk?sponsor=1
│   │ │ └── chalk@4.1.2
│   │ └── https://github.com/chalk/ansi-styles?sponsor=1
│   │     └── ansi-styles@4.3.0
│   └── https://github.com/sponsors/ljharb
│       └── minimist@1.2.8, is-generator-function@1.0.9, qs@6.11.2, side-channel@1.0.4, call-bind@1.0.2, get-intrinsic@1.1.1, has-symbols@1.0.2, object-inspect@1.11.0
├── https://github.com/sponsors/RubenVerborgh
│   └── follow-redirects@1.15.2
└── https://ko-fi.com/tunnckoCore/commissions
    └── formidable@1.2.2

npm fund 的运行机制和触发时机

运行机制

依赖扫描：npm fund 会读取 node_modules 中每个依赖包的 package.json 文件，寻找 funding 字段。如果找到了该字段，它会提取并显示相关的资助信息。
- 字段格式：funding 字段可以是 URL 字符串或更复杂的对象，指向资助页面。例如：
```
{
  "funding": "https://example.com/donate"
}
```
或者
```
{
  "funding": {
    "type": "individual",
    "url": "https://example.com/donate"
  }
}
```

触发时机

npm install 提示：在安装项目依赖时，如果项目中存在可以资助的包，npm 会显示类似“xx packages are looking for funding”的提示，提醒开发者可以运行 npm fund 查看详细信息。（这也是我们日常主要触发的时机）
显式调用：开发者可以手动运行 npm fund 命令，以查看当前项目中支持资助的所有包和资助链接。