deps: upgrade npm to 8.19.3
PR-URL: https://github.com/nodejs/node/pull/45322 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit is contained in:
npm CLI robot
GitHub
parent
06603c44a5
commit
14a9f77c7c
20
deps/npm/docs/content/commands/npm-access.md
vendored
20
deps/npm/docs/content/commands/npm-access.md
vendored
@ -6,10 +6,6 @@ description: Set access level on published packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/access.js -->
|
||||
|
||||
```bash
|
||||
npm access public [<package>]
|
||||
npm access restricted [<package>]
|
||||
@ -22,11 +18,6 @@ npm access ls-collaborators [<package> [<user>]]
|
||||
npm access edit [<package>]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/access.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
Used to set access controls on private packages.
|
||||
@ -88,9 +79,6 @@ Management of teams and team memberships is done with the `npm team` command.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -98,9 +86,6 @@ Management of teams and team memberships is done with the `npm team` command.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -112,11 +97,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [`libnpmaccess`](https://npm.im/libnpmaccess)
|
||||
|
||||
23
deps/npm/docs/content/commands/npm-adduser.md
vendored
23
deps/npm/docs/content/commands/npm-adduser.md
vendored
@ -6,21 +6,12 @@ description: Add a registry user account
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/adduser.js -->
|
||||
|
||||
```bash
|
||||
npm adduser
|
||||
|
||||
aliases: login, add-user
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/adduser.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -44,9 +35,6 @@ your existing record.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -54,9 +42,6 @@ your existing record.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `scope`
|
||||
|
||||
* Default: the scope of the current project, if any, or ""
|
||||
@ -87,9 +72,6 @@ npm init --scope=@foo --yes
|
||||
```
|
||||
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `auth-type`
|
||||
|
||||
* Default: "legacy"
|
||||
@ -100,11 +82,6 @@ removed in a future version.
|
||||
|
||||
What authentication strategy to use with `login`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm registry](/using-npm/registry)
|
||||
|
||||
50
deps/npm/docs/content/commands/npm-audit.md
vendored
50
deps/npm/docs/content/commands/npm-audit.md
vendored
@ -6,19 +6,10 @@ description: Run a security audit
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/audit.js -->
|
||||
|
||||
```bash
|
||||
npm audit [fix|signatures]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/audit.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
The audit command submits a description of the dependencies configured in
|
||||
@ -247,9 +238,6 @@ $ npm audit --audit-level=moderate
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `audit-level`
|
||||
|
||||
* Default: null
|
||||
@ -258,9 +246,6 @@ $ npm audit --audit-level=moderate
|
||||
The minimum level of vulnerability for `npm audit` to exit with a non-zero
|
||||
exit code.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -274,9 +259,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `force`
|
||||
|
||||
* Default: false
|
||||
@ -303,9 +285,6 @@ mistakes, unnecessary performance degradation, and malicious input.
|
||||
If you don't have a clear idea of what you want to do, it is strongly
|
||||
recommended that you do not use this option!
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -318,9 +297,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock-only`
|
||||
|
||||
* Default: false
|
||||
@ -335,9 +311,6 @@ instead of checking `node_modules` and downloading dependencies.
|
||||
For `list` this means the output will be based on the tree described by the
|
||||
`package-lock.json`, rather than the contents of `node_modules`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -356,9 +329,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `foreground-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -371,9 +341,6 @@ input, output, and error with the main npm process.
|
||||
Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -386,9 +353,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -411,9 +375,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -432,9 +393,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -448,9 +406,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -460,11 +415,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/commands/npm-install)
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-bin.md
vendored
17
deps/npm/docs/content/commands/npm-bin.md
vendored
@ -6,19 +6,10 @@ description: Display npm bin folder
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/bin.js -->
|
||||
|
||||
```bash
|
||||
npm bin
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/bin.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -27,9 +18,6 @@ Print the folder where npm will install executables.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -44,11 +32,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm prefix](/commands/npm-prefix)
|
||||
|
||||
29
deps/npm/docs/content/commands/npm-bugs.md
vendored
29
deps/npm/docs/content/commands/npm-bugs.md
vendored
@ -6,21 +6,12 @@ description: Report bugs for a package in a web browser
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/bugs.js -->
|
||||
|
||||
```bash
|
||||
npm bugs [<pkgname> [<pkgname> ...]]
|
||||
|
||||
alias: issues
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/bugs.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command tries to guess at the likely location of a package's bug
|
||||
@ -30,9 +21,6 @@ will search for a `package.json` in the current folder and use the `name` proper
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `browser`
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
@ -45,9 +33,6 @@ terminal.
|
||||
|
||||
Set to `true` to use default system URL opener.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -55,9 +40,6 @@ Set to `true` to use default system URL opener.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -80,9 +62,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -101,9 +80,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -117,11 +93,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm docs](/commands/npm-docs)
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-cache.md
vendored
17
deps/npm/docs/content/commands/npm-cache.md
vendored
@ -6,10 +6,6 @@ description: Manipulates packages cache
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/cache.js -->
|
||||
|
||||
```bash
|
||||
npm cache add <package-spec>
|
||||
npm cache clean [<key>]
|
||||
@ -17,11 +13,6 @@ npm cache ls [<name>@<version>]
|
||||
npm cache verify
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/cache.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -79,9 +70,6 @@ verify`.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `cache`
|
||||
|
||||
* Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm`
|
||||
@ -90,11 +78,6 @@ verify`.
|
||||
The location of npm's cache directory. See [`npm
|
||||
cache`](/commands/npm-cache)
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
68
deps/npm/docs/content/commands/npm-ci.md
vendored
68
deps/npm/docs/content/commands/npm-ci.md
vendored
@ -6,21 +6,12 @@ description: Clean install a project
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/ci.js -->
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
|
||||
aliases: clean-install, ic, install-clean, isntall-clean
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/ci.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command is similar to [`npm install`](/commands/npm-install), except
|
||||
@ -81,9 +72,6 @@ cache:
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `save`
|
||||
|
||||
* Default: `true` unless when using `npm update` where it defaults to `false`
|
||||
@ -96,9 +84,6 @@ When used with the `npm rm` command, removes the dependency from
|
||||
|
||||
Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `save-exact`
|
||||
|
||||
* Default: false
|
||||
@ -107,9 +92,6 @@ Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -124,9 +106,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
@ -139,9 +118,6 @@ on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
@ -152,9 +128,6 @@ such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -173,9 +146,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
@ -195,9 +165,6 @@ When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
@ -208,9 +175,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
This configuration does not affect `npm ci`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `foreground-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -223,9 +187,6 @@ input, output, and error with the main npm process.
|
||||
Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -238,9 +199,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
@ -251,9 +209,6 @@ default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
@ -266,9 +221,6 @@ Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
@ -278,9 +230,6 @@ When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -294,9 +243,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -319,9 +265,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -340,9 +283,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -356,9 +296,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -368,11 +305,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/commands/npm-install)
|
||||
|
||||
@ -6,19 +6,10 @@ description: Tab Completion for npm
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/completion.js -->
|
||||
|
||||
```bash
|
||||
npm completion
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/completion.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
29
deps/npm/docs/content/commands/npm-config.md
vendored
29
deps/npm/docs/content/commands/npm-config.md
vendored
@ -6,10 +6,6 @@ description: Manage the npm configuration files
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/config.js -->
|
||||
|
||||
```bash
|
||||
npm config set <key>=<value> [<key>=<value> ...]
|
||||
npm config get [<key> [<key> ...]]
|
||||
@ -20,11 +16,6 @@ npm config edit
|
||||
alias: c
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/config.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -102,9 +93,6 @@ global config.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -117,9 +105,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -134,9 +119,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `editor`
|
||||
|
||||
* Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on
|
||||
@ -145,9 +127,6 @@ folder instead of the current working directory. See
|
||||
|
||||
The command to run for `npm edit` and `npm config edit`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `location`
|
||||
|
||||
* Default: "user" unless `--global` is passed, which will also set this value
|
||||
@ -165,9 +144,6 @@ instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `long`
|
||||
|
||||
* Default: false
|
||||
@ -175,11 +151,6 @@ instead of the current working directory. See
|
||||
|
||||
Show extended information in `ls`, `search`, and `help-search`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
|
||||
56
deps/npm/docs/content/commands/npm-dedupe.md
vendored
56
deps/npm/docs/content/commands/npm-dedupe.md
vendored
@ -6,21 +6,12 @@ description: Reduce duplication in the package tree
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/dedupe.js -->
|
||||
|
||||
```bash
|
||||
npm dedupe
|
||||
|
||||
alias: ddp
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/dedupe.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
Searches the local package tree and attempts to simplify the overall
|
||||
@ -86,9 +77,6 @@ values in `package.json` you can run: `npm update --save` instead.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
@ -101,9 +89,6 @@ on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
@ -114,9 +99,6 @@ such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
@ -136,9 +118,6 @@ When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
@ -149,9 +128,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
This configuration does not affect `npm ci`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -170,9 +146,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -185,9 +158,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
@ -198,9 +168,6 @@ default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
@ -213,9 +180,6 @@ Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
@ -225,9 +189,6 @@ When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -241,9 +202,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -266,9 +224,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -287,9 +242,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -303,9 +255,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -315,11 +264,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm find-dupes](/commands/npm-find-dupes)
|
||||
|
||||
20
deps/npm/docs/content/commands/npm-deprecate.md
vendored
20
deps/npm/docs/content/commands/npm-deprecate.md
vendored
@ -6,19 +6,10 @@ description: Deprecate a version of a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/deprecate.js -->
|
||||
|
||||
```bash
|
||||
npm deprecate <package-spec> <message>
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/deprecate.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -51,9 +42,6 @@ format an empty string.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -61,9 +49,6 @@ format an empty string.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -75,11 +60,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
53
deps/npm/docs/content/commands/npm-diff.md
vendored
53
deps/npm/docs/content/commands/npm-diff.md
vendored
@ -6,19 +6,10 @@ description: The registry diff command
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/diff.js -->
|
||||
|
||||
```bash
|
||||
npm diff [...<paths>]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/diff.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
Similar to its `git diff` counterpart, this command will print diff patches
|
||||
@ -158,9 +149,6 @@ located within the folder `./lib/` and changed lines of code within the
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `diff`
|
||||
|
||||
* Default:
|
||||
@ -168,9 +156,6 @@ located within the folder `./lib/` and changed lines of code within the
|
||||
|
||||
Define arguments to compare in `npm diff`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-name-only`
|
||||
|
||||
* Default: false
|
||||
@ -178,9 +163,6 @@ Define arguments to compare in `npm diff`.
|
||||
|
||||
Prints only filenames when using `npm diff`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-unified`
|
||||
|
||||
* Default: 3
|
||||
@ -188,9 +170,6 @@ Prints only filenames when using `npm diff`.
|
||||
|
||||
The number of lines of context to print in `npm diff`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-ignore-all-space`
|
||||
|
||||
* Default: false
|
||||
@ -198,9 +177,6 @@ The number of lines of context to print in `npm diff`.
|
||||
|
||||
Ignore whitespace when comparing lines in `npm diff`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-no-prefix`
|
||||
|
||||
* Default: false
|
||||
@ -211,9 +187,6 @@ Do not show any source or destination prefix in `npm diff` output.
|
||||
Note: this causes `npm diff` to ignore the `--diff-src-prefix` and
|
||||
`--diff-dst-prefix` configs.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-src-prefix`
|
||||
|
||||
* Default: "a/"
|
||||
@ -221,9 +194,6 @@ Note: this causes `npm diff` to ignore the `--diff-src-prefix` and
|
||||
|
||||
Source prefix to be used in `npm diff` output.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-dst-prefix`
|
||||
|
||||
* Default: "b/"
|
||||
@ -231,9 +201,6 @@ Source prefix to be used in `npm diff` output.
|
||||
|
||||
Destination prefix to be used in `npm diff` output.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-text`
|
||||
|
||||
* Default: false
|
||||
@ -241,9 +208,6 @@ Destination prefix to be used in `npm diff` output.
|
||||
|
||||
Treat all files as text in `npm diff`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -258,9 +222,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `tag`
|
||||
|
||||
* Default: "latest"
|
||||
@ -275,9 +236,6 @@ command, if no explicit tag is given.
|
||||
When used by the `npm diff` command, this is the tag used to fetch the
|
||||
tarball that will be compared with the local files by default.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -300,9 +258,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -321,9 +276,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -336,11 +288,6 @@ all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
## See Also
|
||||
|
||||
* [npm outdated](/commands/npm-outdated)
|
||||
|
||||
23
deps/npm/docs/content/commands/npm-dist-tag.md
vendored
23
deps/npm/docs/content/commands/npm-dist-tag.md
vendored
@ -6,10 +6,6 @@ description: Modify package distribution tags
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/dist-tag.js -->
|
||||
|
||||
```bash
|
||||
npm dist-tag add <package-spec (with version)> [<tag>]
|
||||
npm dist-tag rm <package-spec> <tag>
|
||||
@ -18,11 +14,6 @@ npm dist-tag ls [<package-spec>]
|
||||
alias: dist-tags
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/dist-tag.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
Add, remove, and enumerate distribution tags on a package:
|
||||
@ -99,9 +90,6 @@ not begin with a number or the letter `v`.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -124,9 +112,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -145,9 +130,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -161,11 +143,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
29
deps/npm/docs/content/commands/npm-docs.md
vendored
29
deps/npm/docs/content/commands/npm-docs.md
vendored
@ -6,21 +6,12 @@ description: Open documentation for a package in a web browser
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/docs.js -->
|
||||
|
||||
```bash
|
||||
npm docs [<pkgname> [<pkgname> ...]]
|
||||
|
||||
alias: home
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/docs.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command tries to guess at the likely location of a package's
|
||||
@ -31,9 +22,6 @@ the `name` property.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `browser`
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
@ -46,9 +34,6 @@ terminal.
|
||||
|
||||
Set to `true` to use default system URL opener.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -56,9 +41,6 @@ Set to `true` to use default system URL opener.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -81,9 +63,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -102,9 +81,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -118,11 +94,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm view](/commands/npm-view)
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-doctor.md
vendored
17
deps/npm/docs/content/commands/npm-doctor.md
vendored
@ -6,19 +6,10 @@ description: Check your npm environment
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/doctor.js -->
|
||||
|
||||
```bash
|
||||
npm doctor
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/doctor.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -113,9 +104,6 @@ reset the cache.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -123,11 +111,6 @@ reset the cache.
|
||||
|
||||
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
|
||||
|
||||
* [npm bugs](/commands/npm-bugs)
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-edit.md
vendored
17
deps/npm/docs/content/commands/npm-edit.md
vendored
@ -6,19 +6,10 @@ description: Edit an installed package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/edit.js -->
|
||||
|
||||
```bash
|
||||
npm edit <pkg>[/<subpkg>...]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/edit.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -36,9 +27,6 @@ changes to your locally installed copy.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `editor`
|
||||
|
||||
* Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on
|
||||
@ -47,11 +35,6 @@ changes to your locally installed copy.
|
||||
|
||||
The command to run for `npm edit` and `npm config edit`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
|
||||
29
deps/npm/docs/content/commands/npm-exec.md
vendored
29
deps/npm/docs/content/commands/npm-exec.md
vendored
@ -6,10 +6,6 @@ description: Run a command from a local or remote npm package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/exec.js -->
|
||||
|
||||
```bash
|
||||
npm exec -- <pkg>[@<version>] [args...]
|
||||
npm exec --package=<pkg>[@<version>] -- <cmd> [args...]
|
||||
@ -19,11 +15,6 @@ npm exec --package=foo -c '<cmd> [args...]'
|
||||
alias: x
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/exec.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command allows you to run an arbitrary command from an npm package
|
||||
@ -119,9 +110,6 @@ $ npm exec -- foo@latest bar --package=@npmcli/foo
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `package`
|
||||
|
||||
* Default:
|
||||
@ -129,9 +117,6 @@ $ npm exec -- foo@latest bar --package=@npmcli/foo
|
||||
|
||||
The package or packages to install for [`npm exec`](/commands/npm-exec)
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `call`
|
||||
|
||||
* Default: ""
|
||||
@ -145,9 +130,6 @@ npm exec --package yo --package generator-node --call "yo node"
|
||||
```
|
||||
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -170,9 +152,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -191,9 +170,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -207,11 +183,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### Examples
|
||||
|
||||
Run the version of `tap` in the local dependencies, with the provided
|
||||
|
||||
20
deps/npm/docs/content/commands/npm-explain.md
vendored
20
deps/npm/docs/content/commands/npm-explain.md
vendored
@ -6,21 +6,12 @@ description: Explain installed packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/explain.js -->
|
||||
|
||||
```bash
|
||||
npm explain <package-spec>
|
||||
|
||||
alias: why
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/explain.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command will print the chain of dependencies causing a given package
|
||||
@ -64,9 +55,6 @@ node_modules/nyc/node_modules/find-up
|
||||
```
|
||||
|
||||
### Configuration
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -79,9 +67,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -104,11 +89,6 @@ 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 -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-explore.md
vendored
17
deps/npm/docs/content/commands/npm-explore.md
vendored
@ -6,19 +6,10 @@ description: Browse an installed package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/explore.js -->
|
||||
|
||||
```bash
|
||||
npm explore <pkg> [ -- <command>]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/explore.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -40,9 +31,6 @@ sure to use `npm rebuild <pkg>` if you make any changes.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `shell`
|
||||
|
||||
* Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on
|
||||
@ -51,11 +39,6 @@ sure to use `npm rebuild <pkg>` if you make any changes.
|
||||
|
||||
The shell to run for the `npm explore` command.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
|
||||
53
deps/npm/docs/content/commands/npm-find-dupes.md
vendored
53
deps/npm/docs/content/commands/npm-find-dupes.md
vendored
@ -6,19 +6,10 @@ description: Find duplication in the package tree
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/find-dupes.js -->
|
||||
|
||||
```bash
|
||||
npm find-dupes
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/find-dupes.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
Runs `npm dedupe` in `--dry-run` mode, making npm only output the
|
||||
@ -26,9 +17,6 @@ duplications, without actually changing the package tree.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
@ -41,9 +29,6 @@ on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
@ -54,9 +39,6 @@ such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
@ -76,9 +58,6 @@ When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
@ -89,9 +68,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
This configuration does not affect `npm ci`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -110,9 +86,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -125,9 +98,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
@ -138,9 +108,6 @@ default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
@ -153,9 +120,6 @@ Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
@ -165,9 +129,6 @@ When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -190,9 +151,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -211,9 +169,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -227,9 +182,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -239,11 +191,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm dedupe](/commands/npm-dedupe)
|
||||
|
||||
29
deps/npm/docs/content/commands/npm-fund.md
vendored
29
deps/npm/docs/content/commands/npm-fund.md
vendored
@ -6,19 +6,10 @@ description: Retrieve funding information
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/fund.js -->
|
||||
|
||||
```bash
|
||||
npm fund [<package-spec>]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/fund.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command retrieves information on how to fund the dependencies of a
|
||||
@ -72,9 +63,6 @@ test-workspaces-fund@1.0.0
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -87,9 +75,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `browser`
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
@ -102,9 +87,6 @@ terminal.
|
||||
|
||||
Set to `true` to use default system URL opener.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `unicode`
|
||||
|
||||
* Default: false on windows, true on mac/unix systems with a unicode locale,
|
||||
@ -114,9 +96,6 @@ Set to `true` to use default system URL opener.
|
||||
When set to true, npm uses unicode characters in the tree output. When
|
||||
false, it uses ascii characters instead of unicode glyphs.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -139,9 +118,6 @@ 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`
|
||||
|
||||
* Default: null
|
||||
@ -149,11 +125,6 @@ This value is not exported to the environment for child processes.
|
||||
|
||||
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
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
@ -6,19 +6,10 @@ description: Search npm help documentation
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/help-search.js -->
|
||||
|
||||
```bash
|
||||
npm help-search <text>
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/help-search.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -34,9 +25,6 @@ directly.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `long`
|
||||
|
||||
* Default: false
|
||||
@ -44,11 +32,6 @@ directly.
|
||||
|
||||
Show extended information in `ls`, `search`, and `help-search`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm](/commands/npm)
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-help.md
vendored
17
deps/npm/docs/content/commands/npm-help.md
vendored
@ -6,21 +6,12 @@ description: Get help on npm
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/help.js -->
|
||||
|
||||
```bash
|
||||
npm help <term> [<terms..>]
|
||||
|
||||
alias: hlep
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/help.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -34,9 +25,6 @@ topic, so unique matches are equivalent to specifying a topic name.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `viewer`
|
||||
|
||||
* Default: "man" on Posix, "browser" on Windows
|
||||
@ -46,11 +34,6 @@ The program to use to view help content.
|
||||
|
||||
Set to `"browser"` to view html help content in the default web browser.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm](/commands/npm)
|
||||
|
||||
20
deps/npm/docs/content/commands/npm-hook.md
vendored
20
deps/npm/docs/content/commands/npm-hook.md
vendored
@ -6,10 +6,6 @@ description: Manage registry hooks
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/hook.js -->
|
||||
|
||||
```bash
|
||||
npm hook add <pkg> <url> <secret> [--type=<type>]
|
||||
npm hook ls [pkg]
|
||||
@ -17,11 +13,6 @@ npm hook rm <id>
|
||||
npm hook update <id> <url> <secret>
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/hook.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -94,9 +85,6 @@ $ npm hook rm id-deadbeef
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -104,9 +92,6 @@ $ npm hook rm id-deadbeef
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -118,11 +103,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* ["Introducing Hooks" blog post](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm)
|
||||
|
||||
35
deps/npm/docs/content/commands/npm-init.md
vendored
35
deps/npm/docs/content/commands/npm-init.md
vendored
@ -6,10 +6,6 @@ description: Create a package.json file
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/init.js -->
|
||||
|
||||
```bash
|
||||
npm init <package-spec> (same as `npx <package-spec>)
|
||||
npm init <@scope> (same as `npx <@scope>/create`)
|
||||
@ -17,11 +13,6 @@ npm init <@scope> (same as `npx <@scope>/create`)
|
||||
aliases: create, innit
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/init.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
`npm init <initializer>` can be used to set up a new or existing npm
|
||||
@ -165,9 +156,6 @@ dot to represent the current directory in that context, e.g: `react-app .`:
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `yes`
|
||||
|
||||
* Default: null
|
||||
@ -176,9 +164,6 @@ dot to represent the current directory in that context, e.g: `react-app .`:
|
||||
Automatically answer "yes" to any prompts that npm might print on the
|
||||
command line.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `force`
|
||||
|
||||
* Default: false
|
||||
@ -205,9 +190,6 @@ mistakes, unnecessary performance degradation, and malicious input.
|
||||
If you don't have a clear idea of what you want to do, it is strongly
|
||||
recommended that you do not use this option!
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `scope`
|
||||
|
||||
* Default: the scope of the current project, if any, or ""
|
||||
@ -238,9 +220,6 @@ npm init --scope=@foo --yes
|
||||
```
|
||||
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -263,9 +242,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -284,9 +260,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces-update`
|
||||
|
||||
* Default: true
|
||||
@ -295,9 +268,6 @@ This value is not exported to the environment for child processes.
|
||||
If set to true, the npm cli will run an update after operations that may
|
||||
possibly change the workspaces installed to the `node_modules` folder.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -311,11 +281,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
@ -6,30 +6,18 @@ description: Install a project with a clean slate and run tests
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/install-ci-test.js -->
|
||||
|
||||
```bash
|
||||
npm install-ci-test
|
||||
|
||||
alias: cit
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/install-ci-test.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command runs `npm ci` followed immediately by `npm test`.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `save`
|
||||
|
||||
* Default: `true` unless when using `npm update` where it defaults to `false`
|
||||
@ -42,9 +30,6 @@ When used with the `npm rm` command, removes the dependency from
|
||||
|
||||
Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `save-exact`
|
||||
|
||||
* Default: false
|
||||
@ -53,9 +38,6 @@ Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -70,9 +52,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
@ -85,9 +64,6 @@ on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
@ -98,9 +74,6 @@ such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -119,9 +92,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
@ -141,9 +111,6 @@ When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
@ -154,9 +121,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
This configuration does not affect `npm ci`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `foreground-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -169,9 +133,6 @@ input, output, and error with the main npm process.
|
||||
Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -184,9 +145,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
@ -197,9 +155,6 @@ default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
@ -212,9 +167,6 @@ Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
@ -224,9 +176,6 @@ When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -240,9 +189,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -265,9 +211,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -286,9 +229,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -302,9 +242,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -314,11 +251,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install-test](/commands/npm-install-test)
|
||||
|
||||
@ -6,21 +6,12 @@ description: Install package(s) and run tests
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/install-test.js -->
|
||||
|
||||
```bash
|
||||
npm install-test [<package-spec> ...]
|
||||
|
||||
alias: it
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/install-test.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command runs an `npm install` followed immediately by an `npm test`. It
|
||||
@ -28,9 +19,6 @@ takes exactly the same arguments as `npm install`.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `save`
|
||||
|
||||
* Default: `true` unless when using `npm update` where it defaults to `false`
|
||||
@ -43,9 +31,6 @@ When used with the `npm rm` command, removes the dependency from
|
||||
|
||||
Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `save-exact`
|
||||
|
||||
* Default: false
|
||||
@ -54,9 +39,6 @@ Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -71,9 +53,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
@ -86,9 +65,6 @@ on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
@ -99,9 +75,6 @@ such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -120,9 +93,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
@ -142,9 +112,6 @@ When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
@ -155,9 +122,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
This configuration does not affect `npm ci`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `foreground-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -170,9 +134,6 @@ input, output, and error with the main npm process.
|
||||
Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -185,9 +146,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
@ -198,9 +156,6 @@ default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
@ -213,9 +168,6 @@ Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
@ -225,9 +177,6 @@ When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -241,9 +190,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -266,9 +212,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -287,9 +230,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -303,9 +243,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -315,11 +252,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/commands/npm-install)
|
||||
|
||||
68
deps/npm/docs/content/commands/npm-install.md
vendored
68
deps/npm/docs/content/commands/npm-install.md
vendored
@ -6,21 +6,12 @@ description: Install a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/install.js -->
|
||||
|
||||
```bash
|
||||
npm install [<package-spec> ...]
|
||||
|
||||
aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/install.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command installs a package and any packages that it depends on. If the
|
||||
@ -418,9 +409,6 @@ does.
|
||||
|
||||
These are some of the most common options related to installation.
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `save`
|
||||
|
||||
* Default: `true` unless when using `npm update` where it defaults to `false`
|
||||
@ -433,9 +421,6 @@ When used with the `npm rm` command, removes the dependency from
|
||||
|
||||
Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `save-exact`
|
||||
|
||||
* Default: false
|
||||
@ -444,9 +429,6 @@ Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -461,9 +443,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
@ -476,9 +455,6 @@ on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
@ -489,9 +465,6 @@ such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -510,9 +483,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
@ -532,9 +502,6 @@ When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
@ -545,9 +512,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
This configuration does not affect `npm ci`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `foreground-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -560,9 +524,6 @@ input, output, and error with the main npm process.
|
||||
Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -575,9 +536,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
@ -588,9 +546,6 @@ default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
@ -603,9 +558,6 @@ Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
@ -615,9 +567,6 @@ When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -631,9 +580,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -656,9 +602,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -677,9 +620,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -693,9 +633,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -705,11 +642,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### Algorithm
|
||||
|
||||
Given a `package{dep}` structure: `A{B,C}, B{C}, C{D}`,
|
||||
|
||||
65
deps/npm/docs/content/commands/npm-link.md
vendored
65
deps/npm/docs/content/commands/npm-link.md
vendored
@ -6,21 +6,12 @@ description: Symlink a package folder
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/link.js -->
|
||||
|
||||
```bash
|
||||
npm link [<package-spec>]
|
||||
|
||||
alias: ln
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/link.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This is handy for installing your own stuff, so that you can work on it and
|
||||
@ -119,9 +110,6 @@ workspace(s).
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `save`
|
||||
|
||||
* Default: `true` unless when using `npm update` where it defaults to `false`
|
||||
@ -134,9 +122,6 @@ When used with the `npm rm` command, removes the dependency from
|
||||
|
||||
Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `save-exact`
|
||||
|
||||
* Default: false
|
||||
@ -145,9 +130,6 @@ Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -162,9 +144,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
@ -177,9 +156,6 @@ on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
@ -190,9 +166,6 @@ such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
@ -212,9 +185,6 @@ When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
@ -225,9 +195,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
This configuration does not affect `npm ci`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -246,9 +213,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -261,9 +225,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
@ -274,9 +235,6 @@ default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
@ -289,9 +247,6 @@ Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
@ -301,9 +256,6 @@ When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -317,9 +269,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -342,9 +291,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -363,9 +309,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -379,9 +322,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -391,11 +331,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
20
deps/npm/docs/content/commands/npm-logout.md
vendored
20
deps/npm/docs/content/commands/npm-logout.md
vendored
@ -6,19 +6,10 @@ description: Log out of the registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/logout.js -->
|
||||
|
||||
```bash
|
||||
npm logout
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/logout.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -36,9 +27,6 @@ connected to that scope, if set.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -46,9 +34,6 @@ connected to that scope, if set.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `scope`
|
||||
|
||||
* Default: the scope of the current project, if any, or ""
|
||||
@ -79,11 +64,6 @@ npm init --scope=@foo --yes
|
||||
```
|
||||
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm adduser](/commands/npm-adduser)
|
||||
|
||||
58
deps/npm/docs/content/commands/npm-ls.md
vendored
58
deps/npm/docs/content/commands/npm-ls.md
vendored
@ -6,21 +6,12 @@ description: List installed packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/ls.js -->
|
||||
|
||||
```bash
|
||||
npm ls <package-spec>
|
||||
|
||||
alias: list
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/ls.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command will print to stdout all the versions of packages that are
|
||||
@ -36,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@@VERSION@ /path/to/npm
|
||||
npm@8.19.3 /path/to/npm
|
||||
└─┬ init-package-json@0.0.4
|
||||
└── promzard@0.1.5
|
||||
```
|
||||
@ -82,9 +73,6 @@ least the default human-readable `npm ls` output in npm v8.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `all`
|
||||
|
||||
* Default: false
|
||||
@ -94,9 +82,6 @@ When running `npm outdated` and `npm ls`, setting `--all` will show all
|
||||
outdated or installed packages, rather than only those directly depended
|
||||
upon by the current project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -109,9 +94,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `long`
|
||||
|
||||
* Default: false
|
||||
@ -119,9 +101,6 @@ Not supported by all npm commands.
|
||||
|
||||
Show extended information in `ls`, `search`, and `help-search`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `parseable`
|
||||
|
||||
* Default: false
|
||||
@ -130,9 +109,6 @@ Show extended information in `ls`, `search`, and `help-search`.
|
||||
Output parseable results from commands that write to standard output. For
|
||||
`npm search`, this will be tab-separated table format.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -147,9 +123,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `depth`
|
||||
|
||||
* Default: `Infinity` if `--all` is set, otherwise `1`
|
||||
@ -160,9 +133,6 @@ The depth to go when recursing packages for `npm ls`.
|
||||
If not set, `npm ls` will show only the immediate dependencies of the root
|
||||
project. If `--all` is set, then npm will show all dependencies by default.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -181,9 +151,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `link`
|
||||
|
||||
* Default: false
|
||||
@ -191,9 +158,6 @@ variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
Used with `npm ls`, limiting output to only those packages that are linked.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock-only`
|
||||
|
||||
* Default: false
|
||||
@ -208,9 +172,6 @@ instead of checking `node_modules` and downloading dependencies.
|
||||
For `list` this means the output will be based on the tree described by the
|
||||
`package-lock.json`, rather than the contents of `node_modules`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `unicode`
|
||||
|
||||
* Default: false on windows, true on mac/unix systems with a unicode locale,
|
||||
@ -220,9 +181,6 @@ For `list` this means the output will be based on the tree described by the
|
||||
When set to true, npm uses unicode characters in the tree output. When
|
||||
false, it uses ascii characters instead of unicode glyphs.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -245,9 +203,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -266,9 +221,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -282,9 +234,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -294,11 +243,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
26
deps/npm/docs/content/commands/npm-org.md
vendored
26
deps/npm/docs/content/commands/npm-org.md
vendored
@ -6,10 +6,6 @@ description: Manage orgs
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/org.js -->
|
||||
|
||||
```bash
|
||||
npm org set orgname username [developer | admin | owner]
|
||||
npm org rm orgname username
|
||||
@ -18,11 +14,6 @@ npm org ls orgname [<username>]
|
||||
alias: ogr
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/org.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Example
|
||||
@ -71,9 +62,6 @@ listing them, and finding specific ones and their roles.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -81,9 +69,6 @@ listing them, and finding specific ones and their roles.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -95,9 +80,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -110,9 +92,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `parseable`
|
||||
|
||||
* Default: false
|
||||
@ -121,11 +100,6 @@ Not supported by all npm commands.
|
||||
Output parseable results from commands that write to standard output. For
|
||||
`npm search`, this will be tab-separated table format.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [using orgs](/using-npm/orgs)
|
||||
|
||||
32
deps/npm/docs/content/commands/npm-outdated.md
vendored
32
deps/npm/docs/content/commands/npm-outdated.md
vendored
@ -6,19 +6,10 @@ description: Check for outdated packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/outdated.js -->
|
||||
|
||||
```bash
|
||||
npm outdated [<package-spec> ...]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/outdated.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command will check the registry to see if any (or, specific) installed
|
||||
@ -95,9 +86,6 @@ A few things to note:
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `all`
|
||||
|
||||
* Default: false
|
||||
@ -107,9 +95,6 @@ When running `npm outdated` and `npm ls`, setting `--all` will show all
|
||||
outdated or installed packages, rather than only those directly depended
|
||||
upon by the current project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -122,9 +107,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `long`
|
||||
|
||||
* Default: false
|
||||
@ -132,9 +114,6 @@ Not supported by all npm commands.
|
||||
|
||||
Show extended information in `ls`, `search`, and `help-search`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `parseable`
|
||||
|
||||
* Default: false
|
||||
@ -143,9 +122,6 @@ Show extended information in `ls`, `search`, and `help-search`.
|
||||
Output parseable results from commands that write to standard output. For
|
||||
`npm search`, this will be tab-separated table format.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -160,9 +136,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -185,11 +158,6 @@ 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 -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
26
deps/npm/docs/content/commands/npm-owner.md
vendored
26
deps/npm/docs/content/commands/npm-owner.md
vendored
@ -6,10 +6,6 @@ description: Manage package owners
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/owner.js -->
|
||||
|
||||
```bash
|
||||
npm owner add <user> <package-spec>
|
||||
npm owner rm <user> <package-spec>
|
||||
@ -18,11 +14,6 @@ npm owner ls <package-spec>
|
||||
alias: author
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/owner.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -46,9 +37,6 @@ on the command line when changing ownership with `--otp`.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -56,9 +44,6 @@ on the command line when changing ownership with `--otp`.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -70,9 +55,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -95,9 +77,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -116,11 +95,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
32
deps/npm/docs/content/commands/npm-pack.md
vendored
32
deps/npm/docs/content/commands/npm-pack.md
vendored
@ -6,24 +6,12 @@ description: Create a tarball from a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/pack.js -->
|
||||
|
||||
```bash
|
||||
npm pack <package-spec>
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/pack.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -37,9 +25,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -52,9 +37,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `pack-destination`
|
||||
|
||||
* Default: "."
|
||||
@ -62,9 +44,6 @@ Not supported by all npm commands.
|
||||
|
||||
Directory in which `npm pack` will save tarballs.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -87,9 +66,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -108,9 +84,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -124,11 +97,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
For anything that's installable (that is, a package folder, tarball,
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-ping.md
vendored
17
deps/npm/docs/content/commands/npm-ping.md
vendored
@ -6,19 +6,10 @@ description: Ping npm registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/ping.js -->
|
||||
|
||||
```bash
|
||||
npm ping
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/ping.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -39,9 +30,6 @@ npm ERR! 404 Not Found - GET http://www.foo.com/-/ping?write=true
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -49,11 +37,6 @@ npm ERR! 404 Not Found - GET http://www.foo.com/-/ping?write=true
|
||||
|
||||
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
|
||||
|
||||
* [npm doctor](/commands/npm-doctor)
|
||||
|
||||
26
deps/npm/docs/content/commands/npm-pkg.md
vendored
26
deps/npm/docs/content/commands/npm-pkg.md
vendored
@ -6,10 +6,6 @@ description: Manages your package.json
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/pkg.js -->
|
||||
|
||||
```bash
|
||||
npm pkg set <key>=<value> [<key>=<value> ...]
|
||||
npm pkg get [<key> [<key> ...]]
|
||||
@ -18,11 +14,6 @@ npm pkg set [<array>[<index>].<key>=<value> ...]
|
||||
npm pkg set [<array>[].<key>=<value> ...]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/pkg.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
A command that automates the management of `package.json` files.
|
||||
@ -183,9 +174,6 @@ npm pkg get name version --ws
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `force`
|
||||
|
||||
* Default: false
|
||||
@ -212,9 +200,6 @@ mistakes, unnecessary performance degradation, and malicious input.
|
||||
If you don't have a clear idea of what you want to do, it is strongly
|
||||
recommended that you do not use this option!
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -227,9 +212,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -252,9 +234,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -272,11 +251,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
## See Also
|
||||
|
||||
* [npm install](/commands/npm-install)
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-prefix.md
vendored
17
deps/npm/docs/content/commands/npm-prefix.md
vendored
@ -6,19 +6,10 @@ description: Display prefix
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/prefix.js -->
|
||||
|
||||
```bash
|
||||
npm prefix [-g]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/prefix.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -44,9 +35,6 @@ npm prefix -g
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -61,11 +49,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm root](/commands/npm-root)
|
||||
|
||||
26
deps/npm/docs/content/commands/npm-profile.md
vendored
26
deps/npm/docs/content/commands/npm-profile.md
vendored
@ -6,10 +6,6 @@ description: Change settings on your registry profile
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/profile.js -->
|
||||
|
||||
```bash
|
||||
npm profile enable-2fa [auth-only|auth-and-writes]
|
||||
npm profile disable-2fa
|
||||
@ -17,11 +13,6 @@ npm profile get [<key>]
|
||||
npm profile set <key> <value>
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/profile.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -83,9 +74,6 @@ Some of these commands may not be available on non npmjs.com registries.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -93,9 +81,6 @@ Some of these commands may not be available on non npmjs.com registries.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -108,9 +93,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `parseable`
|
||||
|
||||
* Default: false
|
||||
@ -119,9 +101,6 @@ Not supported by all npm commands.
|
||||
Output parseable results from commands that write to standard output. For
|
||||
`npm search`, this will be tab-separated table format.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -133,11 +112,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm adduser](/commands/npm-adduser)
|
||||
|
||||
41
deps/npm/docs/content/commands/npm-prune.md
vendored
41
deps/npm/docs/content/commands/npm-prune.md
vendored
@ -6,19 +6,10 @@ description: Remove extraneous packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/prune.js -->
|
||||
|
||||
```bash
|
||||
npm prune [[<@scope>/]<pkg>...]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/prune.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command removes "extraneous" packages. If a package name is provided,
|
||||
@ -44,9 +35,6 @@ this command can help clean up any resulting garbage.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -65,9 +53,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -81,9 +66,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -96,9 +78,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `foreground-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -111,9 +90,6 @@ input, output, and error with the main npm process.
|
||||
Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -126,9 +102,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -151,9 +124,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -172,9 +142,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -188,9 +155,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -200,11 +164,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm uninstall](/commands/npm-uninstall)
|
||||
|
||||
35
deps/npm/docs/content/commands/npm-publish.md
vendored
35
deps/npm/docs/content/commands/npm-publish.md
vendored
@ -6,19 +6,10 @@ description: Publish a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/publish.js -->
|
||||
|
||||
```bash
|
||||
npm publish <package-spec>
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/publish.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
Publishes a package to the registry so that it can be installed by name.
|
||||
@ -96,9 +87,6 @@ built.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `tag`
|
||||
|
||||
* Default: "latest"
|
||||
@ -113,9 +101,6 @@ command, if no explicit tag is given.
|
||||
When used by the `npm diff` command, this is the tag used to fetch the
|
||||
tarball that will be compared with the local files by default.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `access`
|
||||
|
||||
* Default: 'restricted' for scoped packages, 'public' for unscoped packages
|
||||
@ -132,9 +117,6 @@ subsequent `npm publish` commands using the `--access` flag will not have an
|
||||
effect to the access level. To make changes to the access level after the
|
||||
initial publish use `npm access`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -148,9 +130,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -162,9 +141,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -187,9 +163,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -208,9 +181,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -224,11 +194,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
26
deps/npm/docs/content/commands/npm-query.md
vendored
26
deps/npm/docs/content/commands/npm-query.md
vendored
@ -6,19 +6,10 @@ description: Dependency selector query
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/query.js -->
|
||||
|
||||
```bash
|
||||
npm query <selector>
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/query.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
The `npm query` command allows for usage of css selectors in order to retrieve
|
||||
@ -147,9 +138,6 @@ npm query ":type(git)" | jq 'map(.name)' | xargs -I {} npm why {}
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -164,9 +152,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -189,9 +174,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -210,9 +192,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -225,11 +204,6 @@ all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
## See Also
|
||||
|
||||
* [dependency selectors](/using-npm/dependency-selectors)
|
||||
|
||||
38
deps/npm/docs/content/commands/npm-rebuild.md
vendored
38
deps/npm/docs/content/commands/npm-rebuild.md
vendored
@ -6,21 +6,12 @@ description: Rebuild a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/rebuild.js -->
|
||||
|
||||
```bash
|
||||
npm rebuild [<package-spec>] ...]
|
||||
|
||||
alias: rb
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/rebuild.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command runs the `npm build` command on the matched folders. This is
|
||||
@ -34,9 +25,6 @@ name and version matching one of the specifiers will be rebuilt.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -51,9 +39,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
@ -66,9 +51,6 @@ Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `foreground-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -81,9 +63,6 @@ input, output, and error with the main npm process.
|
||||
Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -96,9 +75,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -121,9 +97,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -142,9 +115,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -158,9 +128,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -170,11 +137,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
29
deps/npm/docs/content/commands/npm-repo.md
vendored
29
deps/npm/docs/content/commands/npm-repo.md
vendored
@ -6,19 +6,10 @@ description: Open package repository page in the browser
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/repo.js -->
|
||||
|
||||
```bash
|
||||
npm repo [<pkgname> [<pkgname> ...]]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/repo.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command tries to guess at the likely location of a package's
|
||||
@ -28,9 +19,6 @@ in the current folder and use the `repository` property.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `browser`
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
@ -43,9 +31,6 @@ terminal.
|
||||
|
||||
Set to `true` to use default system URL opener.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -53,9 +38,6 @@ Set to `true` to use default system URL opener.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -78,9 +60,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -99,9 +78,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -115,11 +91,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm docs](/commands/npm-docs)
|
||||
|
||||
20
deps/npm/docs/content/commands/npm-restart.md
vendored
20
deps/npm/docs/content/commands/npm-restart.md
vendored
@ -6,19 +6,10 @@ description: Restart a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/restart.js -->
|
||||
|
||||
```bash
|
||||
npm restart [-- <args>]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/restart.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This restarts a project. It is equivalent to running `npm run-script
|
||||
@ -45,9 +36,6 @@ If it does _not_ have a `"restart"` script specified, but it does have
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -60,9 +48,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `script-shell`
|
||||
|
||||
* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
|
||||
@ -71,11 +56,6 @@ will *not* run any pre- or post-scripts.
|
||||
The shell to use for scripts run with the `npm exec`, `npm run` and `npm
|
||||
init <package-spec>` commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm run-script](/commands/npm-run-script)
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-root.md
vendored
17
deps/npm/docs/content/commands/npm-root.md
vendored
@ -6,19 +6,10 @@ description: Display npm root
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/root.js -->
|
||||
|
||||
```bash
|
||||
npm root
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/root.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
Print the effective `node_modules` folder to standard out.
|
||||
@ -34,9 +25,6 @@ echo "Global packages installed in: ${global_node_modules}"
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -51,11 +39,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm prefix](/commands/npm-prefix)
|
||||
|
||||
35
deps/npm/docs/content/commands/npm-run-script.md
vendored
35
deps/npm/docs/content/commands/npm-run-script.md
vendored
@ -6,21 +6,12 @@ description: Run arbitrary package scripts
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/run-script.js -->
|
||||
|
||||
```bash
|
||||
npm run-script <command> [-- <args>]
|
||||
|
||||
aliases: run, rum, urn
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/run-script.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This runs an arbitrary command from a package's `"scripts"` object. If no
|
||||
@ -143,9 +134,6 @@ packages.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -168,9 +156,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -189,9 +174,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -205,9 +187,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `if-present`
|
||||
|
||||
* Default: false
|
||||
@ -222,9 +201,6 @@ CI setup.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -237,9 +213,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `foreground-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -252,9 +225,6 @@ input, output, and error with the main npm process.
|
||||
Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `script-shell`
|
||||
|
||||
* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
|
||||
@ -263,11 +233,6 @@ but can be useful for debugging.
|
||||
The shell to use for scripts run with the `npm exec`, `npm run` and `npm
|
||||
init <package-spec>` commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
|
||||
47
deps/npm/docs/content/commands/npm-search.md
vendored
47
deps/npm/docs/content/commands/npm-search.md
vendored
@ -6,21 +6,12 @@ description: Search for packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/search.js -->
|
||||
|
||||
```bash
|
||||
npm search [search terms ...]
|
||||
|
||||
aliases: find, s, se
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/search.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -48,9 +39,6 @@ expression characters in most shells.)
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `long`
|
||||
|
||||
* Default: false
|
||||
@ -58,9 +46,6 @@ expression characters in most shells.)
|
||||
|
||||
Show extended information in `ls`, `search`, and `help-search`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -73,9 +58,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `color`
|
||||
|
||||
* Default: true unless the NO_COLOR environ is set to something other than '0'
|
||||
@ -84,9 +66,6 @@ Not supported by all npm commands.
|
||||
If false, never shows colors. If `"always"` then always shows colors. If
|
||||
true, then only prints color codes for tty file descriptors.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `parseable`
|
||||
|
||||
* Default: false
|
||||
@ -95,9 +74,6 @@ true, then only prints color codes for tty file descriptors.
|
||||
Output parseable results from commands that write to standard output. For
|
||||
`npm search`, this will be tab-separated table format.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `description`
|
||||
|
||||
* Default: true
|
||||
@ -105,9 +81,6 @@ Output parseable results from commands that write to standard output. For
|
||||
|
||||
Show the description in `npm search`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `searchopts`
|
||||
|
||||
* Default: ""
|
||||
@ -115,9 +88,6 @@ Show the description in `npm search`
|
||||
|
||||
Space-separated options that are always passed to search.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `searchexclude`
|
||||
|
||||
* Default: ""
|
||||
@ -125,9 +95,6 @@ Space-separated options that are always passed to search.
|
||||
|
||||
Space-separated options that limit the results from search.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -135,9 +102,6 @@ Space-separated options that limit the results from search.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `prefer-online`
|
||||
|
||||
* Default: false
|
||||
@ -146,9 +110,6 @@ The base URL of the npm registry.
|
||||
If true, staleness checks for cached data will be forced, making the CLI
|
||||
look for updates immediately even for fresh package data.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `prefer-offline`
|
||||
|
||||
* Default: false
|
||||
@ -158,9 +119,6 @@ If true, staleness checks for cached data will be bypassed, but missing data
|
||||
will be requested from the server. To force full offline mode, use
|
||||
`--offline`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `offline`
|
||||
|
||||
* Default: false
|
||||
@ -169,11 +127,6 @@ will be requested from the server. To force full offline mode, use
|
||||
Force offline mode: no network requests will be done during install. To
|
||||
allow the CLI to fill in missing cache data, see `--prefer-offline`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm registry](/using-npm/registry)
|
||||
|
||||
23
deps/npm/docs/content/commands/npm-set-script.md
vendored
23
deps/npm/docs/content/commands/npm-set-script.md
vendored
@ -9,19 +9,10 @@ An npm command that lets you create a task in the `scripts` section of the `pack
|
||||
|
||||
Deprecated.
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/set-script.js -->
|
||||
|
||||
```bash
|
||||
npm set-script [<script>] [<command>]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/set-script.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
|
||||
**Example:**
|
||||
|
||||
@ -39,9 +30,6 @@ npm set-script [<script>] [<command>]
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -64,9 +52,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -85,9 +70,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -101,11 +83,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm run-script](/commands/npm-run-script)
|
||||
|
||||
@ -6,19 +6,10 @@ description: Lock down dependency versions for publication
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/shrinkwrap.js -->
|
||||
|
||||
```bash
|
||||
npm shrinkwrap
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/shrinkwrap.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
23
deps/npm/docs/content/commands/npm-star.md
vendored
23
deps/npm/docs/content/commands/npm-star.md
vendored
@ -6,19 +6,10 @@ description: Mark your favorite packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/star.js -->
|
||||
|
||||
```bash
|
||||
npm star [<package-spec>...]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/star.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -44,9 +35,6 @@ You can see all your starred packages using [`npm stars`](/commands/npm-stars)
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -54,9 +42,6 @@ You can see all your starred packages using [`npm stars`](/commands/npm-stars)
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `unicode`
|
||||
|
||||
* Default: false on windows, true on mac/unix systems with a unicode locale,
|
||||
@ -66,9 +51,6 @@ The base URL of the npm registry.
|
||||
When set to true, npm uses unicode characters in the tree output. When
|
||||
false, it uses ascii characters instead of unicode glyphs.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -80,11 +62,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-stars.md
vendored
17
deps/npm/docs/content/commands/npm-stars.md
vendored
@ -6,19 +6,10 @@ description: View packages marked as favorites
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/stars.js -->
|
||||
|
||||
```bash
|
||||
npm stars [<user>]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/stars.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -31,9 +22,6 @@ you will most certainly enjoy this command.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -41,11 +29,6 @@ you will most certainly enjoy this command.
|
||||
|
||||
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
|
||||
|
||||
* [npm star](/commands/npm-star)
|
||||
|
||||
20
deps/npm/docs/content/commands/npm-start.md
vendored
20
deps/npm/docs/content/commands/npm-start.md
vendored
@ -6,19 +6,10 @@ description: Start a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/start.js -->
|
||||
|
||||
```bash
|
||||
npm start [-- <args>]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/start.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This runs a predefined command specified in the `"start"` property of
|
||||
@ -56,9 +47,6 @@ npm start
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -71,9 +59,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `script-shell`
|
||||
|
||||
* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
|
||||
@ -82,11 +67,6 @@ will *not* run any pre- or post-scripts.
|
||||
The shell to use for scripts run with the `npm exec`, `npm run` and `npm
|
||||
init <package-spec>` commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm run-script](/commands/npm-run-script)
|
||||
|
||||
20
deps/npm/docs/content/commands/npm-stop.md
vendored
20
deps/npm/docs/content/commands/npm-stop.md
vendored
@ -6,19 +6,10 @@ description: Stop a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/stop.js -->
|
||||
|
||||
```bash
|
||||
npm stop [-- <args>]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/stop.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This runs a predefined command specified in the "stop" property of a
|
||||
@ -49,9 +40,6 @@ npm stop
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -64,9 +52,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `script-shell`
|
||||
|
||||
* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
|
||||
@ -75,11 +60,6 @@ will *not* run any pre- or post-scripts.
|
||||
The shell to use for scripts run with the `npm exec`, `npm run` and `npm
|
||||
init <package-spec>` commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm run-script](/commands/npm-run-script)
|
||||
|
||||
26
deps/npm/docs/content/commands/npm-team.md
vendored
26
deps/npm/docs/content/commands/npm-team.md
vendored
@ -6,10 +6,6 @@ description: Manage organization teams and team memberships
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/team.js -->
|
||||
|
||||
```bash
|
||||
npm team create <scope:team> [--otp <otpcode>]
|
||||
npm team destroy <scope:team> [--otp <otpcode>]
|
||||
@ -18,11 +14,6 @@ npm team rm <scope:team> <user> [--otp <otpcode>]
|
||||
npm team ls <scope>|<scope:team>
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/team.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -110,9 +101,6 @@ use the `npm access` command to grant or revoke the appropriate permissions.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -120,9 +108,6 @@ use the `npm access` command to grant or revoke the appropriate permissions.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -134,9 +119,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `parseable`
|
||||
|
||||
* Default: false
|
||||
@ -145,9 +127,6 @@ password, npm will prompt on the command line for one.
|
||||
Output parseable results from commands that write to standard output. For
|
||||
`npm search`, this will be tab-separated table format.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -160,11 +139,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm access](/commands/npm-access)
|
||||
|
||||
20
deps/npm/docs/content/commands/npm-test.md
vendored
20
deps/npm/docs/content/commands/npm-test.md
vendored
@ -6,21 +6,12 @@ description: Test a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/test.js -->
|
||||
|
||||
```bash
|
||||
npm test [-- <args>]
|
||||
|
||||
aliases: tst, t
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/test.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This runs a predefined command specified in the `"test"` property of
|
||||
@ -46,9 +37,6 @@ npm test
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -61,9 +49,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `script-shell`
|
||||
|
||||
* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
|
||||
@ -72,11 +57,6 @@ will *not* run any pre- or post-scripts.
|
||||
The shell to use for scripts run with the `npm exec`, `npm run` and `npm
|
||||
init <package-spec>` commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm run-script](/commands/npm-run-script)
|
||||
|
||||
26
deps/npm/docs/content/commands/npm-token.md
vendored
26
deps/npm/docs/content/commands/npm-token.md
vendored
@ -6,21 +6,12 @@ description: Manage your authentication tokens
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/token.js -->
|
||||
|
||||
```bash
|
||||
npm token list
|
||||
npm token revoke <id|token>
|
||||
npm token create [--read-only] [--cidr=list]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/token.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -86,9 +77,6 @@ This lets you list, create and revoke authentication tokens.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `read-only`
|
||||
|
||||
* Default: false
|
||||
@ -97,9 +85,6 @@ This lets you list, create and revoke authentication tokens.
|
||||
This is used to mark a token as unable to publish when configuring limited
|
||||
access tokens with the `npm token create` command.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `cidr`
|
||||
|
||||
* Default: null
|
||||
@ -108,9 +93,6 @@ access tokens with the `npm token create` command.
|
||||
This is a list of CIDR address to be used when configuring limited access
|
||||
tokens with the `npm token create` command.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -118,9 +100,6 @@ tokens with the `npm token create` command.
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -132,11 +111,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm adduser](/commands/npm-adduser)
|
||||
|
||||
29
deps/npm/docs/content/commands/npm-uninstall.md
vendored
29
deps/npm/docs/content/commands/npm-uninstall.md
vendored
@ -6,21 +6,12 @@ description: Remove a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/uninstall.js -->
|
||||
|
||||
```bash
|
||||
npm uninstall [<@scope>/]<pkg>...
|
||||
|
||||
aliases: unlink, remove, rm, r, un
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/uninstall.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This uninstalls a package, completely removing everything npm installed
|
||||
@ -65,9 +56,6 @@ npm uninstall lodash --no-save
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `save`
|
||||
|
||||
* Default: `true` unless when using `npm update` where it defaults to `false`
|
||||
@ -80,9 +68,6 @@ When used with the `npm rm` command, removes the dependency from
|
||||
|
||||
Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -105,9 +90,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -126,9 +108,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -142,9 +121,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -154,11 +130,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm prune](/commands/npm-prune)
|
||||
|
||||
26
deps/npm/docs/content/commands/npm-unpublish.md
vendored
26
deps/npm/docs/content/commands/npm-unpublish.md
vendored
@ -6,19 +6,10 @@ description: Remove a package from the registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/unpublish.js -->
|
||||
|
||||
```bash
|
||||
npm unpublish [<package-spec>]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/unpublish.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
To learn more about how the npm registry treats unpublish, see our <a
|
||||
href="https://docs.npmjs.com/policies/unpublish" target="_blank"
|
||||
rel="noopener noreferrer"> unpublish policies</a>
|
||||
@ -48,9 +39,6 @@ passed.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -64,9 +52,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `force`
|
||||
|
||||
* Default: false
|
||||
@ -93,9 +78,6 @@ mistakes, unnecessary performance degradation, and malicious input.
|
||||
If you don't have a clear idea of what you want to do, it is strongly
|
||||
recommended that you do not use this option!
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -118,9 +100,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -139,11 +118,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [package spec](/using-npm/package-spec)
|
||||
|
||||
23
deps/npm/docs/content/commands/npm-unstar.md
vendored
23
deps/npm/docs/content/commands/npm-unstar.md
vendored
@ -6,19 +6,10 @@ description: Remove an item from your favorite packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/unstar.js -->
|
||||
|
||||
```bash
|
||||
npm unstar [<package-spec>...]
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/unstar.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -40,9 +31,6 @@ You can see all your starred packages using [`npm stars`](/commands/npm-stars)
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -50,9 +38,6 @@ You can see all your starred packages using [`npm stars`](/commands/npm-stars)
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `unicode`
|
||||
|
||||
* Default: false on windows, true on mac/unix systems with a unicode locale,
|
||||
@ -62,9 +47,6 @@ The base URL of the npm registry.
|
||||
When set to true, npm uses unicode characters in the tree output. When
|
||||
false, it uses ascii characters instead of unicode glyphs.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
@ -76,11 +58,6 @@ when publishing or changing package permissions with `npm access`.
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm star](/commands/npm-star)
|
||||
|
||||
65
deps/npm/docs/content/commands/npm-update.md
vendored
65
deps/npm/docs/content/commands/npm-update.md
vendored
@ -6,21 +6,12 @@ description: Update packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/update.js -->
|
||||
|
||||
```bash
|
||||
npm update [<pkg>...]
|
||||
|
||||
aliases: up, upgrade, udpate
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/update.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command will update all the packages listed to the latest version
|
||||
@ -166,9 +157,6 @@ be _downgraded_.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `save`
|
||||
|
||||
* Default: `true` unless when using `npm update` where it defaults to `false`
|
||||
@ -181,9 +169,6 @@ When used with the `npm rm` command, removes the dependency from
|
||||
|
||||
Will also prevent writing to `package-lock.json` if set to `false`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
@ -198,9 +183,6 @@ folder instead of the current working directory. See
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
@ -213,9 +195,6 @@ on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
@ -226,9 +205,6 @@ such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
@ -247,9 +223,6 @@ it will be included.
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
@ -269,9 +242,6 @@ When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
@ -282,9 +252,6 @@ will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
This configuration does not affect `npm ci`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `foreground-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -297,9 +264,6 @@ input, output, and error with the main npm process.
|
||||
Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
@ -312,9 +276,6 @@ Note that commands explicitly intended to run a particular script, such as
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
@ -325,9 +286,6 @@ default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
@ -340,9 +298,6 @@ Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
@ -352,9 +307,6 @@ When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
@ -368,9 +320,6 @@ commands that modify your local installation, eg, `install`, `update`,
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -393,9 +342,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -414,9 +360,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -430,9 +373,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `install-links`
|
||||
|
||||
* Default: false
|
||||
@ -442,11 +382,6 @@ 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.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/commands/npm-install)
|
||||
|
||||
44
deps/npm/docs/content/commands/npm-version.md
vendored
44
deps/npm/docs/content/commands/npm-version.md
vendored
@ -6,26 +6,14 @@ description: Bump a package version
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/version.js -->
|
||||
|
||||
```bash
|
||||
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]
|
||||
|
||||
alias: verison
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/version.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `allow-same-version`
|
||||
|
||||
* Default: false
|
||||
@ -34,9 +22,6 @@ alias: verison
|
||||
Prevents throwing an error when `npm version` is used to set the new version
|
||||
to the same value as the current version.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `commit-hooks`
|
||||
|
||||
* Default: true
|
||||
@ -44,9 +29,6 @@ to the same value as the current version.
|
||||
|
||||
Run git commit hooks when using the `npm version` command.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `git-tag-version`
|
||||
|
||||
* Default: true
|
||||
@ -55,9 +37,6 @@ Run git commit hooks when using the `npm version` command.
|
||||
Tag the commit when using the `npm version` command. Setting this to false
|
||||
results in no commit being made at all.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -70,9 +49,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `preid`
|
||||
|
||||
* Default: ""
|
||||
@ -81,9 +57,6 @@ Not supported by all npm commands.
|
||||
The "prerelease identifier" to use as a prefix for the "prerelease" part of
|
||||
a semver. Like the `rc` in `1.2.0-rc.8`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `sign-git-tag`
|
||||
|
||||
* Default: false
|
||||
@ -95,9 +68,6 @@ If set to true, then the `npm version` command will tag the version using
|
||||
Note that git requires you to have set up GPG keys in your git configs for
|
||||
this to work properly.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -120,9 +90,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -141,9 +108,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces-update`
|
||||
|
||||
* Default: true
|
||||
@ -152,9 +116,6 @@ This value is not exported to the environment for child processes.
|
||||
If set to true, the npm cli will run an update after operations that may
|
||||
possibly change the workspaces installed to the `node_modules` folder.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -168,11 +129,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
Run this in a package directory to bump the version and write the new data
|
||||
|
||||
26
deps/npm/docs/content/commands/npm-view.md
vendored
26
deps/npm/docs/content/commands/npm-view.md
vendored
@ -6,21 +6,12 @@ description: View registry info
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/view.js -->
|
||||
|
||||
```bash
|
||||
npm view [<package-spec>] [<field>[.subfield]...]
|
||||
|
||||
aliases: info, show, v
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/view.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command shows data about a package and prints it to stdout.
|
||||
@ -105,9 +96,6 @@ npm view connect versions
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
@ -120,9 +108,6 @@ Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
@ -145,9 +130,6 @@ 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 -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
@ -166,9 +148,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
@ -182,11 +161,6 @@ the specified workspaces, and not on the root project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### Output
|
||||
|
||||
If only a single string field for a single version is output, then it
|
||||
|
||||
17
deps/npm/docs/content/commands/npm-whoami.md
vendored
17
deps/npm/docs/content/commands/npm-whoami.md
vendored
@ -6,19 +6,10 @@ description: Display npm username
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/whoami.js -->
|
||||
|
||||
```bash
|
||||
npm whoami
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/whoami.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
@ -34,9 +25,6 @@ If logged into a registry that uses Basic Auth, then simply print the
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
@ -44,11 +32,6 @@ If logged into a registry that uses Basic Auth, then simply print the
|
||||
|
||||
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
|
||||
|
||||
* [npm config](/commands/npm-config)
|
||||
|
||||
7
deps/npm/docs/content/commands/npm.md
vendored
7
deps/npm/docs/content/commands/npm.md
vendored
@ -6,12 +6,13 @@ description: javascript package manager
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
```bash
|
||||
npm
|
||||
```
|
||||
|
||||
### Version
|
||||
|
||||
@VERSION@
|
||||
8.19.3
|
||||
|
||||
### Description
|
||||
|
||||
|
||||
9
deps/npm/docs/content/commands/npx.md
vendored
9
deps/npm/docs/content/commands/npx.md
vendored
@ -6,10 +6,6 @@ description: Run a command from a local or remote npm package
|
||||
|
||||
### Synopsis
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/exec.js -->
|
||||
|
||||
```bash
|
||||
npx -- <pkg>[@<version>] [args...]
|
||||
npx --package=<pkg>[@<version>] -- <cmd> [args...]
|
||||
@ -17,11 +13,6 @@ npx -c '<cmd> [args...]'
|
||||
npx --package=foo -c '<cmd> [args...]'
|
||||
```
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/commands/exec.js -->
|
||||
|
||||
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
||||
|
||||
### Description
|
||||
|
||||
This command allows you to run an arbitrary command from an npm package
|
||||
|
||||
@ -18,11 +18,9 @@ settings described in [`config`](/using-npm/config).
|
||||
If you plan to publish your package, the *most* important things in your
|
||||
package.json are the name and version fields as they will be required. The
|
||||
name and version together form an identifier that is assumed to be
|
||||
completely unique. Changes to the package should come along with changes
|
||||
to the version. If you don't plan to publish your package, the name and
|
||||
completely unique. If you don't plan to publish your package, the name and
|
||||
version fields are optional.
|
||||
|
||||
The name is what your thing is called.
|
||||
The name field contains your package name.
|
||||
|
||||
Some rules:
|
||||
|
||||
@ -52,12 +50,9 @@ A name can be optionally prefixed by a scope, e.g. `@myorg/mypackage`. See
|
||||
|
||||
### version
|
||||
|
||||
If you plan to publish your package, the *most* important things in your
|
||||
package.json are the name and version fields as they will be required. The
|
||||
name and version together form an identifier that is assumed to be
|
||||
completely unique. Changes to the package should come along with changes
|
||||
to the version. If you don't plan to publish your package, the name and
|
||||
version fields are optional.
|
||||
Changes to the package should come along with changes to the version.
|
||||
You can show developers how much they need to adjust on a new update by
|
||||
using [semantic versioning](../../about-semantic-versioning)
|
||||
|
||||
Version must be parseable by
|
||||
[node-semver](https://github.com/npm/node-semver), which is bundled with
|
||||
|
||||
461
deps/npm/docs/content/using-npm/config.md
vendored
461
deps/npm/docs/content/using-npm/config.md
vendored
File diff suppressed because it is too large
Load Diff
@ -4,7 +4,6 @@ section: 7
|
||||
description: Package name specifier
|
||||
---
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
Commands like `npm install` and the dependency sections in the
|
||||
|
||||
14
deps/npm/docs/output/commands/npm-access.html
vendored
14
deps/npm/docs/output/commands/npm-access.html
vendored
@ -146,9 +146,6 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm access public [<package>]
|
||||
npm access restricted [<package>]
|
||||
npm access grant <read-only|read-write> <scope:team> [<package>]
|
||||
@ -159,9 +156,6 @@ npm access ls-packages [<user>|<scope>|<scope:team>]
|
||||
npm access ls-collaborators [<package> [<user>]]
|
||||
npm access edit [<package>]
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Used to set access controls on private packages.</p>
|
||||
<p>For all of the subcommands, <code>npm access</code> will perform actions on the packages
|
||||
@ -220,17 +214,12 @@ fail with an HTTP 402 status code (logically enough), unless you use
|
||||
<code>--access=public</code>.</p>
|
||||
<p>Management of teams and team memberships is done with the <code>npm team</code> command.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="registry"><code>registry</code></h4>
|
||||
<ul>
|
||||
<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
|
||||
<li>Type: URL</li>
|
||||
</ul>
|
||||
<p>The base URL of the npm registry.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="otp"><code>otp</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -240,9 +229,6 @@ fail with an HTTP 402 status code (logically enough), unless you use
|
||||
when publishing or changing package permissions with <code>npm access</code>.</p>
|
||||
<p>If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="https://npm.im/libnpmaccess"><code>libnpmaccess</code></a></li>
|
||||
|
||||
16
deps/npm/docs/output/commands/npm-adduser.html
vendored
16
deps/npm/docs/output/commands/npm-adduser.html
vendored
@ -146,16 +146,10 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm adduser
|
||||
|
||||
aliases: login, add-user
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Create or verify a user named <code><username></code> in the specified registry, and
|
||||
@ -170,17 +164,12 @@ the username, password and email address must all match with
|
||||
your existing record.</p>
|
||||
<p><code>npm login</code> is an alias to <code>adduser</code> and behaves exactly the same way.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="registry"><code>registry</code></h4>
|
||||
<ul>
|
||||
<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
|
||||
<li>Type: URL</li>
|
||||
</ul>
|
||||
<p>The base URL of the npm registry.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="scope"><code>scope</code></h4>
|
||||
<ul>
|
||||
<li>Default: the scope of the current project, if any, or ""</li>
|
||||
@ -202,8 +191,6 @@ installation of packages specified according to the pattern
|
||||
# instead of just named "whatever"
|
||||
npm init --scope=@foo --yes
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="auth-type"><code>auth-type</code></h4>
|
||||
<ul>
|
||||
<li>Default: "legacy"</li>
|
||||
@ -212,9 +199,6 @@ npm init --scope=@foo --yes
|
||||
<p>NOTE: auth-type values "sso", "saml", "oauth", and "webauthn" will be
|
||||
removed in a future version.</p>
|
||||
<p>What authentication strategy to use with <code>login</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../using-npm/registry.html">npm registry</a></li>
|
||||
|
||||
34
deps/npm/docs/output/commands/npm-audit.html
vendored
34
deps/npm/docs/output/commands/npm-audit.html
vendored
@ -146,14 +146,8 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm audit [fix|signatures]
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>The audit command submits a description of the dependencies configured in
|
||||
your project to your default registry and asks for a report of known
|
||||
@ -314,9 +308,6 @@ fixing anything:</p>
|
||||
<pre lang="bash"><code>$ npm audit --audit-level=moderate
|
||||
</code></pre>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="audit-level"><code>audit-level</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -324,8 +315,6 @@ fixing anything:</p>
|
||||
</ul>
|
||||
<p>The minimum level of vulnerability for <code>npm audit</code> to exit with a non-zero
|
||||
exit code.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="dry-run"><code>dry-run</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -337,8 +326,6 @@ commands that modify your local installation, eg, <code>install</code>, <code>up
|
||||
<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
|
||||
<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
|
||||
<code>owner</code>, etc.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="force"><code>force</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -364,8 +351,6 @@ range (including SemVer-major changes).</li>
|
||||
</ul>
|
||||
<p>If you don't have a clear idea of what you want to do, it is strongly
|
||||
recommended that you do not use this option!</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="json"><code>json</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -377,8 +362,6 @@ recommended that you do not use this option!</p>
|
||||
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="package-lock-only"><code>package-lock-only</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -390,8 +373,6 @@ ignoring <code>node_modules</code>.</p>
|
||||
instead of checking <code>node_modules</code> and downloading dependencies.</p>
|
||||
<p>For <code>list</code> this means the output will be based on the tree described by the
|
||||
<code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="omit"><code>omit</code></h4>
|
||||
<ul>
|
||||
<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
|
||||
@ -406,8 +387,6 @@ physically installed on disk.</p>
|
||||
it will be included.</p>
|
||||
<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
|
||||
variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -418,8 +397,6 @@ scripts for installed packages in the foreground process, sharing standard
|
||||
input, output, and error with the main npm process.</p>
|
||||
<p>Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -430,8 +407,6 @@ but can be useful for debugging.</p>
|
||||
<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
|
||||
will still run their intended script if <code>ignore-scripts</code> is set, but they
|
||||
will <em>not</em> run any pre- or post-scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -451,8 +426,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -469,8 +442,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -481,8 +452,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="install-links"><code>install-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -491,9 +460,6 @@ the specified workspaces, and not on the root project.</p>
|
||||
<p>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.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-install.html">npm install</a></li>
|
||||
|
||||
12
deps/npm/docs/output/commands/npm-bin.html
vendored
12
deps/npm/docs/output/commands/npm-bin.html
vendored
@ -146,21 +146,12 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm bin
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Print the folder where npm will install executables.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global"><code>global</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -175,9 +166,6 @@ of the current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-prefix.html">npm prefix</a></li>
|
||||
|
||||
20
deps/npm/docs/output/commands/npm-bugs.html
vendored
20
deps/npm/docs/output/commands/npm-bugs.html
vendored
@ -146,25 +146,16 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm bugs [<pkgname> [<pkgname> ...]]
|
||||
|
||||
alias: issues
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command tries to guess at the likely location of a package's bug
|
||||
tracker URL or the <code>mailto</code> URL of the support email, and then tries to
|
||||
open it using the <code>--browser</code> config param. If no package name is provided, it
|
||||
will search for a <code>package.json</code> in the current folder and use the <code>name</code> property.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- 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>
|
||||
@ -174,16 +165,12 @@ will search for a <code>package.json</code> in the current folder and use the <c
|
||||
<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="registry"><code>registry</code></h4>
|
||||
<ul>
|
||||
<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
|
||||
<li>Type: URL</li>
|
||||
</ul>
|
||||
<p>The base URL of the npm registry.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -203,8 +190,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -221,8 +206,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -233,9 +216,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-docs.html">npm docs</a></li>
|
||||
|
||||
12
deps/npm/docs/output/commands/npm-cache.html
vendored
12
deps/npm/docs/output/commands/npm-cache.html
vendored
@ -146,17 +146,11 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm cache add <package-spec>
|
||||
npm cache clean [<key>]
|
||||
npm cache ls [<name>@<version>]
|
||||
npm cache verify
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<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>
|
||||
@ -206,18 +200,12 @@ 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>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="cache"><code>cache</code></h4>
|
||||
<ul>
|
||||
<li>Default: Windows: <code>%LocalAppData%\npm-cache</code>, Posix: <code>~/.npm</code></li>
|
||||
<li>Type: Path</li>
|
||||
</ul>
|
||||
<p>The location of npm's cache directory. See <a href="../commands/npm-cache.html"><code>npm cache</code></a></p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../using-npm/package-spec.html">package spec</a></li>
|
||||
|
||||
46
deps/npm/docs/output/commands/npm-ci.html
vendored
46
deps/npm/docs/output/commands/npm-ci.html
vendored
@ -146,16 +146,10 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm ci
|
||||
|
||||
aliases: clean-install, ic, install-clean, isntall-clean
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command is similar to <a href="../commands/npm-install.html"><code>npm install</code></a>, except
|
||||
it's meant to be used in automated environments such as test platforms,
|
||||
@ -202,9 +196,6 @@ cache:
|
||||
- "$HOME/.npm"
|
||||
</code></pre>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="save"><code>save</code></h4>
|
||||
<ul>
|
||||
<li>Default: <code>true</code> unless when using <code>npm update</code> where it defaults to <code>false</code></li>
|
||||
@ -214,8 +205,6 @@ cache:
|
||||
<p>When used with the <code>npm rm</code> command, removes the dependency from
|
||||
<code>package.json</code>.</p>
|
||||
<p>Will also prevent writing to <code>package-lock.json</code> if set to <code>false</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="save-exact"><code>save-exact</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -223,8 +212,6 @@ cache:
|
||||
</ul>
|
||||
<p>Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global"><code>global</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -239,8 +226,6 @@ of the current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global-style"><code>global-style</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -252,8 +237,6 @@ direct dependencies will show in <code>node_modules</code> and everything they d
|
||||
on will be flattened in their <code>node_modules</code> folders. This obviously will
|
||||
eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -263,8 +246,6 @@ will be preferred.</p>
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with <code>global-style</code> this option
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="omit"><code>omit</code></h4>
|
||||
<ul>
|
||||
<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
|
||||
@ -279,8 +260,6 @@ physically installed on disk.</p>
|
||||
it will be included.</p>
|
||||
<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
|
||||
variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -297,8 +276,6 @@ the range set in their package's <code>peerDependencies</code> object.</p>
|
||||
<p>When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
|
||||
this warning is treated as a failure.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="package-lock"><code>package-lock</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -307,8 +284,6 @@ this warning is treated as a failure.</p>
|
||||
<p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
|
||||
will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
|
||||
<p>This configuration does not affect <code>npm ci</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -319,8 +294,6 @@ scripts for installed packages in the foreground process, sharing standard
|
||||
input, output, and error with the main npm process.</p>
|
||||
<p>Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -331,8 +304,6 @@ but can be useful for debugging.</p>
|
||||
<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
|
||||
will still run their intended script if <code>ignore-scripts</code> is set, but they
|
||||
will <em>not</em> run any pre- or post-scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="audit"><code>audit</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -342,8 +313,6 @@ will <em>not</em> run any pre- or post-scripts.</p>
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
|
||||
submitted.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="bin-links"><code>bin-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -354,8 +323,6 @@ executables.</p>
|
||||
<p>Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="fund"><code>fund</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -363,8 +330,6 @@ systems.</p>
|
||||
</ul>
|
||||
<p>When "true" displays the message at the end of each <code>npm install</code>
|
||||
acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="dry-run"><code>dry-run</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -376,8 +341,6 @@ commands that modify your local installation, eg, <code>install</code>, <code>up
|
||||
<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
|
||||
<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
|
||||
<code>owner</code>, etc.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -397,8 +360,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -415,8 +376,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -427,8 +386,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="install-links"><code>install-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -437,9 +394,6 @@ the specified workspaces, and not on the root project.</p>
|
||||
<p>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.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-install.html">npm install</a></li>
|
||||
|
||||
@ -146,14 +146,8 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm completion
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Enables tab-completion in all npm commands.</p>
|
||||
|
||||
20
deps/npm/docs/output/commands/npm-config.html
vendored
20
deps/npm/docs/output/commands/npm-config.html
vendored
@ -146,9 +146,6 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm config set <key>=<value> [<key>=<value> ...]
|
||||
npm config get [<key> [<key> ...]]
|
||||
npm config delete <key> [<key> ...]
|
||||
@ -157,9 +154,6 @@ npm config edit
|
||||
|
||||
alias: c
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>npm gets its config settings from the command line, environment
|
||||
@ -203,9 +197,6 @@ to show the settings in json format.</p>
|
||||
<p>Opens the config file in an editor. Use the <code>--global</code> flag to edit the
|
||||
global config.</p>
|
||||
<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>
|
||||
@ -217,8 +208,6 @@ global config.</p>
|
||||
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="global"><code>global</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -233,8 +222,6 @@ of the current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="editor"><code>editor</code></h4>
|
||||
<ul>
|
||||
<li>Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on
|
||||
@ -242,8 +229,6 @@ Windows, or 'vim' on Unix systems</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="location"><code>location</code></h4>
|
||||
<ul>
|
||||
<li>Default: "user" unless <code>--global</code> is passed, which will also set this value
|
||||
@ -260,17 +245,12 @@ of the current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="long"><code>long</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../configuring-npm/folders.html">npm folders</a></li>
|
||||
|
||||
38
deps/npm/docs/output/commands/npm-dedupe.html
vendored
38
deps/npm/docs/output/commands/npm-dedupe.html
vendored
@ -146,16 +146,10 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm dedupe
|
||||
|
||||
alias: ddp
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Searches the local package tree and attempts to simplify the overall
|
||||
structure by moving dependencies further up the tree, where they can
|
||||
@ -201,9 +195,6 @@ result in new modules being installed.</p>
|
||||
dependencies in your project <code>package.json</code>, if you want to update
|
||||
values in <code>package.json</code> you can run: <code>npm update --save</code> instead.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global-style"><code>global-style</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -215,8 +206,6 @@ direct dependencies will show in <code>node_modules</code> and everything they d
|
||||
on will be flattened in their <code>node_modules</code> folders. This obviously will
|
||||
eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -226,8 +215,6 @@ will be preferred.</p>
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with <code>global-style</code> this option
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -244,8 +231,6 @@ the range set in their package's <code>peerDependencies</code> object.</p>
|
||||
<p>When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
|
||||
this warning is treated as a failure.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="package-lock"><code>package-lock</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -254,8 +239,6 @@ this warning is treated as a failure.</p>
|
||||
<p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
|
||||
will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
|
||||
<p>This configuration does not affect <code>npm ci</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="omit"><code>omit</code></h4>
|
||||
<ul>
|
||||
<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
|
||||
@ -270,8 +253,6 @@ physically installed on disk.</p>
|
||||
it will be included.</p>
|
||||
<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
|
||||
variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -282,8 +263,6 @@ variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
|
||||
will still run their intended script if <code>ignore-scripts</code> is set, but they
|
||||
will <em>not</em> run any pre- or post-scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="audit"><code>audit</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -293,8 +272,6 @@ will <em>not</em> run any pre- or post-scripts.</p>
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
|
||||
submitted.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="bin-links"><code>bin-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -305,8 +282,6 @@ executables.</p>
|
||||
<p>Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="fund"><code>fund</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -314,8 +289,6 @@ systems.</p>
|
||||
</ul>
|
||||
<p>When "true" displays the message at the end of each <code>npm install</code>
|
||||
acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="dry-run"><code>dry-run</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -327,8 +300,6 @@ commands that modify your local installation, eg, <code>install</code>, <code>up
|
||||
<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
|
||||
<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
|
||||
<code>owner</code>, etc.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -348,8 +319,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -366,8 +335,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -378,8 +345,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="install-links"><code>install-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -388,9 +353,6 @@ the specified workspaces, and not on the root project.</p>
|
||||
<p>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.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-find-dupes.html">npm find-dupes</a></li>
|
||||
|
||||
14
deps/npm/docs/output/commands/npm-deprecate.html
vendored
14
deps/npm/docs/output/commands/npm-deprecate.html
vendored
@ -146,14 +146,8 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm deprecate <package-spec> <message>
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command will update the npm registry entry for a package, providing a
|
||||
@ -173,17 +167,12 @@ include prerelease versions. For example:</p>
|
||||
argument. Note that you must use double quotes with no space between them to
|
||||
format an empty string.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="registry"><code>registry</code></h4>
|
||||
<ul>
|
||||
<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
|
||||
<li>Type: URL</li>
|
||||
</ul>
|
||||
<p>The base URL of the npm registry.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="otp"><code>otp</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -193,9 +182,6 @@ format an empty string.</p>
|
||||
when publishing or changing package permissions with <code>npm access</code>.</p>
|
||||
<p>If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../using-npm/package-spec.html">package spec</a></li>
|
||||
|
||||
36
deps/npm/docs/output/commands/npm-diff.html
vendored
36
deps/npm/docs/output/commands/npm-diff.html
vendored
@ -146,14 +146,8 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm diff [...<paths>]
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Similar to its <code>git diff</code> counterpart, this command will print diff patches
|
||||
of files for packages published to the npm registry.</p>
|
||||
@ -261,41 +255,30 @@ of files for a given package, e.g:</p>
|
||||
located within the folder <code>./lib/</code> and changed lines of code within the
|
||||
<code>CHANGELOG.md</code> file.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="diff"><code>diff</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
<li>Type: String (can be set multiple times)</li>
|
||||
</ul>
|
||||
<p>Define arguments to compare in <code>npm diff</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="diff-name-only"><code>diff-name-only</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Prints only filenames when using <code>npm diff</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="diff-unified"><code>diff-unified</code></h4>
|
||||
<ul>
|
||||
<li>Default: 3</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>The number of lines of context to print in <code>npm diff</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="diff-ignore-all-space"><code>diff-ignore-all-space</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Ignore whitespace when comparing lines in <code>npm diff</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="diff-no-prefix"><code>diff-no-prefix</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -304,32 +287,24 @@ located within the folder <code>./lib/</code> and changed lines of code within t
|
||||
<p>Do not show any source or destination prefix in <code>npm diff</code> output.</p>
|
||||
<p>Note: this causes <code>npm diff</code> to ignore the <code>--diff-src-prefix</code> and
|
||||
<code>--diff-dst-prefix</code> configs.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="diff-src-prefix"><code>diff-src-prefix</code></h4>
|
||||
<ul>
|
||||
<li>Default: "a/"</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>Source prefix to be used in <code>npm diff</code> output.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="diff-dst-prefix"><code>diff-dst-prefix</code></h4>
|
||||
<ul>
|
||||
<li>Default: "b/"</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>Destination prefix to be used in <code>npm diff</code> output.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="diff-text"><code>diff-text</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Treat all files as text in <code>npm diff</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global"><code>global</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -344,8 +319,6 @@ of the current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="tag"><code>tag</code></h4>
|
||||
<ul>
|
||||
<li>Default: "latest"</li>
|
||||
@ -357,8 +330,6 @@ then it will install the specified tag.</p>
|
||||
command, if no explicit tag is given.</p>
|
||||
<p>When used by the <code>npm diff</code> command, this is the tag used to fetch the
|
||||
tarball that will be compared with the local files by default.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -378,8 +349,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -396,8 +365,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -408,9 +375,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h2 id="see-also">See Also</h2>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-outdated.html">npm outdated</a></li>
|
||||
|
||||
16
deps/npm/docs/output/commands/npm-dist-tag.html
vendored
16
deps/npm/docs/output/commands/npm-dist-tag.html
vendored
@ -146,18 +146,12 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm dist-tag add <package-spec (with version)> [<tag>]
|
||||
npm dist-tag rm <package-spec> <tag>
|
||||
npm dist-tag ls [<package-spec>]
|
||||
|
||||
alias: dist-tags
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Add, remove, and enumerate distribution tags on a package:</p>
|
||||
<ul>
|
||||
@ -216,9 +210,6 @@ semver as <code>>=1.4.0 <1.5.0</code>. See <a href="https://github.com/np
|
||||
<p>The simplest way to avoid semver problems with tags is to use tags that do
|
||||
not begin with a number or the letter <code>v</code>.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -238,8 +229,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -256,8 +245,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -268,9 +255,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../using-npm/package-spec.html">package spec</a></li>
|
||||
|
||||
20
deps/npm/docs/output/commands/npm-docs.html
vendored
20
deps/npm/docs/output/commands/npm-docs.html
vendored
@ -146,16 +146,10 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm docs [<pkgname> [<pkgname> ...]]
|
||||
|
||||
alias: home
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command tries to guess at the likely location of a package's
|
||||
documentation URL, and then tries to open it using the <code>--browser</code> config
|
||||
@ -163,9 +157,6 @@ param. You can pass multiple package names at once. If no package name is
|
||||
provided, it will search for a <code>package.json</code> in the current folder and use
|
||||
the <code>name</code> property.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- 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>
|
||||
@ -175,16 +166,12 @@ the <code>name</code> property.</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="registry"><code>registry</code></h4>
|
||||
<ul>
|
||||
<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
|
||||
<li>Type: URL</li>
|
||||
</ul>
|
||||
<p>The base URL of the npm registry.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -204,8 +191,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -222,8 +207,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -234,9 +217,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-view.html">npm view</a></li>
|
||||
|
||||
12
deps/npm/docs/output/commands/npm-doctor.html
vendored
12
deps/npm/docs/output/commands/npm-doctor.html
vendored
@ -146,14 +146,8 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm doctor
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p><code>npm doctor</code> runs a set of checks to ensure that your npm installation has
|
||||
@ -229,18 +223,12 @@ located with <code>npm config get cache</code>). In the event that there are cor
|
||||
packages in your cache, you should probably run <code>npm cache clean -f</code> and
|
||||
reset the cache.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="registry"><code>registry</code></h4>
|
||||
<ul>
|
||||
<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
|
||||
<li>Type: URL</li>
|
||||
</ul>
|
||||
<p>The base URL of the npm registry.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-bugs.html">npm bugs</a></li>
|
||||
|
||||
12
deps/npm/docs/output/commands/npm-edit.html
vendored
12
deps/npm/docs/output/commands/npm-edit.html
vendored
@ -146,14 +146,8 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm edit <pkg>[/<subpkg>...]
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Selects a dependency in the current project and opens the package folder in
|
||||
@ -165,9 +159,6 @@ changes in compiled packages.</p>
|
||||
into your package, and then <code>npm edit connect</code> to make a few
|
||||
changes to your locally installed copy.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="editor"><code>editor</code></h4>
|
||||
<ul>
|
||||
<li>Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on
|
||||
@ -175,9 +166,6 @@ Windows, or 'vim' on Unix systems</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../configuring-npm/folders.html">npm folders</a></li>
|
||||
|
||||
20
deps/npm/docs/output/commands/npm-exec.html
vendored
20
deps/npm/docs/output/commands/npm-exec.html
vendored
@ -146,9 +146,6 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm exec -- <pkg>[@<version>] [args...]
|
||||
npm exec --package=<pkg>[@<version>] -- <cmd> [args...]
|
||||
npm exec -c '<cmd> [args...]'
|
||||
@ -156,9 +153,6 @@ npm exec --package=foo -c '<cmd> [args...]'
|
||||
|
||||
alias: x
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command allows you to run an arbitrary command from an npm package
|
||||
(either one installed locally, or fetched remotely), in a similar context
|
||||
@ -228,17 +222,12 @@ thus be equivalent to the <code>npx</code> command above:</p>
|
||||
<pre><code>$ npm exec -- foo@latest bar --package=@npmcli/foo
|
||||
</code></pre>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="package"><code>package</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
<li>Type: String (can be set multiple times)</li>
|
||||
</ul>
|
||||
<p>The package or packages to install for <a href="../commands/npm-exec.html"><code>npm exec</code></a></p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="call"><code>call</code></h4>
|
||||
<ul>
|
||||
<li>Default: ""</li>
|
||||
@ -248,8 +237,6 @@ thus be equivalent to the <code>npx</code> command above:</p>
|
||||
custom command to be run along with the installed packages.</p>
|
||||
<pre lang="bash"><code>npm exec --package yo --package generator-node --call "yo node"
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -269,8 +256,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -287,8 +272,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -299,9 +282,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="examples">Examples</h3>
|
||||
<p>Run the version of <code>tap</code> in the local dependencies, with the provided
|
||||
arguments:</p>
|
||||
|
||||
14
deps/npm/docs/output/commands/npm-explain.html
vendored
14
deps/npm/docs/output/commands/npm-explain.html
vendored
@ -146,16 +146,10 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm explain <package-spec>
|
||||
|
||||
alias: why
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command will print the chain of dependencies causing a given package
|
||||
to be installed in the current project.</p>
|
||||
@ -189,9 +183,6 @@ node_modules/nyc/node_modules/find-up
|
||||
dev tap@"^14.10.8" from the root project
|
||||
</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>
|
||||
@ -203,8 +194,6 @@ node_modules/nyc/node_modules/find-up
|
||||
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="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -224,9 +213,6 @@ workspaces within that folder)</li>
|
||||
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 -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../using-npm/package-spec.html">package spec</a></li>
|
||||
|
||||
12
deps/npm/docs/output/commands/npm-explore.html
vendored
12
deps/npm/docs/output/commands/npm-explore.html
vendored
@ -146,14 +146,8 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm explore <pkg> [ -- <command>]
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Spawn a subshell in the directory of the installed package specified.</p>
|
||||
@ -166,9 +160,6 @@ immediately terminates.</p>
|
||||
<p>Note that the package is <em>not</em> automatically rebuilt afterwards, so be
|
||||
sure to use <code>npm rebuild <pkg></code> if you make any changes.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="shell"><code>shell</code></h4>
|
||||
<ul>
|
||||
<li>Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on
|
||||
@ -176,9 +167,6 @@ Windows</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The shell to run for the <code>npm explore</code> command.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../configuring-npm/folders.html">npm folders</a></li>
|
||||
|
||||
@ -146,21 +146,12 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm find-dupes
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Runs <code>npm dedupe</code> in <code>--dry-run</code> mode, making npm only output the
|
||||
duplications, without actually changing the package tree.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global-style"><code>global-style</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -172,8 +163,6 @@ direct dependencies will show in <code>node_modules</code> and everything they d
|
||||
on will be flattened in their <code>node_modules</code> folders. This obviously will
|
||||
eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -183,8 +172,6 @@ will be preferred.</p>
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with <code>global-style</code> this option
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -201,8 +188,6 @@ the range set in their package's <code>peerDependencies</code> object.</p>
|
||||
<p>When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
|
||||
this warning is treated as a failure.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="package-lock"><code>package-lock</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -211,8 +196,6 @@ this warning is treated as a failure.</p>
|
||||
<p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
|
||||
will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
|
||||
<p>This configuration does not affect <code>npm ci</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="omit"><code>omit</code></h4>
|
||||
<ul>
|
||||
<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
|
||||
@ -227,8 +210,6 @@ physically installed on disk.</p>
|
||||
it will be included.</p>
|
||||
<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
|
||||
variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -239,8 +220,6 @@ variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
|
||||
will still run their intended script if <code>ignore-scripts</code> is set, but they
|
||||
will <em>not</em> run any pre- or post-scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="audit"><code>audit</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -250,8 +229,6 @@ will <em>not</em> run any pre- or post-scripts.</p>
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
|
||||
submitted.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="bin-links"><code>bin-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -262,8 +239,6 @@ executables.</p>
|
||||
<p>Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="fund"><code>fund</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -271,8 +246,6 @@ systems.</p>
|
||||
</ul>
|
||||
<p>When "true" displays the message at the end of each <code>npm install</code>
|
||||
acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -292,8 +265,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -310,8 +281,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -322,8 +291,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="install-links"><code>install-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -332,9 +299,6 @@ the specified workspaces, and not on the root project.</p>
|
||||
<p>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.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-dedupe.html">npm dedupe</a></li>
|
||||
|
||||
20
deps/npm/docs/output/commands/npm-fund.html
vendored
20
deps/npm/docs/output/commands/npm-fund.html
vendored
@ -146,14 +146,8 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm fund [<package-spec>]
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<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
|
||||
@ -193,9 +187,6 @@ test-workspaces-fund@1.0.0
|
||||
`-- 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>
|
||||
@ -207,8 +198,6 @@ test-workspaces-fund@1.0.0
|
||||
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>
|
||||
@ -218,8 +207,6 @@ saving them to your <code>package.json</code>.</li>
|
||||
<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,
|
||||
@ -228,8 +215,6 @@ as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</cod
|
||||
</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>
|
||||
@ -249,17 +234,12 @@ workspaces within that folder)</li>
|
||||
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="../using-npm/package-spec.html">package spec</a></li>
|
||||
|
||||
@ -146,14 +146,8 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm help-search <text>
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command will search the npm markdown documentation files for the terms
|
||||
@ -163,18 +157,12 @@ provided, and then list the results, sorted by relevance.</p>
|
||||
<code>help-search</code>. It is rarely if ever necessary to call this command
|
||||
directly.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="long"><code>long</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm.html">npm</a></li>
|
||||
|
||||
12
deps/npm/docs/output/commands/npm-help.html
vendored
12
deps/npm/docs/output/commands/npm-help.html
vendored
@ -146,16 +146,10 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm help <term> [<terms..>]
|
||||
|
||||
alias: hlep
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>If supplied a topic, then show the appropriate documentation page.</p>
|
||||
@ -164,9 +158,6 @@ will run the <code>help-search</code> command to find a match. Note that, if
|
||||
<code>help-search</code> finds a single subject, then it will run <code>help</code> on that
|
||||
topic, so unique matches are equivalent to specifying a topic name.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="viewer"><code>viewer</code></h4>
|
||||
<ul>
|
||||
<li>Default: "man" on Posix, "browser" on Windows</li>
|
||||
@ -174,9 +165,6 @@ topic, so unique matches are equivalent to specifying a topic name.</p>
|
||||
</ul>
|
||||
<p>The program to use to view help content.</p>
|
||||
<p>Set to <code>"browser"</code> to view html help content in the default web browser.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm.html">npm</a></li>
|
||||
|
||||
14
deps/npm/docs/output/commands/npm-hook.html
vendored
14
deps/npm/docs/output/commands/npm-hook.html
vendored
@ -146,17 +146,11 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm hook add <pkg> <url> <secret> [--type=<type>]
|
||||
npm hook ls [pkg]
|
||||
npm hook rm <id>
|
||||
npm hook update <id> <url> <secret>
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>Allows you to manage <a href="https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm">npm
|
||||
@ -197,17 +191,12 @@ the request came from your own configured hook.</p>
|
||||
<pre lang="bash"><code>$ npm hook rm id-deadbeef
|
||||
</code></pre>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="registry"><code>registry</code></h4>
|
||||
<ul>
|
||||
<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
|
||||
<li>Type: URL</li>
|
||||
</ul>
|
||||
<p>The base URL of the npm registry.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="otp"><code>otp</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -217,9 +206,6 @@ the request came from your own configured hook.</p>
|
||||
when publishing or changing package permissions with <code>npm access</code>.</p>
|
||||
<p>If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm">"Introducing Hooks" blog post</a></li>
|
||||
|
||||
24
deps/npm/docs/output/commands/npm-init.html
vendored
24
deps/npm/docs/output/commands/npm-init.html
vendored
@ -146,17 +146,11 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm init <package-spec> (same as `npx <package-spec>)
|
||||
npm init <@scope> (same as `npx <@scope>/create`)
|
||||
|
||||
aliases: create, innit
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p><code>npm init <initializer></code> can be used to set up a new or existing npm
|
||||
package.</p>
|
||||
@ -262,9 +256,6 @@ dot to represent the current directory in that context, e.g: <code>react-app .</
|
||||
`-- ...
|
||||
</code></pre>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="yes"><code>yes</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -272,8 +263,6 @@ dot to represent the current directory in that context, e.g: <code>react-app .</
|
||||
</ul>
|
||||
<p>Automatically answer "yes" to any prompts that npm might print on the
|
||||
command line.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="force"><code>force</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -299,8 +288,6 @@ range (including SemVer-major changes).</li>
|
||||
</ul>
|
||||
<p>If you don't have a clear idea of what you want to do, it is strongly
|
||||
recommended that you do not use this option!</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="scope"><code>scope</code></h4>
|
||||
<ul>
|
||||
<li>Default: the scope of the current project, if any, or ""</li>
|
||||
@ -322,8 +309,6 @@ installation of packages specified according to the pattern
|
||||
# instead of just named "whatever"
|
||||
npm init --scope=@foo --yes
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -343,8 +328,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -361,8 +344,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspaces-update"><code>workspaces-update</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -370,8 +351,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
</ul>
|
||||
<p>If set to true, the npm cli will run an update after operations that may
|
||||
possibly change the workspaces installed to the <code>node_modules</code> folder.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -382,9 +361,6 @@ possibly change the workspaces installed to the <code>node_modules</code> folder
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../using-npm/package-spec.html">package spec</a></li>
|
||||
|
||||
@ -146,22 +146,13 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm install-ci-test
|
||||
|
||||
alias: cit
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command runs <code>npm ci</code> followed immediately by <code>npm test</code>.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="save"><code>save</code></h4>
|
||||
<ul>
|
||||
<li>Default: <code>true</code> unless when using <code>npm update</code> where it defaults to <code>false</code></li>
|
||||
@ -171,8 +162,6 @@ alias: cit
|
||||
<p>When used with the <code>npm rm</code> command, removes the dependency from
|
||||
<code>package.json</code>.</p>
|
||||
<p>Will also prevent writing to <code>package-lock.json</code> if set to <code>false</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="save-exact"><code>save-exact</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -180,8 +169,6 @@ alias: cit
|
||||
</ul>
|
||||
<p>Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global"><code>global</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -196,8 +183,6 @@ of the current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global-style"><code>global-style</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -209,8 +194,6 @@ direct dependencies will show in <code>node_modules</code> and everything they d
|
||||
on will be flattened in their <code>node_modules</code> folders. This obviously will
|
||||
eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -220,8 +203,6 @@ will be preferred.</p>
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with <code>global-style</code> this option
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="omit"><code>omit</code></h4>
|
||||
<ul>
|
||||
<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
|
||||
@ -236,8 +217,6 @@ physically installed on disk.</p>
|
||||
it will be included.</p>
|
||||
<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
|
||||
variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -254,8 +233,6 @@ the range set in their package's <code>peerDependencies</code> object.</p>
|
||||
<p>When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
|
||||
this warning is treated as a failure.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="package-lock"><code>package-lock</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -264,8 +241,6 @@ this warning is treated as a failure.</p>
|
||||
<p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
|
||||
will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
|
||||
<p>This configuration does not affect <code>npm ci</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -276,8 +251,6 @@ scripts for installed packages in the foreground process, sharing standard
|
||||
input, output, and error with the main npm process.</p>
|
||||
<p>Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -288,8 +261,6 @@ but can be useful for debugging.</p>
|
||||
<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
|
||||
will still run their intended script if <code>ignore-scripts</code> is set, but they
|
||||
will <em>not</em> run any pre- or post-scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="audit"><code>audit</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -299,8 +270,6 @@ will <em>not</em> run any pre- or post-scripts.</p>
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
|
||||
submitted.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="bin-links"><code>bin-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -311,8 +280,6 @@ executables.</p>
|
||||
<p>Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="fund"><code>fund</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -320,8 +287,6 @@ systems.</p>
|
||||
</ul>
|
||||
<p>When "true" displays the message at the end of each <code>npm install</code>
|
||||
acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="dry-run"><code>dry-run</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -333,8 +298,6 @@ commands that modify your local installation, eg, <code>install</code>, <code>up
|
||||
<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
|
||||
<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
|
||||
<code>owner</code>, etc.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -354,8 +317,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -372,8 +333,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -384,8 +343,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="install-links"><code>install-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -394,9 +351,6 @@ the specified workspaces, and not on the root project.</p>
|
||||
<p>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.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-install-test.html">npm install-test</a></li>
|
||||
|
||||
@ -146,23 +146,14 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm install-test [<package-spec> ...]
|
||||
|
||||
alias: it
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command runs an <code>npm install</code> followed immediately by an <code>npm test</code>. It
|
||||
takes exactly the same arguments as <code>npm install</code>.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="save"><code>save</code></h4>
|
||||
<ul>
|
||||
<li>Default: <code>true</code> unless when using <code>npm update</code> where it defaults to <code>false</code></li>
|
||||
@ -172,8 +163,6 @@ takes exactly the same arguments as <code>npm install</code>.</p>
|
||||
<p>When used with the <code>npm rm</code> command, removes the dependency from
|
||||
<code>package.json</code>.</p>
|
||||
<p>Will also prevent writing to <code>package-lock.json</code> if set to <code>false</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="save-exact"><code>save-exact</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -181,8 +170,6 @@ takes exactly the same arguments as <code>npm install</code>.</p>
|
||||
</ul>
|
||||
<p>Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global"><code>global</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -197,8 +184,6 @@ of the current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global-style"><code>global-style</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -210,8 +195,6 @@ direct dependencies will show in <code>node_modules</code> and everything they d
|
||||
on will be flattened in their <code>node_modules</code> folders. This obviously will
|
||||
eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -221,8 +204,6 @@ will be preferred.</p>
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with <code>global-style</code> this option
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="omit"><code>omit</code></h4>
|
||||
<ul>
|
||||
<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
|
||||
@ -237,8 +218,6 @@ physically installed on disk.</p>
|
||||
it will be included.</p>
|
||||
<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
|
||||
variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -255,8 +234,6 @@ the range set in their package's <code>peerDependencies</code> object.</p>
|
||||
<p>When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
|
||||
this warning is treated as a failure.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="package-lock"><code>package-lock</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -265,8 +242,6 @@ this warning is treated as a failure.</p>
|
||||
<p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
|
||||
will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
|
||||
<p>This configuration does not affect <code>npm ci</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -277,8 +252,6 @@ scripts for installed packages in the foreground process, sharing standard
|
||||
input, output, and error with the main npm process.</p>
|
||||
<p>Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -289,8 +262,6 @@ but can be useful for debugging.</p>
|
||||
<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
|
||||
will still run their intended script if <code>ignore-scripts</code> is set, but they
|
||||
will <em>not</em> run any pre- or post-scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="audit"><code>audit</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -300,8 +271,6 @@ will <em>not</em> run any pre- or post-scripts.</p>
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
|
||||
submitted.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="bin-links"><code>bin-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -312,8 +281,6 @@ executables.</p>
|
||||
<p>Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="fund"><code>fund</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -321,8 +288,6 @@ systems.</p>
|
||||
</ul>
|
||||
<p>When "true" displays the message at the end of each <code>npm install</code>
|
||||
acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="dry-run"><code>dry-run</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -334,8 +299,6 @@ commands that modify your local installation, eg, <code>install</code>, <code>up
|
||||
<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
|
||||
<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
|
||||
<code>owner</code>, etc.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -355,8 +318,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -373,8 +334,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -385,8 +344,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="install-links"><code>install-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -395,9 +352,6 @@ the specified workspaces, and not on the root project.</p>
|
||||
<p>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.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-install.html">npm install</a></li>
|
||||
|
||||
46
deps/npm/docs/output/commands/npm-install.html
vendored
46
deps/npm/docs/output/commands/npm-install.html
vendored
@ -146,16 +146,10 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm install [<package-spec> ...]
|
||||
|
||||
aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command installs a package and any packages that it depends on. If the
|
||||
package has a package-lock, or an npm shrinkwrap file, or a yarn lock file,
|
||||
@ -486,9 +480,6 @@ even if a local copy exists on disk.</p>
|
||||
params have some effect on installation, since that's most of what npm
|
||||
does.</p>
|
||||
<p>These are some of the most common options related to installation.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="save"><code>save</code></h4>
|
||||
<ul>
|
||||
<li>Default: <code>true</code> unless when using <code>npm update</code> where it defaults to <code>false</code></li>
|
||||
@ -498,8 +489,6 @@ does.</p>
|
||||
<p>When used with the <code>npm rm</code> command, removes the dependency from
|
||||
<code>package.json</code>.</p>
|
||||
<p>Will also prevent writing to <code>package-lock.json</code> if set to <code>false</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="save-exact"><code>save-exact</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -507,8 +496,6 @@ does.</p>
|
||||
</ul>
|
||||
<p>Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global"><code>global</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -523,8 +510,6 @@ of the current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global-style"><code>global-style</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -536,8 +521,6 @@ direct dependencies will show in <code>node_modules</code> and everything they d
|
||||
on will be flattened in their <code>node_modules</code> folders. This obviously will
|
||||
eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -547,8 +530,6 @@ will be preferred.</p>
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with <code>global-style</code> this option
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="omit"><code>omit</code></h4>
|
||||
<ul>
|
||||
<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
|
||||
@ -563,8 +544,6 @@ physically installed on disk.</p>
|
||||
it will be included.</p>
|
||||
<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
|
||||
variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -581,8 +560,6 @@ the range set in their package's <code>peerDependencies</code> object.</p>
|
||||
<p>When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
|
||||
this warning is treated as a failure.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="package-lock"><code>package-lock</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -591,8 +568,6 @@ this warning is treated as a failure.</p>
|
||||
<p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
|
||||
will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
|
||||
<p>This configuration does not affect <code>npm ci</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -603,8 +578,6 @@ scripts for installed packages in the foreground process, sharing standard
|
||||
input, output, and error with the main npm process.</p>
|
||||
<p>Note that this will generally make installs run slower, and be much noisier,
|
||||
but can be useful for debugging.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -615,8 +588,6 @@ but can be useful for debugging.</p>
|
||||
<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
|
||||
will still run their intended script if <code>ignore-scripts</code> is set, but they
|
||||
will <em>not</em> run any pre- or post-scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="audit"><code>audit</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -626,8 +597,6 @@ will <em>not</em> run any pre- or post-scripts.</p>
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
|
||||
submitted.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="bin-links"><code>bin-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -638,8 +607,6 @@ executables.</p>
|
||||
<p>Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="fund"><code>fund</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -647,8 +614,6 @@ systems.</p>
|
||||
</ul>
|
||||
<p>When "true" displays the message at the end of each <code>npm install</code>
|
||||
acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="dry-run"><code>dry-run</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -660,8 +625,6 @@ commands that modify your local installation, eg, <code>install</code>, <code>up
|
||||
<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
|
||||
<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
|
||||
<code>owner</code>, etc.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -681,8 +644,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -699,8 +660,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -711,8 +670,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="install-links"><code>install-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -721,9 +678,6 @@ the specified workspaces, and not on the root project.</p>
|
||||
<p>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.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="algorithm">Algorithm</h3>
|
||||
<p>Given a <code>package{dep}</code> structure: <code>A{B,C}, B{C}, C{D}</code>,
|
||||
the npm install algorithm produces:</p>
|
||||
|
||||
44
deps/npm/docs/output/commands/npm-link.html
vendored
44
deps/npm/docs/output/commands/npm-link.html
vendored
@ -146,16 +146,10 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm link [<package-spec>]
|
||||
|
||||
alias: ln
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This is handy for installing your own stuff, so that you can work on it and
|
||||
test iteratively without having to continually rebuild.</p>
|
||||
@ -223,9 +217,6 @@ conflicting dependencies.</p>
|
||||
<p><code>npm link --workspace <name></code> will create a global link to the specified
|
||||
workspace(s).</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="save"><code>save</code></h4>
|
||||
<ul>
|
||||
<li>Default: <code>true</code> unless when using <code>npm update</code> where it defaults to <code>false</code></li>
|
||||
@ -235,8 +226,6 @@ workspace(s).</p>
|
||||
<p>When used with the <code>npm rm</code> command, removes the dependency from
|
||||
<code>package.json</code>.</p>
|
||||
<p>Will also prevent writing to <code>package-lock.json</code> if set to <code>false</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="save-exact"><code>save-exact</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -244,8 +233,6 @@ workspace(s).</p>
|
||||
</ul>
|
||||
<p>Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global"><code>global</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -260,8 +247,6 @@ of the current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global-style"><code>global-style</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -273,8 +258,6 @@ direct dependencies will show in <code>node_modules</code> and everything they d
|
||||
on will be flattened in their <code>node_modules</code> folders. This obviously will
|
||||
eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -284,8 +267,6 @@ will be preferred.</p>
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with <code>global-style</code> this option
|
||||
will be preferred.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -302,8 +283,6 @@ the range set in their package's <code>peerDependencies</code> object.</p>
|
||||
<p>When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
|
||||
this warning is treated as a failure.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="package-lock"><code>package-lock</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -312,8 +291,6 @@ this warning is treated as a failure.</p>
|
||||
<p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
|
||||
will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
|
||||
<p>This configuration does not affect <code>npm ci</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="omit"><code>omit</code></h4>
|
||||
<ul>
|
||||
<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
|
||||
@ -328,8 +305,6 @@ physically installed on disk.</p>
|
||||
it will be included.</p>
|
||||
<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
|
||||
variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -340,8 +315,6 @@ variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
|
||||
will still run their intended script if <code>ignore-scripts</code> is set, but they
|
||||
will <em>not</em> run any pre- or post-scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="audit"><code>audit</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -351,8 +324,6 @@ will <em>not</em> run any pre- or post-scripts.</p>
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
|
||||
submitted.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="bin-links"><code>bin-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -363,8 +334,6 @@ executables.</p>
|
||||
<p>Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="fund"><code>fund</code></h4>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
@ -372,8 +341,6 @@ systems.</p>
|
||||
</ul>
|
||||
<p>When "true" displays the message at the end of each <code>npm install</code>
|
||||
acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="dry-run"><code>dry-run</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -385,8 +352,6 @@ commands that modify your local installation, eg, <code>install</code>, <code>up
|
||||
<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
|
||||
<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
|
||||
<code>owner</code>, etc.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="workspace"><code>workspace</code></h4>
|
||||
<ul>
|
||||
<li>Default:</li>
|
||||
@ -406,8 +371,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -424,8 +387,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -436,8 +397,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="install-links"><code>install-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -446,9 +405,6 @@ the specified workspaces, and not on the root project.</p>
|
||||
<p>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.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../using-npm/package-spec.html">package spec</a></li>
|
||||
|
||||
14
deps/npm/docs/output/commands/npm-logout.html
vendored
14
deps/npm/docs/output/commands/npm-logout.html
vendored
@ -146,14 +146,8 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm logout
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<p>Note: This command is unaware of workspaces.</p>
|
||||
<h3 id="description">Description</h3>
|
||||
<p>When logged into a registry that supports token-based authentication, tell
|
||||
@ -165,17 +159,12 @@ In this case, it will <em>only</em> affect the current environment.</p>
|
||||
<p>If <code>--scope</code> is provided, this will find the credentials for the registry
|
||||
connected to that scope, if set.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="registry"><code>registry</code></h4>
|
||||
<ul>
|
||||
<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
|
||||
<li>Type: URL</li>
|
||||
</ul>
|
||||
<p>The base URL of the npm registry.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="scope"><code>scope</code></h4>
|
||||
<ul>
|
||||
<li>Default: the scope of the current project, if any, or ""</li>
|
||||
@ -197,9 +186,6 @@ installation of packages specified according to the pattern
|
||||
# instead of just named "whatever"
|
||||
npm init --scope=@foo --yes
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../commands/npm-adduser.html">npm adduser</a></li>
|
||||
|
||||
40
deps/npm/docs/output/commands/npm-ls.html
vendored
40
deps/npm/docs/output/commands/npm-ls.html
vendored
@ -146,16 +146,10 @@ npm command-line interface
|
||||
</section>
|
||||
|
||||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<pre lang="bash"><code>npm ls <package-spec>
|
||||
|
||||
alias: list
|
||||
</code></pre>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="description">Description</h3>
|
||||
<p>This command will print to stdout all the versions of packages that are
|
||||
installed, as well as their dependencies when <code>--all</code> is specified, in a
|
||||
@ -166,7 +160,7 @@ tree at all, use <a href="../commands/npm-explain.html"><code>npm explain</code>
|
||||
the results to only the paths to the packages named. Note that nested
|
||||
packages will <em>also</em> show the paths to the specified packages. For
|
||||
example, running <code>npm ls promzard</code> in npm's source tree will show:</p>
|
||||
<pre lang="bash"><code>npm@8.19.2 /path/to/npm
|
||||
<pre lang="bash"><code>npm@8.19.3 /path/to/npm
|
||||
└─┬ init-package-json@0.0.4
|
||||
└── promzard@0.1.5
|
||||
</code></pre>
|
||||
@ -199,9 +193,6 @@ provided.</p>
|
||||
of this command, is currently underway. Expect significant changes to at
|
||||
least the default human-readable <code>npm ls</code> output in npm v8.</p>
|
||||
<h3 id="configuration">Configuration</h3>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="all"><code>all</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -210,8 +201,6 @@ least the default human-readable <code>npm ls</code> output in npm v8.</p>
|
||||
<p>When running <code>npm outdated</code> and <code>npm ls</code>, setting <code>--all</code> will show all
|
||||
outdated or installed packages, rather than only those directly depended
|
||||
upon by the current project.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="json"><code>json</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -223,16 +212,12 @@ upon by the current project.</p>
|
||||
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="long"><code>long</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="parseable"><code>parseable</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -240,8 +225,6 @@ saving them to your <code>package.json</code>.</li>
|
||||
</ul>
|
||||
<p>Output parseable results from commands that write to standard output. For
|
||||
<code>npm search</code>, this will be tab-separated table format.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="global"><code>global</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -256,8 +239,6 @@ of the current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="depth"><code>depth</code></h4>
|
||||
<ul>
|
||||
<li>Default: <code>Infinity</code> if <code>--all</code> is set, otherwise <code>1</code></li>
|
||||
@ -266,8 +247,6 @@ of the current working directory.</li>
|
||||
<p>The depth to go when recursing packages for <code>npm ls</code>.</p>
|
||||
<p>If not set, <code>npm ls</code> will show only the immediate dependencies of the root
|
||||
project. If <code>--all</code> is set, then npm will show all dependencies by default.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="omit"><code>omit</code></h4>
|
||||
<ul>
|
||||
<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
|
||||
@ -282,16 +261,12 @@ physically installed on disk.</p>
|
||||
it will be included.</p>
|
||||
<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
|
||||
variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="link"><code>link</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Used with <code>npm ls</code>, limiting output to only those packages that are linked.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="package-lock-only"><code>package-lock-only</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -303,8 +278,6 @@ ignoring <code>node_modules</code>.</p>
|
||||
instead of checking <code>node_modules</code> and downloading dependencies.</p>
|
||||
<p>For <code>list</code> this means the output will be based on the tree described by the
|
||||
<code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</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,
|
||||
@ -313,8 +286,6 @@ as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</cod
|
||||
</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>
|
||||
@ -334,8 +305,6 @@ workspaces within that folder)</li>
|
||||
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="workspaces"><code>workspaces</code></h4>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
@ -352,8 +321,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
||||
</ul>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -364,8 +331,6 @@ other things (test, exec, publish, etc.) will operate on the root project,
|
||||
all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.</p>
|
||||
<p>This value is not exported to the environment for child processes.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h4 id="install-links"><code>install-links</code></h4>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
@ -374,9 +339,6 @@ the specified workspaces, and not on the root project.</p>
|
||||
<p>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.</p>
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<!-- raw HTML omitted -->
|
||||
<h3 id="see-also">See Also</h3>
|
||||
<ul>
|
||||
<li><a href="../using-npm/package-spec.html">package spec</a></li>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user