npm 中文文档 npm 中文文档
指南
npmjs.com (opens new window)
指南
npmjs.com (opens new window)
  • 快速入门

    • npm 是什么?
    • npm 安装和更新
    • npm 防止权限错误
    • npm package.json 文件
    • npm 安装包
    • npm 更新包
    • npm 卸载包
    • npm 创建 Node.js 模块
    • npm 发布和更新包
    • npm 使用语义化版本
    • npm 使用 Dist-tags 标记包
    • npm 包和模块的了解
  • 命令行
  • 配置 npm

npm fund


Synopsis


Description


This command retrieves information on how to fund the dependencies of agiven project. If no package name is provided, it will list alldependencies that are looking for funding in a tree structure, listingthe type of funding and the url to visit. If a package name is providedthen it tries to open its funding url using the --browser configparam; if there are multiple funding sources for the package, the userwill be instructed to pass the --which option to disambiguate.

The list will avoid duplicated entries and will stack all packages thatshare the same url as a single entry. Thus, the list does not have thesame shape of the output from npm ls.

Example


Workspaces support


It's possible to filter the results to only include a single workspaceand its dependencies using the workspace config option.

Example:


Here's an example running npm fund in a project with a configuredworkspace a :

And here is an example of the expected result when filtering only by aspecific workspace a in the same project:

Configuration


json


Default: false
Type: Boolean

Whether or not to output JSON data, rather than the normal output.

In npm pkg set  it enables parsing set values with JSON.parse() beforesaving them to your package.json .

Not supported by all npm commands.

browser


Default: OS X: "open" , Windows: "start" , Others: "xdg-open"
Type: null, Boolean, or String

The browser that is called by npm commands to open websites.

Set to false to suppress browser behavior and instead print urls toterminal.

Set to true to use default system URL opener.

unicode


Default: false on windows, true on mac/unix systems with a unicode locale,as defined by the LC_ALL , LC_CTYPE , or LANG  environment variables.
Type: Boolean

When set to true, npm uses unicode characters in the tree output. Whenfalse, it uses ascii characters instead of unicode glyphs.

workspace


Default:
Type: String (can be set multiple times)

Enable running a command in the context of the configured workspaces of thecurrent project while filtering by running only the workspaces defined bythis configuration option.

Valid values for the workspace config are either:

Workspace names
Path to a workspace directory
Path to a parent workspace directory (will result in selecting allworkspaces within that folder)

When set for the npm init command, this may be set to the folder of aworkspace which does not yet exist, to create the folder and set it up as abrand new workspace within the project.

This value is not exported to the environment for child processes.

which


Default: null
Type: null or Number

If there are multiple funding sources, which 1-indexed source URL to open.

See Also


package spec
npm install
npm docs
npm ls
npm config
npm workspaces
Last Updated: 2023-05-15 10:22:02