Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deps: upgrade npm to 11.2.0 #57334

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
62 changes: 30 additions & 32 deletions deps/npm/docs/content/commands/npm-cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,59 +11,56 @@ npm cache add <package-spec>
npm cache clean [<key>]
npm cache ls [<name>@<version>]
npm cache verify
npm cache npx ls
npm cache npx rm [<key>...]
npm cache npx info <key>...
```

Note: This command is unaware of workspaces.

### Description

Used to add, list, or clean the npm cache folder.
Used to add, list, or clean the `npm cache` folder.
Also used to view info about entries in the `npm exec` (aka `npx`) cache folder.

#### `npm cache`

* add:
Add the specified packages to the local cache. This command is primarily
intended to be used internally by npm, but it can provide a way to
add data to the local installation cache explicitly.
Add the specified packages to the local cache. This command is primarily intended to be used internally by npm, but it can provide a way to add data to the local installation cache explicitly.

* clean:
Delete all data out of the cache folder. Note that this is typically
unnecessary, as npm's cache is self-healing and resistant to data
corruption issues.
Delete a single entry or all entries out of the cache folder. Note that this is typically unnecessary, as npm's cache is self-healing and resistant to data corruption issues.

* ls:
List given entries or all entries in the local cache.

* verify:
Verify the contents of the cache folder, garbage collecting any unneeded
data, and verifying the integrity of the cache index and all cached data.
Verify the contents of the cache folder, garbage collecting any unneeded data, and verifying the integrity of the cache index and all cached data.

#### `npm cache npx`

* ls:
List all entries in the npx cache.

* rm:
Remove given entries or all entries from the npx cache.

* info:
Get detailed information about given entries in the npx cache.

### Details

npm stores cache data in an opaque directory within the configured `cache`,
named `_cacache`. This directory is a
[`cacache`](http://npm.im/cacache)-based content-addressable cache that
stores all http request data as well as other package-related data. This
directory is primarily accessed through `pacote`, the library responsible
for all package fetching as of npm@5.
npm stores cache data in an opaque directory within the configured `cache`, named `_cacache`. This directory is a [`cacache`](http://npm.im/cacache)-based content-addressable cache that stores all http request data as well as other package-related data. This directory is primarily accessed through `pacote`, the library responsible for all package fetching as of npm@5.

All data that passes through the cache is fully verified for integrity on
both insertion and extraction. Cache corruption will either trigger an
error, or signal to `pacote` that the data must be refetched, which it will
do automatically. For this reason, it should never be necessary to clear
the cache for any reason other than reclaiming disk space, thus why `clean`
now requires `--force` to run.
All data that passes through the cache is fully verified for integrity on both insertion and extraction. Cache corruption will either trigger an error, or signal to `pacote` that the data must be refetched, which it will do automatically. For this reason, it should never be necessary to clear the cache for any reason other than reclaiming disk space, thus why `clean` now requires `--force` to run.

There is currently no method exposed through npm to inspect or directly
manage the contents of this cache. In order to access it, `cacache` must be
used directly.
There is currently no method exposed through npm to inspect or directly manage the contents of this cache. In order to access it, `cacache` must be used directly.

npm will not remove data by itself: the cache will grow as new packages are
installed.
npm will not remove data by itself: the cache will grow as new packages are installed.

### A note about the cache's design

The npm cache is strictly a cache: it should not be relied upon as a
persistent and reliable data store for package data. npm makes no guarantee
that a previously-cached piece of data will be available later, and will
automatically delete corrupted contents. The primary guarantee that the
cache makes is that, if it does return data, that data will be exactly the
data that was inserted.
The npm cache is strictly a cache: it should not be relied upon as a persistent and reliable data store for package data. npm makes no guarantee that a previously-cached piece of data will be available later, and will automatically delete corrupted contents. The primary guarantee that the cache makes is that, if it does return data, that data will be exactly the data that was inserted.

To run an offline verification of existing cache contents, use `npm cache
verify`.
Expand All @@ -88,6 +85,7 @@ The location of npm's cache directory.
* [npm install](/commands/npm-install)
* [npm publish](/commands/npm-publish)
* [npm pack](/commands/npm-pack)
* [npm exec](/commands/npm-exec)
* https://npm.im/cacache
* https://npm.im/pacote
* https://npm.im/@npmcli/arborist
Expand Down
10 changes: 10 additions & 0 deletions deps/npm/docs/content/commands/npm-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,16 @@ more information, or [npm init](/commands/npm-init).



#### `init-type`

* Default: "commonjs"
* Type: String

The value that `npm init` should use by default for the package.json type
field.



#### `init-version`

* Default: "1.0.0"
Expand Down
2 changes: 1 addition & 1 deletion deps/npm/docs/content/commands/npm-ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ packages will *also* show the paths to the specified packages. For
example, running `npm ls promzard` in npm's source tree will show:

```bash
npm@11.1.0 /path/to/npm
npm@11.2.0 /path/to/npm
└─┬ [email protected]
└── [email protected]
```
Expand Down
2 changes: 1 addition & 1 deletion deps/npm/docs/content/commands/npm.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Note: This command is unaware of workspaces.

### Version

11.1.0
11.2.0

### Description

Expand Down
10 changes: 10 additions & 0 deletions deps/npm/docs/content/using-npm/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -809,6 +809,16 @@ more information, or [npm init](/commands/npm-init).



#### `init-type`

* Default: "commonjs"
* Type: String

The value that `npm init` should use by default for the package.json type
field.



#### `init-version`

* Default: "1.0.0"
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-access.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-access----1110">
<h1 id="----npm-access----1120">
<span>npm-access</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Set access level on published packages</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-adduser.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-adduser----1110">
<h1 id="----npm-adduser----1120">
<span>npm-adduser</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Add a registry user account</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-audit.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-audit----1110">
<h1 id="----npm-audit----1120">
<span>npm-audit</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Run a security audit</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-bugs.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-bugs----1110">
<h1 id="----npm-bugs----1120">
<span>npm-bugs</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Report bugs for a package in a web browser</span>
</header>
Expand Down
72 changes: 37 additions & 35 deletions deps/npm/docs/output/commands/npm-cache.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,71 +141,72 @@

<section id="content">
<header class="title">
<h1 id="----npm-cache----1110">
<h1 id="----npm-cache----1120">
<span>npm-cache</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Manipulates packages cache</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="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#details">Details</a></li><li><a href="#a-note-about-the-caches-design">A note about the cache's design</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#cache"><code>cache</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><ul><li><a href="#npm-cache"><code>npm cache</code></a></li><li><a href="#npm-cache-npx"><code>npm cache npx</code></a></li></ul><li><a href="#details">Details</a></li><li><a href="#a-note-about-the-caches-design">A note about the cache's design</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#cache"><code>cache</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
</section>

<div id="_content"><h3 id="synopsis">Synopsis</h3>
<pre><code class="language-bash">npm cache add &lt;package-spec&gt;
npm cache clean [&lt;key&gt;]
npm cache ls [&lt;name&gt;@&lt;version&gt;]
npm cache verify
npm cache npx ls
npm cache npx rm [&lt;key&gt;...]
npm cache npx info &lt;key&gt;...
</code></pre>
<p>Note: This command is unaware of workspaces.</p>
<h3 id="description">Description</h3>
<p>Used to add, list, or clean the npm cache folder.</p>
<p>Used to add, list, or clean the <code>npm cache</code> folder.
Also used to view info about entries in the <code>npm exec</code> (aka <code>npx</code>) cache folder.</p>
<h4 id="npm-cache"><code>npm cache</code></h4>
<ul>
<li>
<p>add:
Add the specified packages to the local cache. This command is primarily
intended to be used internally by npm, but it can provide a way to
add data to the local installation cache explicitly.</p>
Add the specified packages to the local cache. This command is primarily intended to be used internally by npm, but it can provide a way to add data to the local installation cache explicitly.</p>
</li>
<li>
<p>clean:
Delete all data out of the cache folder. Note that this is typically
unnecessary, as npm's cache is self-healing and resistant to data
corruption issues.</p>
Delete a single entry or all entries out of the cache folder. Note that this is typically unnecessary, as npm's cache is self-healing and resistant to data corruption issues.</p>
</li>
<li>
<p>ls:
List given entries or all entries in the local cache.</p>
</li>
<li>
<p>verify:
Verify the contents of the cache folder, garbage collecting any unneeded
data, and verifying the integrity of the cache index and all cached data.</p>
Verify the contents of the cache folder, garbage collecting any unneeded data, and verifying the integrity of the cache index and all cached data.</p>
</li>
</ul>
<h4 id="npm-cache-npx"><code>npm cache npx</code></h4>
<ul>
<li>
<p>ls:
List all entries in the npx cache.</p>
</li>
<li>
<p>rm:
Remove given entries or all entries from the npx cache.</p>
</li>
<li>
<p>info:
Get detailed information about given entries in the npx cache.</p>
</li>
</ul>
<h3 id="details">Details</h3>
<p>npm stores cache data in an opaque directory within the configured <code>cache</code>,
named <code>_cacache</code>. This directory is a
<a href="http://npm.im/cacache"><code>cacache</code></a>-based content-addressable cache that
stores all http request data as well as other package-related data. This
directory is primarily accessed through <code>pacote</code>, the library responsible
for all package fetching as of npm@5.</p>
<p>All data that passes through the cache is fully verified for integrity on
both insertion and extraction. Cache corruption will either trigger an
error, or signal to <code>pacote</code> that the data must be refetched, which it will
do automatically. For this reason, it should never be necessary to clear
the cache for any reason other than reclaiming disk space, thus why <code>clean</code>
now requires <code>--force</code> to run.</p>
<p>There is currently no method exposed through npm to inspect or directly
manage the contents of this cache. In order to access it, <code>cacache</code> must be
used directly.</p>
<p>npm will not remove data by itself: the cache will grow as new packages are
installed.</p>
<p>npm stores cache data in an opaque directory within the configured <code>cache</code>, named <code>_cacache</code>. This directory is a <a href="http://npm.im/cacache"><code>cacache</code></a>-based content-addressable cache that stores all http request data as well as other package-related data. This directory is primarily accessed through <code>pacote</code>, the library responsible for all package fetching as of npm@5.</p>
<p>All data that passes through the cache is fully verified for integrity on both insertion and extraction. Cache corruption will either trigger an error, or signal to <code>pacote</code> that the data must be refetched, which it will do automatically. For this reason, it should never be necessary to clear the cache for any reason other than reclaiming disk space, thus why <code>clean</code> now requires <code>--force</code> to run.</p>
<p>There is currently no method exposed through npm to inspect or directly manage the contents of this cache. In order to access it, <code>cacache</code> must be used directly.</p>
<p>npm will not remove data by itself: the cache will grow as new packages are installed.</p>
<h3 id="a-note-about-the-caches-design">A note about the cache's design</h3>
<p>The npm cache is strictly a cache: it should not be relied upon as a
persistent and reliable data store for package data. npm makes no guarantee
that a previously-cached piece of data will be available later, and will
automatically delete corrupted contents. The primary guarantee that the
cache makes is that, if it does return data, that data will be exactly the
data that was inserted.</p>
<p>The npm cache is strictly a cache: it should not be relied upon as a persistent and reliable data store for package data. npm makes no guarantee that a previously-cached piece of data will be available later, and will automatically delete corrupted contents. The primary guarantee that the cache makes is that, if it does return data, that data will be exactly the data that was inserted.</p>
<p>To run an offline verification of existing cache contents, use <code>npm cache verify</code>.</p>
<h3 id="configuration">Configuration</h3>
<h4 id="cache"><code>cache</code></h4>
Expand All @@ -223,6 +224,7 @@ <h3 id="see-also">See Also</h3>
<li><a href="../commands/npm-install.html">npm install</a></li>
<li><a href="../commands/npm-publish.html">npm publish</a></li>
<li><a href="../commands/npm-pack.html">npm pack</a></li>
<li><a href="../commands/npm-exec.html">npm exec</a></li>
<li><a href="https://npm.im/cacache">https://npm.im/cacache</a></li>
<li><a href="https://npm.im/pacote">https://npm.im/pacote</a></li>
<li><a href="https://npm.im/@npmcli/arborist">https://npm.im/@npmcli/arborist</a></li>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-ci.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-ci----1110">
<h1 id="----npm-ci----1120">
<span>npm-ci</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Clean install a project</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-completion.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-completion----1110">
<h1 id="----npm-completion----1120">
<span>npm-completion</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Tab Completion for npm</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-config.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-config----1110">
<h1 id="----npm-config----1120">
<span>npm-config</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Manage the npm configuration files</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-dedupe.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-dedupe----1110">
<h1 id="----npm-dedupe----1120">
<span>npm-dedupe</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Reduce duplication in the package tree</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-deprecate.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-deprecate----1110">
<h1 id="----npm-deprecate----1120">
<span>npm-deprecate</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Deprecate a version of a package</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-diff.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-diff----1110">
<h1 id="----npm-diff----1120">
<span>npm-diff</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">The registry diff command</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-dist-tag.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-dist-tag----1110">
<h1 id="----npm-dist-tag----1120">
<span>npm-dist-tag</span>
<span class="version">@11.1.0</span>
<span class="version">@11.2.0</span>
</h1>
<span class="description">Modify package distribution tags</span>
</header>
Expand Down
Loading
Loading