280 lines
8.3 KiB
HTML
280 lines
8.3 KiB
HTML
|
<!DOCTYPE html><html><head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<title>npm-fund</title>
|
||
|
|
<style>
|
||
|
|
body {
|
||
|
|
background-color: #ffffff;
|
||
|
|
color: #24292e;
|
||
|
|
|
||
|
|
margin: 0;
|
||
|
|
|
||
|
|
line-height: 1.5;
|
||
|
|
|
||
|
|
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
|
||
|
|
}
|
||
|
|
#rainbar {
|
||
|
|
height: 10px;
|
||
|
|
background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
|
||
|
|
}
|
||
|
|
|
||
|
|
a {
|
||
|
|
text-decoration: none;
|
||
|
|
color: #0366d6;
|
||
|
|
}
|
||
|
|
a:hover {
|
||
|
|
text-decoration: underline;
|
||
|
|
}
|
||
|
|
|
||
|
|
pre {
|
||
|
|
margin: 1em 0px;
|
||
|
|
padding: 1em;
|
||
|
|
border: solid 1px #e1e4e8;
|
||
|
|
border-radius: 6px;
|
||
|
|
|
||
|
|
display: block;
|
||
|
|
overflow: auto;
|
||
|
|
|
||
|
|
white-space: pre;
|
||
|
|
|
||
|
|
background-color: #f6f8fa;
|
||
|
|
color: #393a34;
|
||
|
|
}
|
||
|
|
code {
|
||
|
|
font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
||
|
|
font-size: 85%;
|
||
|
|
padding: 0.2em 0.4em;
|
||
|
|
background-color: #f6f8fa;
|
||
|
|
color: #393a34;
|
||
|
|
}
|
||
|
|
pre > code {
|
||
|
|
padding: 0;
|
||
|
|
background-color: inherit;
|
||
|
|
color: inherit;
|
||
|
|
}
|
||
|
|
h1, h2, h3 {
|
||
|
|
font-weight: 600;
|
||
|
|
}
|
||
|
|
|
||
|
|
#logobar {
|
||
|
|
background-color: #333333;
|
||
|
|
margin: 0 auto;
|
||
|
|
padding: 1em 4em;
|
||
|
|
}
|
||
|
|
#logobar .logo {
|
||
|
|
float: left;
|
||
|
|
}
|
||
|
|
#logobar .title {
|
||
|
|
font-weight: 600;
|
||
|
|
color: #dddddd;
|
||
|
|
float: left;
|
||
|
|
margin: 5px 0 0 1em;
|
||
|
|
}
|
||
|
|
#logobar:after {
|
||
|
|
content: "";
|
||
|
|
display: block;
|
||
|
|
clear: both;
|
||
|
|
}
|
||
|
|
|
||
|
|
#content {
|
||
|
|
margin: 0 auto;
|
||
|
|
padding: 0 4em;
|
||
|
|
}
|
||
|
|
|
||
|
|
#table_of_contents > h2 {
|
||
|
|
font-size: 1.17em;
|
||
|
|
}
|
||
|
|
#table_of_contents ul:first-child {
|
||
|
|
border: solid 1px #e1e4e8;
|
||
|
|
border-radius: 6px;
|
||
|
|
padding: 1em;
|
||
|
|
background-color: #f6f8fa;
|
||
|
|
color: #393a34;
|
||
|
|
}
|
||
|
|
#table_of_contents ul {
|
||
|
|
list-style-type: none;
|
||
|
|
padding-left: 1.5em;
|
||
|
|
}
|
||
|
|
#table_of_contents li {
|
||
|
|
font-size: 0.9em;
|
||
|
|
}
|
||
|
|
#table_of_contents li a {
|
||
|
|
color: #000000;
|
||
|
|
}
|
||
|
|
|
||
|
|
header.title {
|
||
|
|
border-bottom: solid 1px #e1e4e8;
|
||
|
|
}
|
||
|
|
header.title > h1 {
|
||
|
|
margin-bottom: 0.25em;
|
||
|
|
}
|
||
|
|
header.title > .description {
|
||
|
|
display: block;
|
||
|
|
margin-bottom: 0.5em;
|
||
|
|
line-height: 1;
|
||
|
|
}
|
||
|
|
|
||
|
|
footer#edit {
|
||
|
|
border-top: solid 1px #e1e4e8;
|
||
|
|
margin: 3em 0 4em 0;
|
||
|
|
padding-top: 2em;
|
||
|
|
}
|
||
|
|
</style>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="banner">
|
||
|
|
<div id="rainbar"></div>
|
||
|
|
<div id="logobar">
|
||
|
|
<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
|
||
|
|
<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
|
||
|
|
<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
|
||
|
|
</svg>
|
||
|
|
<div class="title">
|
||
|
|
npm command-line interface
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<section id="content">
|
||
|
|
<header class="title">
|
||
|
|
<h1 id="npm-fund">npm-fund</h1>
|
||
|
|
<span class="description">Retrieve funding information</span>
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<section id="table_of_contents">
|
||
|
|
<h2 id="table-of-contents">Table of contents</h2>
|
||
|
|
<div id="_table_of_contents"><ul><li><a href="#see-also">See Also</a></li></ul></div>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||
|
|
<pre lang="bash"><code>npm fund [<pkg>]
|
||
|
|
npm fund [-w <workspace-name>]
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="description">Description</h3>
|
||
|
|
<p>This command retrieves information on how to fund the dependencies of a
|
||
|
|
given project. If no package name is provided, it will list all
|
||
|
|
dependencies 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 <code>--browser</code> config param; if there
|
||
|
|
are multiple funding sources for the package, the user will be instructed
|
||
|
|
to pass the <code>--which</code> option to disambiguate.</p>
|
||
|
|
<p>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 <code>npm ls</code>.</p>
|
||
|
|
<h4 id="example">Example</h4>
|
||
|
|
<h3 id="workspaces-support">Workspaces support</h3>
|
||
|
|
<p>It's possible to filter the results to only include a single workspace and its
|
||
|
|
dependencies using the <code>workspace</code> config option.</p>
|
||
|
|
<h4 id="example2">Example:</h4>
|
||
|
|
<p>Here's an example running <code>npm fund</code> in a project with a configured
|
||
|
|
workspace <code>a</code>:</p>
|
||
|
|
<pre lang="bash"><code>$ 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
|
||
|
|
</code></pre>
|
||
|
|
<p>And here is an example of the expected result when filtering only by
|
||
|
|
a specific workspace <code>a</code> in the same project:</p>
|
||
|
|
<pre lang="bash"><code>$ 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
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="configuration">Configuration</h3>
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<h4 id="json"><code>json</code></h4>
|
||
|
|
<ul>
|
||
|
|
<li>Default: false</li>
|
||
|
|
<li>Type: Boolean</li>
|
||
|
|
</ul>
|
||
|
|
<p>Whether or not to output JSON data, rather than the normal output.</p>
|
||
|
|
<ul>
|
||
|
|
<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
|
||
|
|
saving them to your <code>package.json</code>.</li>
|
||
|
|
</ul>
|
||
|
|
<p>Not supported by all npm commands.</p>
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<h4 id="browser"><code>browser</code></h4>
|
||
|
|
<ul>
|
||
|
|
<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
|
||
|
|
<li>Type: null, Boolean, or String</li>
|
||
|
|
</ul>
|
||
|
|
<p>The browser that is called by npm commands to open websites.</p>
|
||
|
|
<p>Set to <code>false</code> to suppress browser behavior and instead print urls to
|
||
|
|
terminal.</p>
|
||
|
|
<p>Set to <code>true</code> to use default system URL opener.</p>
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<h4 id="unicode"><code>unicode</code></h4>
|
||
|
|
<ul>
|
||
|
|
<li>Default: false on windows, true on mac/unix systems with a unicode locale,
|
||
|
|
as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</code> environment variables.</li>
|
||
|
|
<li>Type: Boolean</li>
|
||
|
|
</ul>
|
||
|
|
<p>When set to true, npm uses unicode characters in the tree output. When
|
||
|
|
false, it uses ascii characters instead of unicode glyphs.</p>
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<h4 id="workspace"><code>workspace</code></h4>
|
||
|
|
<ul>
|
||
|
|
<li>Default:</li>
|
||
|
|
<li>Type: String (can be set multiple times)</li>
|
||
|
|
</ul>
|
||
|
|
<p>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.</p>
|
||
|
|
<p>Valid values for the <code>workspace</code> config are either:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Workspace names</li>
|
||
|
|
<li>Path to a workspace directory</li>
|
||
|
|
<li>Path to a parent workspace directory (will result in selecting all
|
||
|
|
workspaces within that folder)</li>
|
||
|
|
</ul>
|
||
|
|
<p>When set for the <code>npm init</code> 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.</p>
|
||
|
|
<p>This value is not exported to the environment for child processes.</p>
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<h4 id="which"><code>which</code></h4>
|
||
|
|
<ul>
|
||
|
|
<li>Default: null</li>
|
||
|
|
<li>Type: null or Number</li>
|
||
|
|
</ul>
|
||
|
|
<p>If there are multiple funding sources, which 1-indexed source URL to open.</p>
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<!-- raw HTML omitted -->
|
||
|
|
<h2 id="see-also">See Also</h2>
|
||
|
|
<ul>
|
||
|
|
<li><a href="../commands/npm-install.html">npm install</a></li>
|
||
|
|
<li><a href="../commands/npm-docs.html">npm docs</a></li>
|
||
|
|
<li><a href="../commands/npm-ls.html">npm ls</a></li>
|
||
|
|
<li><a href="../commands/npm-config.html">npm config</a></li>
|
||
|
|
<li><a href="../using-npm/workspaces.html">npm workspaces</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<footer id="edit">
|
||
|
|
<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-fund.md">
|
||
|
|
<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
|
||
|
|
<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
|
||
|
|
</svg>
|
||
|
|
Edit this page on GitHub
|
||
|
|
</a>
|
||
|
|
</footer>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</body></html>
|