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: Update npm 9.0.0 pre.4 #44916

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions deps/npm/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
; This file is automatically added by @npmcli/template-oss. Do not edit.

package-lock=true
5 changes: 5 additions & 0 deletions deps/npm/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# docs

[![CI - docs](https://github.com/npm/cli/actions/workflows/ci-docs.yml/badge.svg)](https://github.com/npm/cli/actions/workflows/ci-docs.yml)

Scripts to build the npm docs.
35 changes: 24 additions & 11 deletions deps/npm/docs/content/commands/npm-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,13 @@ description: Set access level on published packages
<!-- see lib/commands/access.js -->

```bash
npm access public [<package>]
npm access restricted [<package>]
npm access list packages [<user>|<scope>|<scope:team> [<package>]
npm access list collaborators [<package> [<user>]]
npm access get status [<package>]
npm access set status=public|private [<package>]
npm access set mfa=none|publish|automation [<package>]
npm access grant <read-only|read-write> <scope:team> [<package>]
npm access revoke <scope:team> [<package>]
npm access 2fa-required [<package>]
npm access 2fa-not-required [<package>]
npm access ls-packages [<user>|<scope>|<scope:team>]
npm access ls-collaborators [<package> [<user>]]
npm access edit [<package>]
```

<!-- automatically generated, do not edit manually -->
Expand Down Expand Up @@ -91,12 +89,17 @@ Management of teams and team memberships is done with the `npm team` command.
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
#### `registry`
#### `json`

* Default: "https://registry.npmjs.org/"
* Type: URL
* Default: false
* Type: Boolean

The base URL of the npm registry.
Whether or not to output JSON data, rather than the normal output.

* 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 -->
Expand All @@ -115,6 +118,16 @@ password, npm will prompt on the command line for one.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->

#### `registry`

* Default: "https://registry.npmjs.org/"
* Type: URL

The base URL of the npm registry.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->

<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->

### See Also
Expand Down
29 changes: 8 additions & 21 deletions deps/npm/docs/content/commands/npm-adduser.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: Add a registry user account
```bash
npm adduser

aliases: login, add-user
alias: add-user
```

<!-- automatically generated, do not edit manually -->
Expand All @@ -25,22 +25,12 @@ Note: This command is unaware of workspaces.

### Description

Create or verify a user named `<username>` in the specified registry, and
save the credentials to the `.npmrc` file. If no registry is specified,
the default registry will be used (see [`config`](/using-npm/config)).
Create a new user in the specified registry, and save the credentials to
the `.npmrc` file. If no registry is specified, the default registry
will be used (see [`registry`](/using-npm/registry)).

The username, password, and email are read in from prompts.

To reset your password, go to <https://www.npmjs.com/forgot>

To change your email address, go to <https://www.npmjs.com/email-edit>

You may use this command multiple times with the same user account to
authorize on a new machine. When authenticating on a new machine,
the username, password and email address must all match with
your existing record.

`npm login` is an alias to `adduser` and behaves exactly the same way.
When using `legacy` for your `auth-type`, the username, password, and
email are read in from prompts.

### Configuration

Expand Down Expand Up @@ -92,11 +82,8 @@ npm init --scope=@foo --yes

#### `auth-type`

* Default: "legacy"
* Type: "legacy", "web", "sso", "saml", "oauth", or "webauthn"

NOTE: auth-type values "sso", "saml", "oauth", and "webauthn" will be
removed in a future version.
* Default: "web"
* Type: "legacy" or "web"

What authentication strategy to use with `login`.

Expand Down
16 changes: 8 additions & 8 deletions deps/npm/docs/content/commands/npm-audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,9 @@ the path `/-/npm/v1/security/advisories/bulk`.

Any packages in the tree that do not have a `version` field in their
package.json file will be ignored. If any `--omit` options are specified
(either via the `--omit` config, or one of the shorthands such as
`--production`, `--only=dev`, and so on), then packages will be omitted
from the submitted payload as appropriate.
(either via the [`--omit` config](/using-npm/config#omit), or one of the
shorthands such as `--production`, `--only=dev`, and so on), then packages will
be omitted from the submitted payload as appropriate.

If the registry responds with an error, or with an invalid response, then
npm will attempt to load advisory data from the `Quick Audit` endpoint.
Expand Down Expand Up @@ -188,7 +188,7 @@ vulnerabilities are found _or_ if the remediation is able to successfully
fix all vulnerabilities.

If vulnerabilities were found the exit code will depend on the
`audit-level` configuration setting.
[`audit-level` config](/using-npm/config#audit-level).

### Examples

Expand Down Expand Up @@ -453,12 +453,12 @@ This value is not exported to the environment for child processes.

#### `install-links`

* Default: false
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
5 changes: 3 additions & 2 deletions deps/npm/docs/content/commands/npm-bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ alias: issues

This command tries to guess at the likely location of a package's bug
tracker URL or the `mailto` URL of the support email, and then tries to
open it using the `--browser` config param. If no package name is provided, it
will search for a `package.json` in the current folder and use the `name` property.
open it using the [`--browser` config](/using-npm/config#browser) param. If no
package name is provided, it will search for a `package.json` in the current
folder and use the `name` property.

### Configuration

Expand Down
3 changes: 1 addition & 2 deletions deps/npm/docs/content/commands/npm-cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,7 @@ verify`.
* Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm`
* Type: Path

The location of npm's cache directory. See [`npm
cache`](/commands/npm-cache)
The location of npm's cache directory.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
8 changes: 4 additions & 4 deletions deps/npm/docs/content/commands/npm-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,12 +361,12 @@ This value is not exported to the environment for child processes.

#### `install-links`

* Default: false
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
2 changes: 1 addition & 1 deletion deps/npm/docs/content/commands/npm-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ variables, `npmrc` files, and in some cases, the `package.json` file.
See [npmrc](/configuring-npm/npmrc) for more information about the npmrc
files.

See [config(7)](/using-npm/config) for a more thorough explanation of the
See [config](/using-npm/config) for a more thorough explanation of the
mechanisms involved, and a full list of config options available.

The `npm config` command can be used to update and edit the contents
Expand Down
8 changes: 4 additions & 4 deletions deps/npm/docs/content/commands/npm-dedupe.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,12 +308,12 @@ This value is not exported to the environment for child processes.

#### `install-links`

* Default: false
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/content/commands/npm-dist-tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ alias: dist-tags
Add, remove, and enumerate distribution tags on a package:

* add: Tags the specified version of the package with the specified tag,
or the `--tag` config if not specified. If you have two-factor
authentication on auth-and-writes then you’ll need to include a
or the [`--tag` config](/using-npm/config#tag) if not specified. If you have
two-factor authentication on auth-and-writes then you’ll need to include a
one-time password on the command line with
`--otp <one-time password>`, or at the OTP prompt.

Expand Down
8 changes: 4 additions & 4 deletions deps/npm/docs/content/commands/npm-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ alias: home
### Description

This command tries to guess at the likely location of a package's
documentation URL, and then tries to open it using the `--browser` config
param. You can pass multiple package names at once. If no package name is
provided, it will search for a `package.json` in the current folder and use
the `name` property.
documentation URL, and then tries to open it using the
[`--browser` config](/using-npm/config#browser) param. You can pass multiple
package names at once. If no package name is provided, it will search for a
`package.json` in the current folder and use the `name` property.

### Configuration

Expand Down
9 changes: 5 additions & 4 deletions deps/npm/docs/content/commands/npm-exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,8 @@ $ npx -c 'eslint && say "hooray, lint passed"'

### Workspaces support

You may use the `workspace` or `workspaces` configs in order to run an
You may use the [`workspace`](/using-npm/config#workspace) or
[`workspaces`](/using-npm/config#workspaces) configs in order to run an
arbitrary command from an npm package (either one installed locally, or fetched
remotely) in the context of the specified workspaces.
If no positional argument or `--call` option is provided, it will open an
Expand Down Expand Up @@ -271,9 +272,9 @@ Assuming the workspace configuration is properly set up at the root level
```

You can execute an arbitrary command from a package in the context of each of
the configured workspaces when using the `workspaces` configuration options,
in this example we're using **eslint** to lint any js file found within each
workspace folder:
the configured workspaces when using the
[`workspaces` config options](/using-npm/config#workspace), in this example
we're using **eslint** to lint any js file found within each workspace folder:

```
npm exec --ws -- eslint ./*.js
Expand Down
8 changes: 4 additions & 4 deletions deps/npm/docs/content/commands/npm-find-dupes.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,12 +232,12 @@ This value is not exported to the environment for child processes.

#### `install-links`

* Default: false
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
10 changes: 6 additions & 4 deletions deps/npm/docs/content/commands/npm-fund.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@ 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 `--browser` config
param; if there are multiple funding sources for the package, the user
will be instructed to pass the `--which` option to disambiguate.
then it tries to open its funding url using the
[`--browser` config](/using-npm/config#browser) 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
Expand All @@ -38,7 +39,8 @@ same shape of the output from `npm ls`.
### Workspaces support

It's possible to filter the results to only include a single workspace
and its dependencies using the `workspace` config option.
and its dependencies using the
[`workspace` config](/using-npm/config#workspace) option.

#### Example:

Expand Down
8 changes: 4 additions & 4 deletions deps/npm/docs/content/commands/npm-install-ci-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,12 +307,12 @@ This value is not exported to the environment for child processes.

#### `install-links`

* Default: false
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
8 changes: 4 additions & 4 deletions deps/npm/docs/content/commands/npm-install-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,12 +308,12 @@ This value is not exported to the environment for child processes.

#### `install-links`

* Default: false
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
10 changes: 5 additions & 5 deletions deps/npm/docs/content/commands/npm-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ into a tarball (b).
* `npm install [<@scope>/]<name>`:

Do a `<name>@<tag>` install, where `<tag>` is the "tag" config. (See
[`config`](/using-npm/config). The config's default value is `latest`.)
[`config`](/using-npm/config#tag). The config's default value is `latest`.)

In most cases, this will install the version of the modules tagged as
`latest` on the npm registry.
Expand Down Expand Up @@ -698,12 +698,12 @@ This value is not exported to the environment for child processes.

#### `install-links`

* Default: false
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
8 changes: 4 additions & 4 deletions deps/npm/docs/content/commands/npm-link.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,12 +384,12 @@ This value is not exported to the environment for child processes.

#### `install-links`

* Default: false
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down