Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

npm-fund (1)

Name

npm-fund - Retrieve funding information Synopsis npm fund [<pkg>] npm fund [-w <workspace-name>] Description This command retrieves information on how to fund the dependencies of a given project. If no package name is provided, it will list all depen- dencies that are looking for funding in a tree structure, listing the type of funding and the url to visit. If a package name is provided then it tries to open its funding url using the --browser config param; if there are multiple funding sources for the package, the user will be instructed to pass the --which option to disambiguate. The list will avoid duplicated entries and will stack all packages that share the same url as a single entry. Thus, the list does not have the same shape of the output from npm ls. Example Workspaces support It's possible to filter the results to only include a single workspace and its dependencies using the workspace config option. Example: Here's an example running npm fund in a project with a configured workspace a: $ npm fund test-workspaces-fund@1.0.0 +-- https://example.com/a | | `-- a@1.0.0 | `-- https://example.com/maintainer | `-- foo@1.0.0 +-- https://example.com/npmcli-funding | `-- @npmcli/test-funding `-- https://example.com/org `-- bar@2.0.0 And here is an example of the expected result when filtering only by a specific workspace a in the same project: $ npm fund -w a test-workspaces-fund@1.0.0 `-- https://example.com/a | `-- a@1.0.0 `-- https://example.com/maintainer `-- foo@2.0.0 Configuration <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/defini- tions.js --> json o Default: false o Type: Boolean Whether or not to output JSON data, rather than the normal output. o In npm pkg set it enables parsing set values with JSON.parse() before saving them to your package.json. Not supported by all npm commands. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> browser o Default: OS X: "open", Windows: "start", Others: "xdg-open" o 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 to terminal. Set to true to use default system URL opener. <!-- automatically gen- erated, do not edit manually --> <!-- see lib/utils/config/defini- tions.js --> unicode o Default: false on windows, true on mac/unix systems with a unicode locale, as defined by the LC_ALL, LC_CTYPE, or LANG environment vari- ables. o Type: Boolean When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs. <!-- auto- matically generated, do not edit manually --> <!-- see lib/utils/con- fig/definitions.js --> workspace o Default: o Type: String (can be set multiple times) Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option. Valid values for the workspace config are either: o Workspace names o Path to a workspace directory o Path to a parent workspace directory (will result to selecting all of the nested workspaces) When set for the npm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project. This value is not exported to the environment for child processes. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> which o Default: null o Type: null or Number If there are multiple funding sources, which 1-indexed source URL to open. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->

Synopsis

Please see following description for synopsis

Description

NPM-FUND(1)                                                        NPM-FUND(1)



NAME
       npm-fund - Retrieve funding information

   Synopsis
         npm fund [<pkg>]
         npm fund [-w <workspace-name>]

   Description
       This command retrieves information on how to fund the dependencies of a
       given project. If no package name is provided, it will list all  depen-
       dencies  that  are looking for funding in a tree structure, listing the
       type of funding and the url to visit. If a  package  name  is  provided
       then it tries to open its funding url using the --browser config param;
       if there are multiple funding sources for the package, the user will be
       instructed to pass the --which option to disambiguate.

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

   Example
   Workspaces support
       It's  possible to filter the results to only include a single workspace
       and its dependencies using the workspace config option.

   Example:
       Here's an example running npm fund  in  a  project  with  a  configured
       workspace a:

         $ npm fund
         test-workspaces-fund@1.0.0
         +-- https://example.com/a
         | | `-- a@1.0.0
         | `-- https://example.com/maintainer
         |     `-- foo@1.0.0
         +-- https://example.com/npmcli-funding
         |   `-- @npmcli/test-funding
         `-- https://example.com/org
             `-- bar@2.0.0

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

         $ npm fund -w a
         test-workspaces-fund@1.0.0
         `-- https://example.com/a
           | `-- a@1.0.0
           `-- https://example.com/maintainer
               `-- foo@2.0.0

   Configuration
       <!-- AUTOGENERATED CONFIG DESCRIPTIONS  START  -->  <!--  automatically
       generated,  do  not edit manually --> <!-- see lib/utils/config/defini-
       tions.js -->

   json
       o Default: false

       o Type: Boolean


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

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


       Not  supported  by  all npm commands.  <!-- automatically generated, do
       not edit manually --> <!-- see lib/utils/config/definitions.js -->


   browser
       o Default: OS X: "open", Windows: "start", Others: "xdg-open"

       o 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  to
       terminal.

       Set  to true to use default system URL opener.  <!-- automatically gen-
       erated, do not edit  manually  -->  <!--  see  lib/utils/config/defini-
       tions.js -->


   unicode
       o Default:  false  on  windows, true on mac/unix systems with a unicode
         locale, as defined by the LC_ALL, LC_CTYPE, or LANG environment vari-
         ables.

       o Type: Boolean


       When  set to true, npm uses unicode characters in the tree output. When
       false, it uses ascii characters instead of unicode glyphs.  <!--  auto-
       matically  generated,  do not edit manually --> <!-- see lib/utils/con-
       fig/definitions.js -->


   workspace
       o Default:

       o Type: String (can be set multiple times)


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

       Valid values for the workspace config are either:

       o Workspace names

       o Path to a workspace directory

       o Path to a parent workspace directory (will result to selecting all of
         the nested workspaces)


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

       This  value  is  not  exported  to the environment for child processes.
       <!-- automatically  generated,  do  not  edit  manually  -->  <!--  see
       lib/utils/config/definitions.js -->


   which
       o Default: null

       o Type: null or Number


       If  there  are  multiple funding sources, which 1-indexed source URL to
       open.  <!-- automatically generated, do not edit manually --> <!--  see
       lib/utils/config/definitions.js -->

       <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->


See Also
       o npm help install

       o npm help docs

       o npm help ls

       o npm help config

       o npm help workspaces




ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | runtime/nodejs/nodejs-16 |
       +---------------+--------------------------+
       |Stability      | Pass-thru volatile       |
       +---------------+--------------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was   downloaded   from    https://github.com/nodejs/node/ar-
       chive/v16.11.1.zip.

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                 October 2021                      NPM-FUND(1)