mirror of https://github.com/nodejs/node.git
deps: upgrade npm to 6.13.1
PR-URL: https://github.com/nodejs/node/pull/30533 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
This commit is contained in:
parent
a30a9f8193
commit
a7c7c703af
|
@ -1,3 +0,0 @@
|
|||
{
|
||||
"extends": "standard"
|
||||
}
|
|
@ -1,11 +1,13 @@
|
|||
*.swp
|
||||
.*.swp
|
||||
netlify.toml
|
||||
npm-debug.log
|
||||
/.github
|
||||
/test
|
||||
node_modules/marked
|
||||
node_modules/marked-man
|
||||
node_modules/tap
|
||||
tap-snapshots
|
||||
node_modules/.bin
|
||||
node_modules/npm-registry-mock
|
||||
/npmrc
|
||||
|
|
|
@ -667,3 +667,8 @@ Jason Etcovitch <jasonetco@github.com>
|
|||
Darcy Clarke <darcy@darcyclarke.me>
|
||||
orion <oletizi@mac.com>
|
||||
NoDocCat <nodoccat@outlook.com>
|
||||
joan xie <w4ergf@qq.com>
|
||||
Amal Hussein <amal@npmjs.com>
|
||||
Brett Zamir <brettz9@yahoo.com>
|
||||
Menelaos Kotsollaris <mkotsollaris@users.noreply.github.com>
|
||||
Mehdi Hasan Khan <mhasan@omicronlab.com>
|
||||
|
|
|
@ -1,3 +1,61 @@
|
|||
## 6.13.1 (2019-11-18)
|
||||
|
||||
### BUG FIXES
|
||||
|
||||
* [`938d6124d`](https://github.com/npm/cli/commit/938d6124d6d15d96b5a69d0ae32ef59fceb8ceab)
|
||||
[#472](https://github.com/npm/cli/pull/472)
|
||||
fix(fund): support funding string shorthand
|
||||
([@ruyadorno](https://github.com/ruyadorno))
|
||||
* [`b49c5535b`](https://github.com/npm/cli/commit/b49c5535b7c41729a8d167b035924c3c66b36de0)
|
||||
[#471](https://github.com/npm/cli/pull/471)
|
||||
should not publish tap-snapshot folder
|
||||
([@ruyadorno](https://github.com/ruyadorno))
|
||||
* [`3471d5200`](https://github.com/npm/cli/commit/3471d5200217bfa612b1a262e36c9c043a52eb09)
|
||||
[#253](https://github.com/npm/cli/pull/253)
|
||||
Add preliminary WSL support for npm and npx
|
||||
([@infinnie](https://github.com/infinnie))
|
||||
* [`3ef295f23`](https://github.com/npm/cli/commit/3ef295f23ee1b2300abf13ec19e935c47a455179)
|
||||
[#486](https://github.com/npm/cli/pull/486)
|
||||
print quick audit report for human output
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### TESTING
|
||||
|
||||
* [`dbbf977ac`](https://github.com/npm/cli/commit/dbbf977acd1e74bcdec859c562ea4a2bc0536442)
|
||||
[#278](https://github.com/npm/cli/pull/278)
|
||||
added workflow to trigger and run benchmarks
|
||||
([@mikemimik](https://github.com/mikemimik))
|
||||
* [`b4f5e3825`](https://github.com/npm/cli/commit/b4f5e3825535256aaada09c5e8f104570a3d96a4)
|
||||
[#457](https://github.com/npm/cli/pull/457)
|
||||
feat(docs): adding tests and updating docs to reflect changes in registry teams API.
|
||||
([@nomadtechie](https://github.com/nomadtechie))
|
||||
* [`454c7dd60`](https://github.com/npm/cli/commit/454c7dd60c78371bf606f11a17ed0299025bc37c)
|
||||
[#456](https://github.com/npm/cli/pull/456)
|
||||
fix git configs for git 2.23 and above
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### DOCUMENTATION
|
||||
|
||||
* [`b8c1576a4`](https://github.com/npm/cli/commit/b8c1576a448566397c721655b95fc90bf202b35a) [`30b013ae8`](https://github.com/npm/cli/commit/30b013ae8eacd04b1b8a41ce2ed0dd50c8ebae25) [`26c1b2ef6`](https://github.com/npm/cli/commit/26c1b2ef6be1595d28d935d35faa8ec72daae544) [`9f943a765`](https://github.com/npm/cli/commit/9f943a765faf6ebb8a442e862b808dbb630e018d) [`c0346b158`](https://github.com/npm/cli/commit/c0346b158fc25ab6ca9954d4dd78d9e62f573a41) [`8e09d5ad6`](https://github.com/npm/cli/commit/8e09d5ad67d4f142241193cecbce61c659389be3) [`4a2f551ee`](https://github.com/npm/cli/commit/4a2f551eeb3285f6f200534da33644789715a41a) [`87d67258c`](https://github.com/npm/cli/commit/87d67258c213d9ea9a49ce1804294a718f08ff13) [`5c3b32722`](https://github.com/npm/cli/commit/5c3b3272234764c8b4d2d798b69af077b5a529c7) [`b150eaeff`](https://github.com/npm/cli/commit/b150eaeff428180bfa03be53fd741d5625897758) [`7555a743c`](https://github.com/npm/cli/commit/7555a743ce4c3146d6245dd63f91503c7f439a6c) [`b89423e2f`](https://github.com/npm/cli/commit/b89423e2f6a09b290b15254e7ff7e8033b434d83)
|
||||
[#463](https://github.com/npm/cli/pull/463)
|
||||
[#285](https://github.com/npm/cli/pull/285)
|
||||
[#268](https://github.com/npm/cli/pull/268)
|
||||
[#232](https://github.com/npm/cli/pull/232)
|
||||
[#485](https://github.com/npm/cli/pull/485)
|
||||
[#453](https://github.com/npm/cli/pull/453)
|
||||
docs cleanup: typos, styling and content
|
||||
([@claudiahdz](https://github.com/claudiahdz))
|
||||
([@XhmikosR](https://github.com/XhmikosR))
|
||||
([@mugli](https://github.com/mugli))
|
||||
([@brettz9](https://github.com/brettz9))
|
||||
([@mkotsollaris](https://github.com/mkotsollaris))
|
||||
|
||||
### DEPENDENCIES
|
||||
|
||||
* [`661d86cd2`](https://github.com/npm/cli/commit/661d86cd229b14ddf687b7f25a66941a79d233e7)
|
||||
`make-fetch-happen@5.0.2`
|
||||
([@claudiahdz](https://github.com/claudiahdz))
|
||||
|
||||
## 6.13.0 (2019-11-05)
|
||||
|
||||
### NEW FEATURES
|
||||
|
|
|
@ -8,6 +8,10 @@ case `uname` in
|
|||
esac
|
||||
|
||||
NODE_EXE="$basedir/node.exe"
|
||||
if [ -x "$NODE_EXE" ] && [ -f "/bin/wslpath" ]; then # run the corresponding command prompt when Node for Windows is executed within WSL
|
||||
cmd.exe /c `wslpath -w "$basedir/npm.cmd"` "$@"
|
||||
exit $?
|
||||
fi
|
||||
if ! [ -x "$NODE_EXE" ]; then
|
||||
NODE_EXE="$basedir/node"
|
||||
fi
|
||||
|
|
|
@ -8,6 +8,10 @@ case `uname` in
|
|||
esac
|
||||
|
||||
NODE_EXE="$basedir/node.exe"
|
||||
if [ -x "$NODE_EXE" ] && [ -f "/bin/wslpath" ]; then # run the corresponding command prompt when Node for Windows is executed within WSL
|
||||
cmd.exe /c `wslpath -w "$basedir/npx.cmd"` "$@"
|
||||
exit $?
|
||||
fi
|
||||
if ! [ -x "$NODE_EXE" ]; then
|
||||
NODE_EXE=node
|
||||
fi
|
||||
|
|
|
@ -47,7 +47,7 @@ This is gonna be a much, MUCH smaller major version than 3.x was. Maybe even
|
|||
smaller than 2.x was. I can't tell you everything that'll be in there just
|
||||
yet, but at the very least it's going to have what's in our
|
||||
[4.x milestone](https://github.com/npm/npm/pulls?q=is%3Aopen+is%3Apr+milestone%3A4.x),
|
||||
PLUS, the first steps in
|
||||
PLUS, the first steps in
|
||||
[making `prepublish` work](https://github.com/npm/npm/issues/10074) the way
|
||||
people expect it to.
|
||||
|
||||
|
|
|
@ -225,7 +225,7 @@ as `https://` URLs instead of versions.
|
|||
zeros deleted resulted in authentication failures.
|
||||
([@iarna](https://github.com/iarna))
|
||||
* [`6eaa860ea`](https://github.com/npm/npm/commit/6eaa860ead3222a6dbd6d370b4271e7bf242b30b)
|
||||
Eliminate direct use of `new Buffer` in `npm`. While the use of it in `npm` was safe, there
|
||||
Eliminate direct use of `new Buffer` in `npm`. While the use of it in `npm` was safe, there
|
||||
are two other reasons for this change:
|
||||
|
||||
1. Node 10 emits warnings about its use.
|
||||
|
@ -341,7 +341,7 @@ and a handful of bug fixes! Let's get right in!
|
|||
|
||||
### NEW PACKAGE VIEW
|
||||
|
||||
There's a new `npm view` in town. You might it as `npm info` or `npm show`.
|
||||
There's a new `npm view` in town. You might it as `npm info` or `npm show`.
|
||||
The new output gives you a nicely summarized view that for most packages
|
||||
fits on one screen. If you ask it for `--json` you'll still get the same
|
||||
results, so your scripts should still work fine.
|
||||
|
@ -377,7 +377,7 @@ you can double check your `.npmignore` settings before doing a publish.
|
|||
### MERGE CONFLICT, SMERGE CONFLICT
|
||||
|
||||
If you resolve a `package-lock.json` merge conflict with `npm install` we
|
||||
now suggest you setup a merge driver to handle these automatically for you.
|
||||
now suggest you setup a merge driver to handle these automatically for you.
|
||||
If you're reading this and you'd like to set it up now, run:
|
||||
|
||||
```console
|
||||
|
|
|
@ -1,327 +0,0 @@
|
|||
npm-index(7) -- Index of all npm documentation
|
||||
==============================================
|
||||
|
||||
### README(1)
|
||||
|
||||
a JavaScript package manager
|
||||
|
||||
## Command Line Documentation
|
||||
|
||||
Using npm on the command line
|
||||
|
||||
### npm(1)
|
||||
|
||||
javascript package manager
|
||||
|
||||
### npm-access(1)
|
||||
|
||||
Set access level on published packages
|
||||
|
||||
### npm-adduser(1)
|
||||
|
||||
Add a registry user account
|
||||
|
||||
### npm-audit(1)
|
||||
|
||||
Run a security audit
|
||||
|
||||
### npm-bin(1)
|
||||
|
||||
Display npm bin folder
|
||||
|
||||
### npm-bugs(1)
|
||||
|
||||
Bugs for a package in a web browser maybe
|
||||
|
||||
### npm-build(1)
|
||||
|
||||
Build a package
|
||||
|
||||
### npm-bundle(1)
|
||||
|
||||
REMOVED
|
||||
|
||||
### npm-cache(1)
|
||||
|
||||
Manipulates packages cache
|
||||
|
||||
### npm-ci(1)
|
||||
|
||||
Install a project with a clean slate
|
||||
|
||||
### npm-completion(1)
|
||||
|
||||
Tab Completion for npm
|
||||
|
||||
### npm-config(1)
|
||||
|
||||
Manage the npm configuration files
|
||||
|
||||
### npm-dedupe(1)
|
||||
|
||||
Reduce duplication
|
||||
|
||||
### npm-deprecate(1)
|
||||
|
||||
Deprecate a version of a package
|
||||
|
||||
### npm-dist-tag(1)
|
||||
|
||||
Modify package distribution tags
|
||||
|
||||
### npm-docs(1)
|
||||
|
||||
Docs for a package in a web browser maybe
|
||||
|
||||
### npm-doctor(1)
|
||||
|
||||
Check your environments
|
||||
|
||||
### npm-edit(1)
|
||||
|
||||
Edit an installed package
|
||||
|
||||
### npm-explore(1)
|
||||
|
||||
Browse an installed package
|
||||
|
||||
### npm-fund(1)
|
||||
|
||||
Open package repository page in the browser
|
||||
|
||||
### npm-help-search(1)
|
||||
|
||||
Search npm help documentation
|
||||
|
||||
### npm-help(1)
|
||||
|
||||
Get help on npm
|
||||
|
||||
### npm-hook(1)
|
||||
|
||||
Manage registry hooks
|
||||
|
||||
### npm-init(1)
|
||||
|
||||
create a package.json file
|
||||
|
||||
### npm-install-ci-test(1)
|
||||
|
||||
Install a project with a clean slate and run tests
|
||||
|
||||
### npm-install-test(1)
|
||||
|
||||
Install package(s) and run tests
|
||||
|
||||
### npm-install(1)
|
||||
|
||||
Install a package
|
||||
|
||||
### npm-link(1)
|
||||
|
||||
Symlink a package folder
|
||||
|
||||
### npm-logout(1)
|
||||
|
||||
Log out of the registry
|
||||
|
||||
### npm-ls(1)
|
||||
|
||||
List installed packages
|
||||
|
||||
### npm-org(1)
|
||||
|
||||
Manage orgs
|
||||
|
||||
### npm-outdated(1)
|
||||
|
||||
Check for outdated packages
|
||||
|
||||
### npm-owner(1)
|
||||
|
||||
Manage package owners
|
||||
|
||||
### npm-pack(1)
|
||||
|
||||
Create a tarball from a package
|
||||
|
||||
### npm-ping(1)
|
||||
|
||||
Ping npm registry
|
||||
|
||||
### npm-prefix(1)
|
||||
|
||||
Display prefix
|
||||
|
||||
### npm-profile(1)
|
||||
|
||||
Change settings on your registry profile
|
||||
|
||||
### npm-prune(1)
|
||||
|
||||
Remove extraneous packages
|
||||
|
||||
### npm-publish(1)
|
||||
|
||||
Publish a package
|
||||
|
||||
### npm-rebuild(1)
|
||||
|
||||
Rebuild a package
|
||||
|
||||
### npm-repo(1)
|
||||
|
||||
Open package repository page in the browser
|
||||
|
||||
### npm-restart(1)
|
||||
|
||||
Restart a package
|
||||
|
||||
### npm-root(1)
|
||||
|
||||
Display npm root
|
||||
|
||||
### npm-run-script(1)
|
||||
|
||||
Run arbitrary package scripts
|
||||
|
||||
### npm-search(1)
|
||||
|
||||
Search for packages
|
||||
|
||||
### npm-shrinkwrap(1)
|
||||
|
||||
Lock down dependency versions for publication
|
||||
|
||||
### npm-star(1)
|
||||
|
||||
Mark your favorite packages
|
||||
|
||||
### npm-stars(1)
|
||||
|
||||
View packages marked as favorites
|
||||
|
||||
### npm-start(1)
|
||||
|
||||
Start a package
|
||||
|
||||
### npm-stop(1)
|
||||
|
||||
Stop a package
|
||||
|
||||
### npm-team(1)
|
||||
|
||||
Manage organization teams and team memberships
|
||||
|
||||
### npm-test(1)
|
||||
|
||||
Test a package
|
||||
|
||||
### npm-token(1)
|
||||
|
||||
Manage your authentication tokens
|
||||
|
||||
### npm-uninstall(1)
|
||||
|
||||
Remove a package
|
||||
|
||||
### npm-unpublish(1)
|
||||
|
||||
Remove a package from the registry
|
||||
|
||||
### npm-update(1)
|
||||
|
||||
Update a package
|
||||
|
||||
### npm-version(1)
|
||||
|
||||
Bump a package version
|
||||
|
||||
### npm-view(1)
|
||||
|
||||
View registry info
|
||||
|
||||
### npm-whoami(1)
|
||||
|
||||
Display npm username
|
||||
|
||||
## API Documentation
|
||||
|
||||
Using npm in your Node programs
|
||||
|
||||
## Files
|
||||
|
||||
File system structures npm uses
|
||||
|
||||
### npm-folders(5)
|
||||
|
||||
Folder Structures Used by npm
|
||||
|
||||
### npm-package-locks(5)
|
||||
|
||||
An explanation of npm lockfiles
|
||||
|
||||
### npm-shrinkwrap.json(5)
|
||||
|
||||
A publishable lockfile
|
||||
|
||||
### npmrc(5)
|
||||
|
||||
The npm config files
|
||||
|
||||
### package-lock.json(5)
|
||||
|
||||
A manifestation of the manifest
|
||||
|
||||
### package.json(5)
|
||||
|
||||
Specifics of npm's package.json handling
|
||||
|
||||
## Misc
|
||||
|
||||
Various other bits and bobs
|
||||
|
||||
### npm-coding-style(7)
|
||||
|
||||
npm's "funny" coding style
|
||||
|
||||
### npm-config(7)
|
||||
|
||||
More than you probably want to know about npm configuration
|
||||
|
||||
### npm-developers(7)
|
||||
|
||||
Developer Guide
|
||||
|
||||
### npm-disputes(7)
|
||||
|
||||
Handling Module Name Disputes
|
||||
|
||||
### npm-index(7)
|
||||
|
||||
Index of all npm documentation
|
||||
|
||||
### npm-orgs(7)
|
||||
|
||||
Working with Teams & Orgs
|
||||
|
||||
### npm-registry(7)
|
||||
|
||||
The JavaScript Package Registry
|
||||
|
||||
### npm-scope(7)
|
||||
|
||||
Scoped packages
|
||||
|
||||
### npm-scripts(7)
|
||||
|
||||
How npm handles the "scripts" field
|
||||
|
||||
### removing-npm(7)
|
||||
|
||||
Cleaning the Slate
|
||||
|
||||
### semver(7)
|
||||
|
||||
The semantic versioner for npm
|
||||
|
|
@ -19,3 +19,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: npm-access
|
|||
description: Set access level on published packages
|
||||
---
|
||||
|
||||
# npm-access
|
||||
# npm-access(1)
|
||||
|
||||
## Set access level on published packages
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: npm-adduser
|
|||
description: Set access level on published packages
|
||||
---
|
||||
|
||||
# npm-adduser
|
||||
# npm-adduser(1)
|
||||
|
||||
## Add a registry user account
|
||||
|
||||
|
@ -20,7 +20,7 @@ aliases: login, add-user
|
|||
|
||||
Create or verify a user named `<username>` in the specified registry, and
|
||||
save the credentials to the `.npmrc` file. If no registry is specified,
|
||||
the default registry will be used (see [`npm-config`](npm-config)).
|
||||
the default registry will be used (see [`config`](/using-npm/config)).
|
||||
|
||||
The username, password, and email are read in from prompts.
|
||||
|
||||
|
@ -43,19 +43,19 @@ Default: https://registry.npmjs.org/
|
|||
|
||||
The base URL of the npm package registry. If `scope` is also specified,
|
||||
this registry will only be used for packages with that scope. `scope` defaults
|
||||
to the scope of the project directory you're currently in, if any. See [`npm-scope`](/docs/using-npm/scope).
|
||||
to the scope of the project directory you're currently in, if any. See [`scope`](/using-npm/scope).
|
||||
|
||||
#### scope
|
||||
|
||||
Default: none
|
||||
|
||||
If specified, the user and login credentials given will be associated
|
||||
with the specified scope. See [`npm-scope`](/docs/using-npm/scope). You can use both at the same time,
|
||||
with the specified scope. See [`scope`](/using-npm/scope). You can use both at the same time,
|
||||
e.g.
|
||||
|
||||
```bash
|
||||
npm adduser --registry=http://myregistry.example.com --scope=@myco
|
||||
```
|
||||
```
|
||||
|
||||
This will set a registry for the given scope and login or create a user for
|
||||
that registry at the same time.
|
||||
|
@ -75,9 +75,7 @@ registries. Can be used with `--registry` and / or `--scope`, e.g.
|
|||
This will ensure that all requests to that registry (including for tarballs)
|
||||
include an authorization header. This setting may be necessary for use with
|
||||
private registries where metadata and package tarballs are stored on hosts with
|
||||
different hostnames. See `always-auth` in [`npm-config`](/docs/using-npm/config) for more details on
|
||||
always-auth. Registry-specific configuration of `always-auth` takes precedence
|
||||
over any global configuration.
|
||||
different hostnames. See `always-auth` in [`config`](/using-npm/config) for more details on always-auth. Registry-specific configuration of `always-auth` takes precedence over any global configuration.
|
||||
|
||||
#### auth-type
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-audit
|
||||
description: Run a security audit
|
||||
---
|
||||
|
||||
# npm-audit
|
||||
# npm-audit(1)
|
||||
|
||||
## Run a security audit
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-bin
|
||||
description: Display npm bin folder
|
||||
---
|
||||
|
||||
# npm-bin
|
||||
# npm-bin(1)
|
||||
|
||||
## Display npm bin folder
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-bugs
|
||||
description: Bugs for a package in a web browser maybe
|
||||
---
|
||||
|
||||
# npm-bugs
|
||||
# npm-bugs(1)
|
||||
|
||||
## Bugs for a package in a web browser maybe
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-build
|
||||
description: Build a package
|
||||
---
|
||||
|
||||
# npm-build
|
||||
# npm-build(1)
|
||||
|
||||
## Build a package
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-bundle
|
||||
description: REMOVED
|
||||
---
|
||||
|
||||
# npm-bundle
|
||||
# npm-bundle(1)
|
||||
|
||||
## REMOVED
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-cache
|
||||
description: Manipulates packages cache
|
||||
---
|
||||
|
||||
# npm-cache
|
||||
# npm-cache(1)
|
||||
|
||||
## Manipulates packages cache
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-ci
|
||||
description: Install a project with a clean slate
|
||||
---
|
||||
|
||||
# npm-ci
|
||||
# npm-ci(1)
|
||||
|
||||
## Install a project with a clean slate
|
||||
|
||||
|
@ -45,7 +45,7 @@ cache:
|
|||
|
||||
### Description
|
||||
|
||||
This command is similar to [`npm-install`](npm-install), except it's meant to be used in
|
||||
This command is similar to [`npm install`](/cli-commands/npm-install), except it's meant to be used in
|
||||
automated environments such as test platforms, continuous integration, and
|
||||
deployment -- or any situation where you want to make sure you're doing a clean
|
||||
install of your dependencies. It can be significantly faster than a regular npm
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-completion
|
||||
description: Tab Completion for npm
|
||||
---
|
||||
|
||||
# npm-completion
|
||||
# npm-completion(1)
|
||||
|
||||
## Tab Completion for npm
|
||||
|
||||
|
@ -28,8 +28,8 @@ npm completion >> ~/.zshrc
|
|||
```
|
||||
|
||||
You may of course also pipe the output of `npm completion` to a file
|
||||
such as `/usr/local/etc/bash_completion.d/npm` or
|
||||
`/etc/bash_completion.d/npm` if you have a system that will read
|
||||
such as `/usr/local/etc/bash_completion.d/npm` or
|
||||
`/etc/bash_completion.d/npm` if you have a system that will read
|
||||
that file for you.
|
||||
|
||||
When `COMP_CWORD`, `COMP_LINE`, and `COMP_POINT` are defined in the
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-config
|
||||
description: Manage the npm configuration files
|
||||
---
|
||||
|
||||
# npm-config
|
||||
# npm-config(1)
|
||||
|
||||
## Manage the npm configuration files
|
||||
|
||||
|
@ -26,9 +26,9 @@ aliases: c
|
|||
npm gets its config settings from the command line, environment
|
||||
variables, `npmrc` files, and in some cases, the `package.json` file.
|
||||
|
||||
See [npmrc](/docs/configuring-npm/npmrc) for more information about the npmrc files.
|
||||
See [npmrc](/configuring-npm/npmrc) for more information about the npmrc files.
|
||||
|
||||
See [config](/docs/using-npm/config) for a more thorough discussion of the mechanisms
|
||||
See [config](/using-npm/config) for a more thorough discussion of the mechanisms
|
||||
involved.
|
||||
|
||||
The `npm config` command can be used to update and edit the contents
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-dedupe
|
||||
description: Reduce duplication
|
||||
---
|
||||
|
||||
# npm-dedupe
|
||||
# npm-dedupe(1)
|
||||
|
||||
## Reduce duplication
|
||||
|
||||
|
@ -32,7 +32,7 @@ a
|
|||
`-- c@1.0.10
|
||||
```
|
||||
|
||||
In this case, `npm-dedupe` will transform the tree to:
|
||||
In this case, `npm dedupe` will transform the tree to:
|
||||
|
||||
```bash
|
||||
a
|
||||
|
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-deprecate
|
||||
description: Deprecate a version of a package
|
||||
---
|
||||
# npm-deprecate
|
||||
# npm-deprecate(1)
|
||||
|
||||
## Deprecate a version of a package
|
||||
|
||||
|
@ -17,7 +17,7 @@ npm deprecate <pkg>[@<version>] <message>
|
|||
This command will update the npm registry entry for a package, providing
|
||||
a deprecation warning to all who attempt to install it.
|
||||
|
||||
It works on [version ranges](https://semver.npmjs.com/) as well as specific
|
||||
It works on [version ranges](https://semver.npmjs.com/) as well as specific
|
||||
versions, so you can do something like this:
|
||||
```bash
|
||||
npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
|
||||
|
@ -26,8 +26,8 @@ npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
|
|||
Note that you must be the package owner to deprecate something. See the
|
||||
`owner` and `adduser` help topics.
|
||||
|
||||
To un-deprecate a package, specify an empty string (`""`) for the `message`
|
||||
argument. Note that you must use double quotes with no space between them to
|
||||
To un-deprecate a package, specify an empty string (`""`) for the `message`
|
||||
argument. Note that you must use double quotes with no space between them to
|
||||
format an empty string.
|
||||
|
||||
### See Also
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-dist-tag
|
||||
description: Modify package distribution tags
|
||||
---
|
||||
|
||||
# npm-dist-tag
|
||||
# npm-dist-tag(1)
|
||||
|
||||
## Modify package distribution tags
|
||||
|
||||
|
|
|
@ -1,14 +1,13 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-docs
|
||||
description: Docs for a package in a web browser maybe
|
||||
---
|
||||
|
||||
# npm-docs
|
||||
# npm-docs(1)
|
||||
|
||||
## Docs for a package in a web browser maybe
|
||||
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-doctor
|
||||
description: Check your environments
|
||||
---
|
||||
|
||||
# npm-doctor
|
||||
# npm-doctor(1)
|
||||
|
||||
## Check your environments
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-edit
|
||||
description: Edit an installed package
|
||||
---
|
||||
|
||||
# npm-edit
|
||||
# npm-edit(1)
|
||||
|
||||
## Edit an installed package
|
||||
|
||||
|
|
|
@ -1,12 +1,12 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-explore
|
||||
description: Browse an installed package
|
||||
---
|
||||
|
||||
# npm-explore
|
||||
# npm-explore(1)
|
||||
|
||||
## description: Browse an installed package
|
||||
## Browse an installed package
|
||||
|
||||
### Synopsis
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-fund
|
||||
description: Retrieve funding information
|
||||
---
|
||||
|
||||
# npm-fund
|
||||
# npm-fund(1)
|
||||
|
||||
## Retrieve funding information
|
||||
|
||||
|
@ -53,7 +53,8 @@ Set it to `false` in order to use all-ansi output.
|
|||
|
||||
## See Also
|
||||
|
||||
* [npm-docs](/cli-commands/npm-docs)
|
||||
* [npm-config](/cli-commands/npm-config)
|
||||
* [npm-install](/cli-commands/npm-install)
|
||||
* [npm-ls](/cli-commands/npm-ls)
|
||||
* [npm docs](/cli-commands/npm-docs)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [npm ls](/cli-commands/npm-ls)
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-help-search
|
||||
description: Search npm help documentation
|
||||
---
|
||||
|
||||
# npm-help-search
|
||||
# npm-help-search(1)
|
||||
|
||||
## Search npm help documentation
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-help
|
||||
description: Get help on npm
|
||||
---
|
||||
|
||||
# npm-help
|
||||
# npm-help(1)
|
||||
|
||||
## Get help on npm
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-hook
|
||||
description: Manage registry hooks
|
||||
---
|
||||
|
||||
# npm-hook
|
||||
# npm-hook(1)
|
||||
|
||||
## Manage registry hooks
|
||||
|
||||
|
@ -56,8 +56,7 @@ $ npm hook rm id-deadbeef
|
|||
|
||||
### Description
|
||||
|
||||
Allows you to manage [npm
|
||||
hooks](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm),
|
||||
Allows you to manage [npm hooks](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm),
|
||||
including adding, removing, listing, and updating.
|
||||
|
||||
Hooks allow you to configure URL endpoints that will be notified whenever a
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-init
|
||||
description: create a package.json file
|
||||
---
|
||||
|
||||
# npm-init
|
||||
# npm-init(1)
|
||||
|
||||
## create a package.json file
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-install-ci-test
|
||||
description: Install a project with a clean slate and run tests
|
||||
---
|
||||
|
||||
# npm install-ci-test
|
||||
# npm install-ci-test(1)
|
||||
|
||||
## Install a project with a clean slate and run tests
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-install-test
|
||||
description: Install package(s) and run tests
|
||||
---
|
||||
|
||||
# npm install-test
|
||||
# npm install-test(1)
|
||||
|
||||
## Install package(s) and run tests
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-install
|
||||
description: Install a package
|
||||
---
|
||||
|
||||
# npm-install
|
||||
# npm-install(1)
|
||||
|
||||
## Install a package
|
||||
|
||||
|
@ -16,6 +16,7 @@ npm install [<@scope>/]<name>
|
|||
npm install [<@scope>/]<name>@<tag>
|
||||
npm install [<@scope>/]<name>@<version>
|
||||
npm install [<@scope>/]<name>@<version range>
|
||||
npm install <alias>@npm:<name>
|
||||
npm install <git-host>:<git-user>/<repo-name>
|
||||
npm install <git repo url>
|
||||
npm install <tarball file>
|
||||
|
@ -31,15 +32,15 @@ common options: [-P|--save-prod|-D|--save-dev|-O|--save-optional] [-E|--save-exa
|
|||
This command installs a package, and any packages that it depends on. If the
|
||||
package has a package-lock or shrinkwrap file, the installation of dependencies
|
||||
will be driven by that, with an `npm-shrinkwrap.json` taking precedence if both
|
||||
files exist. See [package-lock.json](/docs/configuring-npm/package-lock.json) and [`npm-shrinkwrap`](npm-shrinkwrap).
|
||||
files exist. See [package-lock.json](/configuring-npm/package-lock-json) and [`npm shrinkwrap`](/cli-commands/npm-shrinkwrap).
|
||||
|
||||
A `package` is:
|
||||
|
||||
* a) a folder containing a program described by a [`package.json`](/docs/configuring-npm/package-json) file
|
||||
* a) a folder containing a program described by a [`package.json`](/configuring-npm/package-json) file
|
||||
* b) a gzipped tarball containing (a)
|
||||
* c) a url that resolves to (b)
|
||||
* d) a `<name>@<version>` that is published on the registry (see [`npm-registry`](npm-registry)) with (c)
|
||||
* e) a `<name>@<tag>` (see [`npm-dist-tag`](npm-dist-tag)) that points to (d)
|
||||
* d) a `<name>@<version>` that is published on the registry (see [`registry`](/using-npm/registry)) with (c)
|
||||
* e) a `<name>@<tag>` (see [`npm dist-tag`](/cli-commands/npm-dist-tag)) that points to (d)
|
||||
* f) a `<name>` that has a "latest" tag satisfying (e)
|
||||
* g) a `<git remote url>` that resolves to (a)
|
||||
|
||||
|
@ -58,11 +59,13 @@ after packing it up into a tarball (b).
|
|||
directory) as a global package.
|
||||
|
||||
By default, `npm install` will install all modules listed as dependencies
|
||||
in [`package.json`](/docs/configuring-npm/package-json).
|
||||
in [`package.json`](/configuring-npm/package-json).
|
||||
|
||||
With the `--production` flag (or when the `NODE_ENV` environment variable
|
||||
is set to `production`), npm will not install modules listed in
|
||||
`devDependencies`.
|
||||
`devDependencies`. To install all modules listed in both `dependencies`
|
||||
and `devDependencies` when `NODE_ENV` environment variable is set to `production`,
|
||||
you can use `--production=false`.
|
||||
|
||||
> NOTE: The `--production` flag has no particular meaning when adding a
|
||||
dependency to a project.
|
||||
|
@ -102,7 +105,7 @@ after packing it up into a tarball (b).
|
|||
* `npm install [<@scope>/]<name>`:
|
||||
|
||||
Do a `<name>@<tag>` install, where `<tag>` is the "tag" config. (See
|
||||
[`npm-config`](/docs/using-npm/config). The config's default value is `latest`.)
|
||||
[`config`](/using-npm/config). The config's default value is `latest`.)
|
||||
|
||||
In most cases, this will install the version of the modules tagged as
|
||||
`latest` on the npm registry.
|
||||
|
@ -111,6 +114,24 @@ after packing it up into a tarball (b).
|
|||
|
||||
npm install sax
|
||||
|
||||
* `npm install <alias>@npm:<name>`:
|
||||
|
||||
Install a package under a custom alias. Allows multiple versions of
|
||||
a same-name package side-by-side, more convenient import names for
|
||||
packages with otherwise long ones and using git forks replacements
|
||||
or forked npm packages as replacements. Aliasing works only on your
|
||||
project and does not rename packages in transitive dependencies.
|
||||
Aliases should follow the naming conventions stated in
|
||||
[`validate-npm-package-name`](https://www.npmjs.com/package/validate-npm-package-name#naming-rules).
|
||||
|
||||
Examples:
|
||||
|
||||
npm install my-react@npm:react
|
||||
npm install jquery2@npm:jquery@2
|
||||
npm install jquery3@npm:jquery@3
|
||||
npm install npa@npm:npm-package-arg
|
||||
|
||||
|
||||
`npm install` saves any specified packages into `dependencies` by default.
|
||||
Additionally, you can control where and how they get saved with some
|
||||
additional flags:
|
||||
|
@ -138,7 +159,7 @@ after packing it up into a tarball (b).
|
|||
|
||||
`<scope>` is optional. The package will be downloaded from the registry
|
||||
associated with the specified scope. If no registry is associated with
|
||||
the given scope the default registry is assumed. See [`npm-scope`](/docs/using-npm/scope).
|
||||
the given scope the default registry is assumed. See [`scope`](/using-npm/scope).
|
||||
|
||||
Note: if you do not include the @-symbol on your scope name, npm will
|
||||
interpret this as a GitHub repository instead, see below. Scopes names
|
||||
|
@ -188,7 +209,7 @@ after packing it up into a tarball (b).
|
|||
* `npm install [<@scope>/]<name>@<version range>`:
|
||||
|
||||
Install a version of the package matching the specified version range. This
|
||||
will follow the same rules for resolving dependencies described in [`package.json`](/docs/configuring-npm/package-json).
|
||||
will follow the same rules for resolving dependencies described in [`package.json`](/configuring-npm/package-json).
|
||||
|
||||
Note that most version ranges must be put in quotes so that your shell will
|
||||
treat it as a single argument.
|
||||
|
@ -266,7 +287,7 @@ after packing it up into a tarball (b).
|
|||
done installing.
|
||||
|
||||
Examples:
|
||||
|
||||
|
||||
```bash
|
||||
npm install mygithubuser/myproject
|
||||
npm install github:mygithubuser/myproject
|
||||
|
@ -283,7 +304,7 @@ after packing it up into a tarball (b).
|
|||
done installing.
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
```bash
|
||||
npm install gist:101a11beef
|
||||
```
|
||||
|
@ -305,7 +326,7 @@ after packing it up into a tarball (b).
|
|||
done installing.
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
```bash
|
||||
npm install bitbucket:mybitbucketuser/myproject
|
||||
```
|
||||
|
@ -327,7 +348,7 @@ after packing it up into a tarball (b).
|
|||
done installing.
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
```bash
|
||||
npm install gitlab:mygitlabuser/myproject
|
||||
npm install gitlab:myusr/myproj#semver:^5.0
|
||||
|
@ -358,11 +379,11 @@ npm install sax --force
|
|||
```
|
||||
|
||||
The `--no-fund` argument will hide the message displayed at the end of each
|
||||
install that aknowledges the number of dependencies looking for funding.
|
||||
install that acknowledges the number of dependencies looking for funding.
|
||||
See `npm-fund(1)`
|
||||
|
||||
The `-g` or `--global` argument will cause npm to install the package globally
|
||||
rather than locally. See [npm-folders](/docs/configuring-npm/folders).
|
||||
rather than locally. See [folders](/configuring-npm/folders).
|
||||
|
||||
The `--global-style` argument will cause npm to install the package into
|
||||
your local `node_modules` folder with the same layout it uses with the
|
||||
|
@ -371,7 +392,7 @@ global `node_modules` folder. Only your direct dependencies will show in
|
|||
`node_modules` folders. This obviously will eliminate some deduping.
|
||||
|
||||
The `--ignore-scripts` argument will cause npm to not execute any
|
||||
scripts defined in the package.json. See [`npm-scripts`](/docs/using-npm/scripts).
|
||||
scripts defined in the package.json. See [`scripts`](/using-npm/scripts).
|
||||
|
||||
The `--legacy-bundling` argument will cause npm to install the package such
|
||||
that versions of npm prior to 1.4, such as the one included with node 0.8,
|
||||
|
@ -402,7 +423,7 @@ The `--only={prod[uction]|dev[elopment]}` argument will cause either only
|
|||
The `--no-audit` argument can be used to disable sending of audit reports to
|
||||
the configured registries. See [`npm-audit`](npm-audit) for details on what is sent.
|
||||
|
||||
See [`npm-config`](/docs/using-npm/config). Many of the configuration params have some
|
||||
See [`config`](/using-npm/config). Many of the configuration params have some
|
||||
effect on installation, since that's most of what npm does.
|
||||
|
||||
#### Algorithm
|
||||
|
@ -450,8 +471,7 @@ privately for itself. This algorithm is deterministic, but different trees may
|
|||
be produced if two dependencies are requested for installation in a different
|
||||
order.
|
||||
|
||||
See [npm-folders](/docs/configuring-npm/folders) for a more detailed description of the specific
|
||||
folder structures that npm creates.
|
||||
See [folders](/configuring-npm/folders) for a more detailed description of the specific folder structures that npm creates.
|
||||
|
||||
### Limitations of npm's Install Algorithm
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-link
|
||||
description: Symlink a package folder
|
||||
---
|
||||
|
||||
# npm-link
|
||||
# npm-link(1)
|
||||
|
||||
## Symlink a package folder
|
||||
|
||||
|
@ -33,7 +33,7 @@ of the current folder.
|
|||
Note that `package-name` is taken from `package.json`,
|
||||
not from directory name.
|
||||
|
||||
The package name can be optionally prefixed with a scope. See [`npm-scope`](npm-scope).
|
||||
The package name can be optionally prefixed with a scope. See [`scope`](/using-npm/npm-scope).
|
||||
The scope must be preceded by an @-symbol and followed by a slash.
|
||||
|
||||
When creating tarballs for `npm publish`, the linked packages are
|
||||
|
@ -76,8 +76,7 @@ installation target into your project's `node_modules` folder.
|
|||
Note that in this case, you are referring to the directory name, `node-redis`,
|
||||
rather than the package name `redis`.
|
||||
|
||||
If your linked package is scoped (see [`npm-scope`](npm-scope)) your link command must
|
||||
include that scope, e.g.
|
||||
If your linked package is scoped (see [`scope`](/using-npm/npm-scope)) your link command must include that scope, e.g.
|
||||
|
||||
```bash
|
||||
npm link @myorg/privatepackage
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-logout
|
||||
description: Log out of the registry
|
||||
---
|
||||
|
||||
# npm-logout
|
||||
# npm-logout(1)
|
||||
|
||||
## Log out of the registry
|
||||
|
||||
|
@ -40,7 +40,7 @@ it takes precedence.
|
|||
|
||||
Default: The scope of your current project, if any, otherwise none.
|
||||
|
||||
If specified, you will be logged out of the specified scope. See [`npm-scope`](npm-scope).
|
||||
If specified, you will be logged out of the specified scope. See [`scope`](/using-npm/npm-scope).
|
||||
|
||||
```bash
|
||||
npm logout --scope=@myco
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-ls
|
||||
description: List installed packages
|
||||
---
|
||||
|
||||
# npm-ls
|
||||
# npm-ls(1)
|
||||
|
||||
## List installed packages
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-org
|
||||
description: Manage orgs
|
||||
---
|
||||
|
||||
# npm-org
|
||||
# npm-org(1)
|
||||
|
||||
## Manage orgs
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-outdated
|
||||
description: Check for outdated packages
|
||||
---
|
||||
|
||||
# npm-outdated
|
||||
# npm-outdated(1)
|
||||
|
||||
## Check for outdated packages
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-owner
|
||||
description: Manage package owners
|
||||
---
|
||||
|
||||
# npm-owner
|
||||
# npm-owner(1)
|
||||
## Manage package owners
|
||||
|
||||
### Synopsis
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-pack
|
||||
description: Create a tarball from a package
|
||||
---
|
||||
|
||||
# npm-pack
|
||||
# npm-pack(1)
|
||||
|
||||
## Create a tarball from a package
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-ping
|
||||
description: Ping npm registry
|
||||
---
|
||||
|
||||
# npm-ping
|
||||
# npm-ping(1)
|
||||
|
||||
## Ping npm registry
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-prefix
|
||||
description: Display prefix
|
||||
---
|
||||
|
||||
# npm-prefix
|
||||
# npm-prefix(1)
|
||||
|
||||
## Display prefix
|
||||
|
||||
|
@ -21,7 +21,7 @@ to contain a `package.json` file or `node_modules` directory, unless `-g` is
|
|||
also specified.
|
||||
|
||||
If `-g` is specified, this will be the value of the global prefix. See
|
||||
[`npm-config`](npm-config) for more detail.
|
||||
[`npm config`](/cli-commands/npm-config) for more detail.
|
||||
|
||||
### See Also
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-profile
|
||||
description: Change settings on your registry profile
|
||||
---
|
||||
|
||||
# npm-profile
|
||||
# npm-profile(1)
|
||||
## Change settings on your registry profile
|
||||
|
||||
### Synopsis
|
||||
|
@ -49,7 +49,7 @@ you're using a non-npmjs registry.
|
|||
| updated | 2017-10-02T21:29:45.922Z |
|
||||
+-----------------+---------------------------+
|
||||
```
|
||||
|
||||
|
||||
* `npm profile set <property> <value>`:
|
||||
Set the value of a profile property. You can set the following properties this way:
|
||||
email, fullname, homepage, freenode, twitter, github
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-prune
|
||||
description: Remove extraneous packages
|
||||
---
|
||||
|
||||
# npm-prune
|
||||
# npm-prune(1)
|
||||
## Remove extraneous packages
|
||||
|
||||
### Synopsis
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-publish
|
||||
description: Publish a package
|
||||
---
|
||||
|
||||
# npm-publish
|
||||
# npm-publish(1)
|
||||
|
||||
## Publish a package
|
||||
|
||||
|
@ -22,12 +22,10 @@ Publishes a package to the registry so that it can be installed by name. All
|
|||
files in the package directory are included if no local `.gitignore` or
|
||||
`.npmignore` file exists. If both files exist and a file is ignored by
|
||||
`.gitignore` but not by `.npmignore` then it will be included. See
|
||||
[`npm-developers`](/docs/using-npm/developers) for full details on what's included in the published
|
||||
package, as well as details on how the package is built.
|
||||
[`developers`](/using-npm/developers) for full details on what's included in the published package, as well as details on how the package is built.
|
||||
|
||||
By default npm will publish to the public registry. This can be overridden by
|
||||
specifying a different default registry or using a [`npm-scope`](npm-scope) in the name
|
||||
(see [`package.json`](/docs/configuring-npm/package-json)).
|
||||
specifying a different default registry or using a [`scope`](/using-npm/npm-scope) in the name (see [`package.json`](/configuring-npm/package-json)).
|
||||
|
||||
* `<folder>`:
|
||||
A folder containing a package.json file
|
||||
|
@ -62,13 +60,13 @@ the specified registry.
|
|||
|
||||
Once a package is published with a given name and version, that
|
||||
specific name and version combination can never be used again, even if
|
||||
it is removed with [`npm-unpublish`](npm-unpublish).
|
||||
it is removed with [`npm unpublish`](/cli-commands/npm-unpublish).
|
||||
|
||||
As of `npm@5`, both a sha1sum and an integrity field with a sha512sum of the
|
||||
tarball will be submitted to the registry during publication. Subsequent
|
||||
installs will use the strongest supported algorithm to verify downloads.
|
||||
|
||||
Similar to `--dry-run` see [`npm-pack`](npm-pack), which figures out the files to be
|
||||
Similar to `--dry-run` see [`npm pack`](/cli-commands/npm-pack), which figures out the files to be
|
||||
included and packs them into a tarball to be uploaded to the registry.
|
||||
|
||||
### See Also
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-rebuild
|
||||
description: Rebuild a package
|
||||
---
|
||||
|
||||
# npm-rebuildd
|
||||
# npm-rebuild(1)
|
||||
|
||||
## Rebuild a package
|
||||
|
||||
|
@ -18,9 +18,7 @@ alias: npm rb
|
|||
|
||||
### Description
|
||||
|
||||
This command runs the `npm build` command on the matched folders. This is useful
|
||||
when you install a new version of node, and must recompile all your C++ addons with
|
||||
the new binary.
|
||||
This command runs the `npm build` command on the matched folders. This is useful when you install a new version of node, and must recompile all your C++ addons with the new binary.
|
||||
|
||||
### See Also
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-repo
|
||||
description: Open package repository page in the browser
|
||||
---
|
||||
|
||||
# npm-repo
|
||||
# npm-repo(1)
|
||||
|
||||
## Open package repository page in the browser
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-restart
|
||||
description: Restart a package
|
||||
---
|
||||
|
||||
# npm-restart
|
||||
# npm-restart(1)
|
||||
|
||||
## Restart a package
|
||||
|
||||
|
@ -42,7 +42,7 @@ behavior will be accompanied by an increase in major version number
|
|||
### See Also
|
||||
|
||||
* [npm run-script](/cli-commands/npm-run-script)
|
||||
* [npm scripts](/cli-commands//docs/using-npm/scripts)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [npm test](/cli-commands/npm-test)
|
||||
* [npm start](/cli-commands/npm-start)
|
||||
* [npm stop](/cli-commands/npm-stop)
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-root
|
||||
description: Display npm root
|
||||
---
|
||||
|
||||
# npm-root
|
||||
# npm-root(1)
|
||||
|
||||
## Display npm root
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-run-script
|
||||
description: Run arbitrary package scripts
|
||||
---
|
||||
|
||||
# npm-run-script
|
||||
# npm-run-script(1)
|
||||
|
||||
## Run arbitrary package scripts
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-search
|
||||
description: Search for packages
|
||||
---
|
||||
|
||||
# npm-search
|
||||
# npm-search(1)
|
||||
|
||||
## Search for packages
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-shrinkwrap
|
||||
description: Lock down dependency versions for publication
|
||||
---
|
||||
|
||||
# npm-shrinkwrap
|
||||
# npm-shrinkwrap(1)
|
||||
|
||||
## Lock down dependency versions for publication
|
||||
|
||||
|
@ -20,7 +20,7 @@ This command repurposes `package-lock.json` into a publishable
|
|||
`npm-shrinkwrap.json` or simply creates a new one. The file created and updated
|
||||
by this command will then take precedence over any other existing or future
|
||||
`package-lock.json` files. For a detailed explanation of the design and purpose
|
||||
of package locks in npm, see [npm-package-locks](npm-package-locks).
|
||||
of package locks in npm, see [package-locks](/configuring-npm/package-locks).
|
||||
|
||||
### See Also
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-star
|
||||
description: Mark your favorite packages
|
||||
---
|
||||
|
||||
# npm-star
|
||||
# npm-star(1)
|
||||
|
||||
## Mark your favorite packages
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-stars
|
||||
description: View packages marked as favorites
|
||||
---
|
||||
|
||||
# npm-stars
|
||||
# npm-stars(1)
|
||||
|
||||
## View packages marked as favorites
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-start
|
||||
description: Start a package
|
||||
---
|
||||
|
||||
# npm-start
|
||||
# npm-start(1)
|
||||
|
||||
## Start a package
|
||||
|
||||
|
@ -21,8 +21,7 @@ its `"scripts"` object. If no `"start"` property is specified on the
|
|||
`"scripts"` object, it will run `node server.js`.
|
||||
|
||||
As of [`npm@2.0.0`](https://blog.npmjs.org/post/98131109725/npm-2-0-0), you can
|
||||
use custom arguments when executing scripts. Refer to [`npm-run-script`](npm-run-script) for
|
||||
more details.
|
||||
use custom arguments when executing scripts. Refer to [`npm run-script`](/cli-commands/npm-run-script) for more details.
|
||||
|
||||
### See Also
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-stop
|
||||
description: Stop a package
|
||||
---
|
||||
|
||||
# npm-stop
|
||||
# npm-stop(1)
|
||||
|
||||
## Stop a package
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-team
|
||||
description: Manage organization teams and team memberships
|
||||
---
|
||||
|
||||
# npm-team
|
||||
# npm-team(1)
|
||||
|
||||
## Manage organization teams and team memberships
|
||||
|
||||
|
@ -28,13 +28,10 @@ Used to manage teams in organizations, and change team memberships. Does not
|
|||
handle permissions for packages.
|
||||
|
||||
Teams must always be fully qualified with the organization/scope they belong to
|
||||
when operating on them, separated by a colon (`:`). That is, if you have a
|
||||
`developers` team on a `foo` organization, you must always refer to that team as
|
||||
`foo:developers` in these commands.
|
||||
when operating on them, separated by a colon (`:`). That is, if you have a `wombats` team in a `wisdom` organization, you must always refer to that team as `wisdom:wombats` in these commands.
|
||||
|
||||
* create / destroy:
|
||||
Create a new team, or destroy an existing one.
|
||||
|
||||
Create a new team, or destroy an existing one. Note: You cannot remove the `developers` team, <a href="https://docs.npmjs.com/about-developers-team" target="_blank">learn more.</a>
|
||||
* add / rm:
|
||||
Add a user to an existing team, or remove a user from a team they belong to.
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-test
|
||||
description: Test a package
|
||||
---
|
||||
|
||||
# npm-test
|
||||
# npm-test(1)
|
||||
|
||||
## Test a package
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-token
|
||||
description: Manage your authentication tokens
|
||||
---
|
||||
|
||||
# npm-token
|
||||
# npm-token(1)
|
||||
|
||||
## Manage your authentication tokens
|
||||
|
||||
|
@ -64,5 +64,5 @@ This lets you list, create and revoke authentication tokens.
|
|||
* `npm token revoke <token|id>`:
|
||||
This removes an authentication token, making it immediately unusable. This can accept
|
||||
both complete tokens (as you get back from `npm token create` and will
|
||||
find in your `.npmrc`) and ids as seen in the `npm token list` output.
|
||||
find in your `.npmrc`) and ids as seen in the `npm token list` output.
|
||||
This will NOT accept the truncated token found in `npm token list` output.
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-uninstall
|
||||
description: Remove a package
|
||||
---
|
||||
|
||||
# npm-uninstall
|
||||
# npm-uninstall(1)
|
||||
|
||||
## Remove a package
|
||||
|
||||
|
@ -44,7 +44,7 @@ the package version in your main package.json:
|
|||
Further, if you have an `npm-shrinkwrap.json` then it will be updated as
|
||||
well.
|
||||
|
||||
Scope is optional and follows the usual rules for [`npm-scope`](snpm-scope).
|
||||
Scope is optional and follows the usual rules for [`scope`](/using-npm/scope).
|
||||
|
||||
Examples:
|
||||
```bash
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-unpublish
|
||||
description: Remove a package from the registry
|
||||
---
|
||||
|
||||
# npm-unpublish
|
||||
# npm-unpublish(1)
|
||||
|
||||
## Remove a package from the registry
|
||||
|
||||
|
@ -43,7 +43,7 @@ only allowed with versions published in the last 72 hours. If you
|
|||
are trying to unpublish a version published longer ago than that,
|
||||
contact support@npmjs.com.
|
||||
|
||||
The scope is optional and follows the usual rules for [`npm-scope`](/docs/using-npm/scope).
|
||||
The scope is optional and follows the usual rules for [`scope`](/using-npm/scope).
|
||||
|
||||
### See Also
|
||||
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-update
|
||||
description: Update a package
|
||||
---
|
||||
|
||||
# npm-update
|
||||
# npm-update(1)
|
||||
|
||||
## Update a package
|
||||
|
||||
|
@ -35,8 +35,8 @@ As of `npm@2.6.1`, the `npm update` will only inspect top-level packages.
|
|||
Prior versions of `npm` would also recursively inspect all dependencies.
|
||||
To get the old behavior, use `npm --depth 9999 update`.
|
||||
|
||||
As of `npm@5.0.0`, the `npm update` will change `package.json` to save the
|
||||
new version as the minimum required dependency. To get the old behavior,
|
||||
As of `npm@5.0.0`, the `npm update` will change `package.json` to save the
|
||||
new version as the minimum required dependency. To get the old behavior,
|
||||
use `npm update --no-save`.
|
||||
|
||||
### Example
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-version
|
||||
description: Bump a package version
|
||||
---
|
||||
|
||||
# npm-version
|
||||
# npm-version(1)
|
||||
|
||||
## Bump a package version
|
||||
|
||||
|
@ -98,7 +98,7 @@ and tag up to the server, and deletes the `build/temp` directory.
|
|||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Prevents throwing an error when `npm version` is used to set the new version
|
||||
Prevents throwing an error when `npm version` is used to set the new version
|
||||
to the same value as the current version.
|
||||
|
||||
#### git-tag-version
|
||||
|
@ -129,6 +129,6 @@ Note that you must have a default GPG key set up in your git config for this to
|
|||
* [npm init](/cli-commands/npm-init)
|
||||
* [npm run-script](/cli-commands/npm-run-script)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [package.json](/docs/configuring-npm/package-json)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
* [semver](/using-npm/semver)
|
||||
* [config](/using-npm/config)
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-view
|
||||
description: View registry info
|
||||
---
|
||||
|
||||
# npm-view
|
||||
# npm-view(1)
|
||||
|
||||
## View registry info
|
||||
|
||||
|
@ -80,7 +80,7 @@ npm view express contributors.name contributors.email
|
|||
|
||||
"Person" fields are shown as a string if they would be shown as an
|
||||
object. So, for example, this will show the list of npm contributors in
|
||||
the shortened string format. (See [`package.json`](/docs/configuring-npm/package.json) for more on this.)
|
||||
the shortened string format. (See [`package.json`](/configuring-npm/package.json) for more on this.)
|
||||
|
||||
```bash
|
||||
npm view npm contributors
|
||||
|
@ -92,7 +92,7 @@ was required by each matching version of yui3:
|
|||
|
||||
```bash
|
||||
npm view yui3@'>0.5.4' dependencies.jsdom
|
||||
```
|
||||
```
|
||||
|
||||
To show the `connect` package version history, you can do
|
||||
this:
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm-whoami
|
||||
description: Display npm username
|
||||
---
|
||||
|
||||
# npm-whoami
|
||||
# npm-whoami(1)
|
||||
## Display npm username
|
||||
|
||||
### Synopsis
|
||||
|
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
section: cli-commands
|
||||
section: cli-commands
|
||||
title: npm
|
||||
description: javascript package manager
|
||||
---
|
||||
|
||||
# npm
|
||||
# npm(1)
|
||||
|
||||
## javascript package manager
|
||||
|
||||
### Synopsis
|
||||
|
@ -44,7 +45,7 @@ terms of use.
|
|||
You probably got npm because you want to install stuff.
|
||||
|
||||
Use `npm install blerg` to install the latest version of "blerg". Check out
|
||||
[`npm-install`](npm-install) for more info. It can do a lot of stuff.
|
||||
[`npm install`](/cli-commands/npm-install) for more info. It can do a lot of stuff.
|
||||
|
||||
Use the `npm search` command to show everything that's available.
|
||||
Use `npm ls` to show everything you've installed.
|
||||
|
@ -67,7 +68,7 @@ the [node-gyp Wiki](https://github.com/TooTallNate/node-gyp/wiki).
|
|||
|
||||
### Directories
|
||||
|
||||
See [`npm-folders`](/docs/configuring-npm/folders) to learn about where npm puts stuff.
|
||||
See [`folders`](/configuring-npm/folders) to learn about where npm puts stuff.
|
||||
|
||||
In particular, npm has two modes of operation:
|
||||
|
||||
|
@ -88,7 +89,7 @@ If you're using npm to develop and publish your code, check out the
|
|||
following help topics:
|
||||
|
||||
* json:
|
||||
Make a package.json file. See [`package.json`](/docs/configuring-npm/package.json).
|
||||
Make a package.json file. See [`package.json`](/configuring-npm/package.json).
|
||||
* link:
|
||||
For linking your current working code into Node's path, so that you
|
||||
don't have to reinstall every time you make a change. Use
|
||||
|
@ -129,7 +130,7 @@ npm is extremely configurable. It reads its configuration options from
|
|||
npm's default configuration options are defined in
|
||||
lib/utils/config-defs.js. These must not be changed.
|
||||
|
||||
See [`npm-config`](/docs/using-npm/config) for much much more information.
|
||||
See [`config`](/using-npm/config) for much much more information.
|
||||
|
||||
### Contributions
|
||||
|
||||
|
@ -139,8 +140,7 @@ If you would like to contribute, but don't know what to work on, read
|
|||
the contributing guidelines and check the issues list.
|
||||
|
||||
* [CONTRIBUTING.md](https://github.com/npm/cli/blob/latest/CONTRIBUTING.md)
|
||||
* [Bug tracker](https://npm.community/c/bugs)
|
||||
* [Support tracker](https://npm.community/c/support)
|
||||
* [Bug tracker](https://github.com/npm/cli/issues)
|
||||
|
||||
### Bugs
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: folders
|
|||
description: Folder Structures Used by npm
|
||||
---
|
||||
|
||||
# folders
|
||||
# folders(5)
|
||||
|
||||
## Folder Structures Used by npm
|
||||
|
||||
|
@ -49,8 +49,7 @@ Global installs on Windows go to `{prefix}/node_modules` (that is, no
|
|||
Scoped packages are installed the same way, except they are grouped together
|
||||
in a sub-folder of the relevant `node_modules` folder with the name of that
|
||||
scope prefix by the @ symbol, e.g. `npm install @myorg/package` would place
|
||||
the package in `{prefix}/node_modules/@myorg/package`. See [`scope`](/docs/using-npm/scope) for
|
||||
more details.
|
||||
the package in `{prefix}/node_modules/@myorg/package`. See [`scope`](/using-npm/scope) for more details.
|
||||
|
||||
If you wish to `require()` a package, then install it locally.
|
||||
|
||||
|
@ -74,7 +73,7 @@ Man pages are not installed on Windows systems.
|
|||
|
||||
#### Cache
|
||||
|
||||
See [`npm-cache`](/docs/cli-commands/npm-cache). Cache files are stored in `~/.npm` on Posix, or
|
||||
See [`npm cache`](/cli-commands/npm-cache). Cache files are stored in `~/.npm` on Posix, or
|
||||
`%AppData%/npm-cache` on Windows.
|
||||
|
||||
This is controlled by the `cache` configuration param.
|
||||
|
@ -210,7 +209,7 @@ not be included in the package tarball.
|
|||
|
||||
This allows a package maintainer to install all of their dependencies
|
||||
(and dev dependencies) locally, but only re-publish those items that
|
||||
cannot be found elsewhere. See [`package.json`](/docs/configuring-npm/package.json) for more information.
|
||||
cannot be found elsewhere. See [`package.json`](/configuring-npm/package.json) for more information.
|
||||
|
||||
### See also
|
||||
|
||||
|
|
|
@ -4,7 +4,11 @@ title: install
|
|||
description: Download and install node and npm
|
||||
---
|
||||
|
||||
# Download and Install npm
|
||||
# install(5)
|
||||
|
||||
## Download and Install npm
|
||||
|
||||
### Description
|
||||
|
||||
To publish and install packages to and from the public npm registry, you must install Node.js and the npm command line interface using either a Node version manager or a Node installer. **We strongly recommend using a Node version manager to install Node.js and npm.** We do not recommend using a Node installer, since the Node installation process installs npm in a directory with local permissions and can cause permissions errors when you run npm packages globally.
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: npmrc
|
|||
description: The npm config files
|
||||
---
|
||||
|
||||
# npmrc
|
||||
# npmrc(5)
|
||||
|
||||
## The npm config files
|
||||
|
||||
|
@ -16,7 +16,7 @@ variables, and `npmrc` files.
|
|||
The `npm config` command can be used to update and edit the contents
|
||||
of the user and global npmrc files.
|
||||
|
||||
For a list of available configuration options, see [npm-config](/docs/using-npm/config).
|
||||
For a list of available configuration options, see [config](/using-npm/config).
|
||||
|
||||
### Files
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: package.json
|
|||
description: Specifics of npm's package.json handling
|
||||
---
|
||||
|
||||
# package.json
|
||||
# package.json(5)
|
||||
|
||||
## Specifics of npm's package.json handling
|
||||
|
||||
|
@ -14,7 +14,7 @@ This document is all you need to know about what's required in your package.json
|
|||
file. It must be actual JSON, not just a JavaScript object literal.
|
||||
|
||||
A lot of the behavior described in this document is affected by the config
|
||||
settings described in [`npm-config`](/docs/using-npm/config).
|
||||
settings described in [`config`](/using-npm/config).
|
||||
|
||||
### name
|
||||
|
||||
|
@ -30,7 +30,7 @@ Some rules:
|
|||
|
||||
* The name must be less than or equal to 214 characters. This includes the scope for
|
||||
scoped packages.
|
||||
* The name can't start with a dot or an underscore.
|
||||
* The names of scoped packages can begin with a dot or an underscore. This is not permitted without a scope.
|
||||
* New packages must not have uppercase letters in the name.
|
||||
* The name ends up being part of a URL, an argument on the command line, and a
|
||||
folder name. Therefore, the name can't contain any non-URL-safe characters.
|
||||
|
@ -47,7 +47,7 @@ Some tips:
|
|||
already, before you get too attached to it. <https://www.npmjs.com/>
|
||||
|
||||
A name can be optionally prefixed by a scope, e.g. `@myorg/mypackage`. See
|
||||
[`npm-scope`](/docs/using-npm/scope) for more detail.
|
||||
[`scope`](/using-npm/scope) for more detail.
|
||||
|
||||
### version
|
||||
|
||||
|
@ -61,7 +61,7 @@ Version must be parseable by
|
|||
[node-semver](https://github.com/isaacs/node-semver), which is bundled
|
||||
with npm as a dependency. (`npm install semver` to use it yourself.)
|
||||
|
||||
More on version numbers and ranges at [semver](/docs/using-npm/semver).
|
||||
More on version numbers and ranges at [semver](/using-npm/semver).
|
||||
|
||||
### description
|
||||
|
||||
|
@ -469,7 +469,7 @@ The "scripts" property is a dictionary containing script commands that are run
|
|||
at various times in the lifecycle of your package. The key is the lifecycle
|
||||
event, and the value is the command to run at that point.
|
||||
|
||||
See [`npm-scripts`](/docs/using-npm/scripts) to find out more about writing package scripts.
|
||||
See [`scripts`](/using-npm/scripts) to find out more about writing package scripts.
|
||||
|
||||
### config
|
||||
|
||||
|
@ -486,7 +486,7 @@ and then had a "start" command that then referenced the
|
|||
`npm_package_config_port` environment variable, then the user could
|
||||
override that by doing `npm config set foo:port 8001`.
|
||||
|
||||
See [`npm-config`](/docs/using-npm/config) and [`npm-scripts`](/docs/using-npm/scripts) for more on package
|
||||
See [`config`](/using-npm/config) and [`scripts`](/using-npm/scripts) for more on package
|
||||
configs.
|
||||
|
||||
### dependencies
|
||||
|
@ -499,15 +499,15 @@ tarball or git URL.
|
|||
**Please do not put test harnesses or transpilers in your
|
||||
`dependencies` object.** See `devDependencies`, below.
|
||||
|
||||
See [semver](/docs/using-npm/semver) for more details about specifying version ranges.
|
||||
See [semver](/using-npm/semver) for more details about specifying version ranges.
|
||||
|
||||
* `version` Must match `version` exactly
|
||||
* `>version` Must be greater than `version`
|
||||
* `>=version` etc
|
||||
* `<version`
|
||||
* `<=version`
|
||||
* `~version` "Approximately equivalent to version" See [semver](/docs/using-npm/semver)
|
||||
* `^version` "Compatible with version" See [semver](/docs/using-npm/semver)
|
||||
* `~version` "Approximately equivalent to version" See [semver](/using-npm/semver)
|
||||
* `^version` "Compatible with version" See [semver](/using-npm/semver)
|
||||
* `1.2.x` 1.2.0, 1.2.1, etc., but not 1.3.0
|
||||
* `http://...` See 'URLs as Dependencies' below
|
||||
* `*` Matches any version
|
||||
|
@ -516,7 +516,7 @@ See [semver](/docs/using-npm/semver) for more details about specifying version r
|
|||
* `range1 || range2` Passes if either range1 or range2 are satisfied.
|
||||
* `git...` See 'Git URLs as Dependencies' below
|
||||
* `user/repo` See 'GitHub URLs' below
|
||||
* `tag` A specific version tagged and published as `tag` See [`npm-dist-tag`](/docs/cli-commands/npm-dist-tag)
|
||||
* `tag` A specific version tagged and published as `tag` See [`npm dist-tag`](/cli-commands/npm-dist-tag)
|
||||
* `path/path/path` See [Local Paths](#local-paths) below
|
||||
|
||||
For example, these are all valid:
|
||||
|
@ -632,7 +632,7 @@ object.
|
|||
|
||||
These things will be installed when doing `npm link` or `npm install`
|
||||
from the root of a package, and can be managed like any other npm
|
||||
configuration param. See [`npm-config`](/docs/using-npm/config) for more on the topic.
|
||||
configuration param. See [`config`](/using-npm/config) for more on the topic.
|
||||
|
||||
For build steps that are not platform-specific, such as compiling
|
||||
CoffeeScript or other languages to JavaScript, use the `prepare`
|
||||
|
@ -865,7 +865,7 @@ to the global public registry or that a scoped module is private by default.
|
|||
Any config values can be overridden, but only "tag", "registry" and "access"
|
||||
probably matter for the purposes of publishing.
|
||||
|
||||
See [`npm-config`](/docs/using-npm/config) to see the list of config options that can be
|
||||
See [`config`](/using-npm/config) to see the list of config options that can be
|
||||
overridden.
|
||||
|
||||
### DEFAULT VALUES
|
||||
|
|
|
@ -4,7 +4,7 @@ title: package-lock.json
|
|||
description: A manifestation of the manifest
|
||||
---
|
||||
|
||||
# package-lock.json
|
||||
# package-lock.json(5)
|
||||
|
||||
## A manifestation of the manifest
|
||||
|
||||
|
@ -28,7 +28,7 @@ various purposes:
|
|||
|
||||
One key detail about `package-lock.json` is that it cannot be published, and it
|
||||
will be ignored if found in any place other than the toplevel package. It shares
|
||||
a format with [npm-shrinkwrap.json](docs/configuring-npm/shrinkwrap-json), which is essentially the same file, but
|
||||
a format with [npm-shrinkwrap.json](/configuring-npm/shrinkwrap-json), which is essentially the same file, but
|
||||
allows publication. This is not recommended unless deploying a CLI tool or
|
||||
otherwise using the publication process for producing production packages.
|
||||
|
||||
|
|
|
@ -4,13 +4,13 @@ title: package-locks
|
|||
description: An explanation of npm lockfiles
|
||||
---
|
||||
|
||||
# package-locks
|
||||
# package-locks(5)
|
||||
|
||||
## An explanation of npm lockfiles
|
||||
|
||||
### Description
|
||||
|
||||
Conceptually, the "input" to [`npm-install`](/docs/cli-commands/npm-install) is a [package.json](/docs/configuring-npm/package-json), while its
|
||||
Conceptually, the "input" to [`npm install`](/cli-commands/npm-install) is a [package.json](/configuring-npm/package-json), while its
|
||||
"output" is a fully-formed `node_modules` tree: a representation of the
|
||||
dependencies you declared. In an ideal world, npm would work like a pure
|
||||
function: the same `package.json` should produce the exact same `node_modules`
|
||||
|
@ -83,8 +83,7 @@ author are not the same person, there's no way for A's author to say
|
|||
that he or she does not want to pull in newly published versions of C
|
||||
when B hasn't changed at all.
|
||||
|
||||
To prevent this potential issue, npm uses [package-lock.json](/docs/configuring-npm/package-lock-json) or, if present,
|
||||
[npm-shrinkwrap.json](shrinkwrap.json). These files are called package locks, or lockfiles.
|
||||
To prevent this potential issue, npm uses [package-lock.json](/configuring-npm/package-lock-json) or, if present, [npm-shrinkwrap.json](/configuring-npm/shrinkwrap-json). These files are called package locks, or lockfiles.
|
||||
|
||||
Whenever you run `npm install`, npm generates or updates your package lock,
|
||||
which will look something like this:
|
||||
|
@ -112,7 +111,7 @@ which will look something like this:
|
|||
This file describes an *exact*, and more importantly *reproducible*
|
||||
`node_modules` tree. Once it's present, any future installation will base its
|
||||
work off this file, instead of recalculating dependency versions off
|
||||
[package.json](/docs/configuring-npm/package-json).
|
||||
[package.json](/configuring-npm/package-json).
|
||||
|
||||
The presence of a package lock changes the installation behavior such that:
|
||||
|
||||
|
|
|
@ -4,13 +4,13 @@ title: shrinkwrap.json
|
|||
description: A publishable lockfile
|
||||
---
|
||||
|
||||
# npm-shrinkwrap.json
|
||||
# npm-shrinkwrap.json(5)
|
||||
|
||||
## A publishable lockfile
|
||||
|
||||
### Description
|
||||
|
||||
`npm-shrinkwrap.json` is a file created by [`npm-shrinkwrap`](/docs/cli-commands/npm-shrinkwrap). It is identical to
|
||||
`npm-shrinkwrap.json` is a file created by [`npm shrinkwrap`](/cli-commands/npm-shrinkwrap). It is identical to
|
||||
`package-lock.json`, with one major caveat: Unlike `package-lock.json`,
|
||||
`npm-shrinkwrap.json` may be included when publishing a package.
|
||||
|
||||
|
@ -24,7 +24,7 @@ Additionally, if both `package-lock.json` and `npm-shrinkwrap.json` are present
|
|||
in a package root, `package-lock.json` will be ignored in favor of this file.
|
||||
|
||||
For full details and description of the `npm-shrinkwrap.json` file format, refer
|
||||
to the manual page for [package-lock.json](/docs/configuring-npm/package-lock-json).
|
||||
to the manual page for [package-lock.json](/configuring-npm/package-lock-json).
|
||||
|
||||
### See also
|
||||
|
||||
|
|
|
@ -1,212 +0,0 @@
|
|||
---
|
||||
section: using-npm
|
||||
title: coding-style
|
||||
description: npm's "funny" coding style
|
||||
---
|
||||
|
||||
# coding-style
|
||||
## npm's "funny" coding style
|
||||
|
||||
### Description
|
||||
|
||||
npm's coding style is a bit unconventional. It is not different for
|
||||
difference's sake, but rather a carefully crafted style that is
|
||||
designed to reduce visual clutter and make bugs more apparent.
|
||||
|
||||
If you want to contribute to npm (which is very encouraged), you should
|
||||
make your code conform to npm's style.
|
||||
|
||||
Note: this concerns npm's code not the specific packages that you can download from the npm registry.
|
||||
|
||||
### Line Length
|
||||
|
||||
Keep lines shorter than 80 characters. It's better for lines to be
|
||||
too short than to be too long. Break up long lists, objects, and other
|
||||
statements onto multiple lines.
|
||||
|
||||
### Indentation
|
||||
|
||||
Two-spaces. Tabs are better, but they look like hell in web browsers
|
||||
(and on GitHub), and node uses 2 spaces, so that's that.
|
||||
|
||||
Configure your editor appropriately.
|
||||
|
||||
### Curly braces
|
||||
|
||||
Curly braces belong on the same line as the thing that necessitates them.
|
||||
|
||||
Bad:
|
||||
|
||||
```javascript
|
||||
function ()
|
||||
{
|
||||
```
|
||||
|
||||
Good:
|
||||
```javascript
|
||||
function () {
|
||||
```
|
||||
|
||||
If a block needs to wrap to the next line, use a curly brace. Don't
|
||||
use it if it doesn't.
|
||||
|
||||
Bad:
|
||||
|
||||
```javascript
|
||||
if (foo) { bar() }
|
||||
while (foo)
|
||||
bar()
|
||||
```
|
||||
Good:
|
||||
|
||||
```javascript
|
||||
if (foo) bar()
|
||||
while (foo) {
|
||||
bar()
|
||||
}
|
||||
```
|
||||
|
||||
### Semicolons
|
||||
|
||||
Don't use them except in four situations:
|
||||
|
||||
* `for (;;)` loops. They're actually required.
|
||||
* null loops like: `while (something) ;` (But you'd better have a good
|
||||
reason for doing that.)
|
||||
* `case 'foo': doSomething(); break`
|
||||
* In front of a leading `(` or `[` at the start of the line.
|
||||
This prevents the expression from being interpreted
|
||||
as a function call or property access, respectively.
|
||||
|
||||
Some examples of good semicolon usage:
|
||||
|
||||
```javascript
|
||||
;(x || y).doSomething()
|
||||
;[a, b, c].forEach(doSomething)
|
||||
for (var i = 0; i < 10; i ++) {
|
||||
switch (state) {
|
||||
case 'begin': start(); continue
|
||||
case 'end': finish(); break
|
||||
default: throw new Error('unknown state')
|
||||
}
|
||||
end()
|
||||
}
|
||||
```
|
||||
|
||||
Note that starting lines with `-` and `+` also should be prefixed
|
||||
with a semicolon, but this is much less common.
|
||||
|
||||
### Comma First
|
||||
|
||||
If there is a list of things separated by commas, and it wraps
|
||||
across multiple lines, put the comma at the start of the next
|
||||
line, directly below the token that starts the list. Put the
|
||||
final token in the list on a line by itself. For example:
|
||||
|
||||
```javascript
|
||||
var magicWords = [ 'abracadabra'
|
||||
, 'gesundheit'
|
||||
, 'ventrilo'
|
||||
]
|
||||
, spells = { 'fireball' : function () { setOnFire() }
|
||||
, 'water' : function () { putOut() }
|
||||
}
|
||||
, a = 1
|
||||
, b = 'abc'
|
||||
, etc
|
||||
, somethingElse
|
||||
```
|
||||
|
||||
### Quotes
|
||||
Use single quotes for strings except to avoid escaping.
|
||||
|
||||
Bad:
|
||||
|
||||
```javascript
|
||||
var notOk = "Just double quotes"
|
||||
```
|
||||
|
||||
Good:
|
||||
|
||||
```javascript
|
||||
var ok = 'String contains "double" quotes'
|
||||
var alsoOk = "String contains 'single' quotes or apostrophe"
|
||||
```
|
||||
|
||||
### Whitespace
|
||||
|
||||
Put a single space in front of `(` for anything other than a function call.
|
||||
Also use a single space wherever it makes things more readable.
|
||||
|
||||
Don't leave trailing whitespace at the end of lines. Don't indent empty
|
||||
lines. Don't use more spaces than are helpful.
|
||||
|
||||
### Functions
|
||||
|
||||
Use named functions. They make stack traces a lot easier to read.
|
||||
|
||||
### Callbacks, Sync/async Style
|
||||
|
||||
Use the asynchronous/non-blocking versions of things as much as possible.
|
||||
It might make more sense for npm to use the synchronous fs APIs, but this
|
||||
way, the fs and http and child process stuff all uses the same callback-passing
|
||||
methodology.
|
||||
|
||||
The callback should always be the last argument in the list. Its first
|
||||
argument is the Error or null.
|
||||
|
||||
Be very careful never to ever ever throw anything. It's worse than useless.
|
||||
Just send the error message back as the first argument to the callback.
|
||||
|
||||
### Errors
|
||||
|
||||
Always create a new Error object with your message. Don't just return a
|
||||
string message to the callback. Stack traces are handy.
|
||||
|
||||
### Logging
|
||||
|
||||
Logging is done using the [npmlog](https://github.com/npm/npmlog)
|
||||
utility.
|
||||
|
||||
Please clean up logs when they are no longer helpful. In particular,
|
||||
logging the same object over and over again is not helpful. Logs should
|
||||
report what's happening so that it's easier to track down where a fault
|
||||
occurs.
|
||||
|
||||
Use appropriate log levels. See [`npm-config`](/docs/using-npm/config) and search for
|
||||
"loglevel".
|
||||
|
||||
### Case, naming, etc.
|
||||
|
||||
Use `lowerCamelCase` for multiword identifiers when they refer to objects,
|
||||
functions, methods, properties, or anything not specified in this section.
|
||||
|
||||
Use `UpperCamelCase` for class names (things that you'd pass to "new").
|
||||
|
||||
Use `all-lower-hyphen-css-case` for multiword filenames and config keys.
|
||||
|
||||
Use named functions. They make stack traces easier to follow.
|
||||
|
||||
Use `CAPS_SNAKE_CASE` for constants, things that should never change
|
||||
and are rarely used.
|
||||
|
||||
Use a single uppercase letter for function names where the function
|
||||
would normally be anonymous, but needs to call itself recursively. It
|
||||
makes it clear that it's a "throwaway" function.
|
||||
|
||||
### null, undefined, false, 0
|
||||
|
||||
Boolean variables and functions should always be either `true` or
|
||||
`false`. Don't set it to 0 unless it's supposed to be a number.
|
||||
|
||||
When something is intentionally missing or removed, set it to `null`.
|
||||
|
||||
Don't set things to `undefined`. Reserve that value to mean "not yet
|
||||
set to anything."
|
||||
|
||||
Boolean objects are forbidden.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm developers](/using-npm/developers)
|
||||
* [npm](/cli-commands/npm)
|
|
@ -4,7 +4,7 @@ title: config
|
|||
description: More than you probably want to know about npm configuration
|
||||
---
|
||||
|
||||
# config
|
||||
# config(7)
|
||||
|
||||
## More than you probably want to know about npm configuration
|
||||
|
||||
|
@ -33,7 +33,7 @@ interpreted as a configuration parameter. For example, putting
|
|||
configuration parameter to `bar`. Any environment configurations that
|
||||
are not given a value will be given the value of `true`. Config
|
||||
values are case-insensitive, so `NPM_CONFIG_FOO=bar` will work the
|
||||
same. However, please note that inside [`npm-scripts`](/docs/using-npm/scripts)
|
||||
same. However, please note that inside [`scripts`](/using-npm/scripts)
|
||||
npm will set its own environment variables and Node will prefer
|
||||
those lowercase versions over any uppercase ones that you might set.
|
||||
For details see [this issue](https://github.com/npm/npm/issues/14528).
|
||||
|
@ -52,7 +52,7 @@ The four relevant files are:
|
|||
CLI option `--globalconfig` or environment variable `$NPM_CONFIG_GLOBALCONFIG`)
|
||||
* npm's built-in configuration file (`/path/to/npm/npmrc`)
|
||||
|
||||
See [npmrc](/docs/configuring-npm/npmrc) for more details.
|
||||
See [npmrc](/configuring-npm/npmrc) for more details.
|
||||
|
||||
#### Default Configs
|
||||
|
||||
|
@ -111,7 +111,7 @@ npm ls --global --parseable --long --loglevel info
|
|||
|
||||
### Per-Package Config Settings
|
||||
|
||||
When running scripts (see [`npm-scripts`](scripts)) the package.json "config"
|
||||
When running scripts (see [`scripts`](/using-npm/scripts)) the package.json "config"
|
||||
keys are overwritten in the environment if there is a config param of
|
||||
`<name>[@<version>]:<key>`. For example, if the package.json has
|
||||
this:
|
||||
|
@ -134,7 +134,7 @@ then the user could change the behavior by doing:
|
|||
npm config set foo:port 80
|
||||
```
|
||||
|
||||
See [package.json](/docs/configuring-npm/package-json) for more information.
|
||||
See [package.json](/configuring-npm/package-json) for more information.
|
||||
|
||||
### Config Settings
|
||||
|
||||
|
@ -179,7 +179,7 @@ When "dev" or "development" and running local `npm shrinkwrap`,
|
|||
|
||||
When "true" submit audit reports alongside `npm install` runs to the default
|
||||
registry and all registries configured for scopes. See the documentation
|
||||
for [`npm-audit`](/docs/cli-commands/npm-audit) for details on what is submitted.
|
||||
for [`npm audit`](/cli-commands/npm-audit) for details on what is submitted.
|
||||
|
||||
#### audit-level
|
||||
|
||||
|
@ -270,7 +270,7 @@ well as for the CA information to be stored in a file on disk.
|
|||
* Default: Windows: `%AppData%\npm-cache`, Posix: `~/.npm`
|
||||
* Type: path
|
||||
|
||||
The location of npm's cache directory. See [`npm-cache`](/docs/cli-commands/npm-cache)
|
||||
The location of npm's cache directory. See [`npm cache`](/cli-commands/npm-cache)
|
||||
|
||||
#### cache-lock-stale
|
||||
|
||||
|
@ -456,7 +456,7 @@ packages.
|
|||
|
||||
When "true" displays the message at the end of each `npm install`
|
||||
aknowledging the number of dependencies looking for funding.
|
||||
See [`npm-fund`](/docs/cli-commands/npm-fund) for details.
|
||||
See [`npm fund`](/cli-commands/npm-fund) for details.
|
||||
|
||||
#### git
|
||||
|
||||
|
@ -488,7 +488,7 @@ Run git commit hooks when using the `npm version` command.
|
|||
|
||||
Operates in "global" mode, so that packages are installed into the
|
||||
`prefix` folder instead of the current working directory. See
|
||||
[npm-folders](/docs/configuring-npm/folders) for more on the differences in behavior.
|
||||
[folders](/configuring-npm/folders) for more on the differences in behavior.
|
||||
|
||||
* packages are installed into the `{prefix}/lib/node_modules` folder, instead of the
|
||||
current working directory.
|
||||
|
@ -571,7 +571,7 @@ If true, npm does not run scripts specified in package.json files.
|
|||
A module that will be loaded by the `npm init` command. See the
|
||||
documentation for the
|
||||
[init-package-json](https://github.com/isaacs/init-package-json) module
|
||||
for more information, or [npm-init](/docs/cli-commands/npm-init).
|
||||
for more information, or [npm init](/cli-commands/npm-init).
|
||||
|
||||
#### init-author-name
|
||||
|
||||
|
@ -857,7 +857,7 @@ for updates immediately even for fresh package data.
|
|||
|
||||
#### prefix
|
||||
|
||||
* Default: see [npm-folders](/docs/configuring-npm/folders)
|
||||
* Default: see [folders](/configuring-npm/folders)
|
||||
* Type: path
|
||||
|
||||
The location to install global items. If set on the command line, then
|
||||
|
@ -1228,7 +1228,7 @@ version of npm than the latest.
|
|||
* Type: Boolean
|
||||
|
||||
Set to show short usage output (like the -H output)
|
||||
instead of complete help when doing [`npm-help`](/docs/cli-commands/npm-help).
|
||||
instead of complete help when doing [`npm help`](/cli-commands/npm-help).
|
||||
|
||||
#### user
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: developers
|
|||
description: Developer Guide
|
||||
---
|
||||
|
||||
# developers
|
||||
# developers(7)
|
||||
|
||||
## Developer Guide
|
||||
|
||||
|
@ -58,7 +58,7 @@ an argument to `git checkout`. The default is `master`.
|
|||
You need to have a `package.json` file in the root of your project to do
|
||||
much of anything with npm. That is basically the whole interface.
|
||||
|
||||
See [`package.json`](/docs/configuring-npm/package-json) for details about what goes in that file. At the very
|
||||
See [`package.json`](/configuring-npm/package-json) for details about what goes in that file. At the very
|
||||
least, you need:
|
||||
|
||||
* name:
|
||||
|
@ -87,7 +87,7 @@ least, you need:
|
|||
If you have a special compilation or installation script, then you
|
||||
should put it in the `scripts` object. You should definitely have at
|
||||
least a basic smoke-test command as the "scripts.test" field.
|
||||
See [npm-scripts](/docs/using-npm/scripts).
|
||||
See [scripts](/using-npm/scripts).
|
||||
|
||||
* main:
|
||||
If you have a single module that serves as the entry point to your
|
||||
|
@ -100,7 +100,7 @@ least, you need:
|
|||
they'll get installed just like these ones.
|
||||
|
||||
You can use `npm init` in the root of your package in order to get you
|
||||
started with a pretty basic package.json file. See [`npm-init`](/docs/cli-commands/npm-init) for
|
||||
started with a pretty basic package.json file. See [`npm init`](/cli-commands/npm-init) for
|
||||
more info.
|
||||
|
||||
### Keeping files *out* of your package
|
||||
|
@ -169,7 +169,7 @@ changes in real time without having to keep re-installing it. (You do
|
|||
need to either re-link or `npm rebuild -g` to update compiled packages,
|
||||
of course.)
|
||||
|
||||
More info at [`npm-link`](/docs/cli-commands/npm-link).
|
||||
More info at [`npm link`](/cli-commands/npm-link).
|
||||
|
||||
### Before Publishing: Make Sure Your Package Installs and Works
|
||||
|
||||
|
@ -217,7 +217,7 @@ npm adduser
|
|||
|
||||
and then follow the prompts.
|
||||
|
||||
This is documented better in [npm-adduser](/docs/cli-commands/npm-adduser).
|
||||
This is documented better in [npm adduser](/cli-commands/npm-adduser).
|
||||
|
||||
### Publish your package
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: disputes
|
|||
description: Handling Module Name Disputes
|
||||
---
|
||||
|
||||
# disputes
|
||||
# disputes(7)
|
||||
|
||||
## Handling Module Name Disputes
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: orgs
|
|||
description: Working with Teams & Orgs
|
||||
---
|
||||
|
||||
# orgs
|
||||
# orgs(7)
|
||||
|
||||
## Working with Teams & Orgs
|
||||
|
||||
|
@ -24,8 +24,8 @@ The developer will be able to access packages based on the teams they are on. Ac
|
|||
|
||||
There are two main commands:
|
||||
|
||||
1. `npm team` see [npm-team](/docs/cli-commands/npm-team) for more details
|
||||
2. `npm access` see [npm-access](/docs/cli-commands/npm-access) for more details
|
||||
1. `npm team` see [npm team](/cli-commands/npm-team) for more details
|
||||
2. `npm access` see [npm access](/cli-commands/npm-access) for more details
|
||||
|
||||
### Team Admins create teams
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: registry
|
|||
description: The JavaScript Package Registry
|
||||
---
|
||||
|
||||
# registry
|
||||
# registry(7)
|
||||
|
||||
## The JavaScript Package Registry
|
||||
|
||||
|
@ -32,9 +32,9 @@ of which there is a public mirror at
|
|||
available at <https://github.com/npm/npm-registry-couchapp>.
|
||||
|
||||
The registry URL used is determined by the scope of the package (see
|
||||
[`npm-scope`](scope). If no scope is specified, the default registry is used, which is
|
||||
supplied by the `registry` config parameter. See [`npm-config`](/docs/cli-commands/npm-config),
|
||||
[`npmrc`](/docs/configuring-npm/npmrc), and [`npm-config`](/docs/using-npm/config) for more on managing npm's configuration.
|
||||
[`scope`](/using-npm/scope). If no scope is specified, the default registry is used, which is
|
||||
supplied by the `registry` config parameter. See [`npm config`](/cli-commands/npm-config),
|
||||
[`npmrc`](/configuring-npm/npmrc), and [`config`](/using-npm/config) for more on managing npm's configuration.
|
||||
|
||||
### Does npm send any information about me back to the registry?
|
||||
|
||||
|
@ -81,7 +81,7 @@ published at all, or
|
|||
`"publishConfig":{"registry":"http://my-internal-registry.local"}`
|
||||
to force it to be published only to your internal registry.
|
||||
|
||||
See [`package.json`](/docs/configuring-npm/package-json) for more info on what goes in the package.json file.
|
||||
See [`package.json`](/configuring-npm/package-json) for more info on what goes in the package.json file.
|
||||
|
||||
### Will you replicate from my registry into the public one?
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: removal
|
|||
description: Cleaning the Slate
|
||||
---
|
||||
|
||||
# removal
|
||||
# removal(7)
|
||||
|
||||
## Cleaning the Slate
|
||||
|
||||
|
@ -66,6 +66,5 @@ find /usr/local/{lib/node,bin} -exec grep -l npm \{\} \; ;
|
|||
|
||||
### See also
|
||||
|
||||
* README
|
||||
* [npm uninstall](/cli-commands/npm-uninstall)
|
||||
* [npm prune](/cli-commands/npm-prune)
|
||||
|
|
|
@ -3,7 +3,7 @@ section: using-npm
|
|||
title: scope
|
||||
description: Scoped packages
|
||||
---
|
||||
# scope
|
||||
# scope(7)
|
||||
|
||||
## Scoped packages
|
||||
|
||||
|
@ -55,7 +55,7 @@ Or in `package.json`:
|
|||
```
|
||||
|
||||
Note that if the `@` symbol is omitted, in either case, npm will instead attempt to
|
||||
install from GitHub; see [`npm-install`](/docs/cli-commands/npm-install).
|
||||
install from GitHub; see [`npm install`](/cli-commands/npm-install).
|
||||
|
||||
### Requiring scoped packages
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: scripts
|
|||
description: How npm handles the "scripts" field
|
||||
---
|
||||
|
||||
# scripts
|
||||
# scripts(7)
|
||||
|
||||
## How npm handles the "scripts" field
|
||||
|
||||
|
@ -13,7 +13,7 @@ description: How npm handles the "scripts" field
|
|||
npm supports the "scripts" property of the package.json file, for the
|
||||
following scripts:
|
||||
|
||||
* **prepublish**:
|
||||
* **prepublish** (_as of npm@5, `prepublish` is deprecated. Use `prepare` for build steps and `prepublishOnly` for upload-only._):
|
||||
Run BEFORE the package is packed and published, as well as on local `npm
|
||||
install` without any arguments. (See below)
|
||||
* **prepare**:
|
||||
|
@ -59,7 +59,7 @@ following scripts:
|
|||
Additionally, arbitrary scripts can be executed by running `npm
|
||||
run-script <stage>`. *Pre* and *post* commands with matching
|
||||
names will be run for those as well (e.g. `premyscript`, `myscript`,
|
||||
`postmyscript`). Scripts from dependencies can be run with
|
||||
`postmyscript`). Scripts from dependencies can be run with
|
||||
`npm explore <pkg> -- npm run <stage>`.
|
||||
|
||||
#### Prepublish and Prepare
|
||||
|
@ -152,8 +152,8 @@ The package.json fields are tacked onto the `npm_package_` prefix. So,
|
|||
for instance, if you had `{"name":"foo", "version":"1.2.5"}` in your
|
||||
package.json file, then your package scripts would have the
|
||||
`npm_package_name` environment variable set to "foo", and the
|
||||
`npm_package_version` set to "1.2.5". You can access these variables
|
||||
in your code with `process.env.npm_package_name` and
|
||||
`npm_package_version` set to "1.2.5". You can access these variables
|
||||
in your code with `process.env.npm_package_name` and
|
||||
`process.env.npm_package_version`, and so on for other fields.
|
||||
|
||||
#### configuration
|
||||
|
@ -265,7 +265,7 @@ above.
|
|||
only will prevent some optional features, then it's better to just
|
||||
print a warning and exit successfully.
|
||||
* Try not to use scripts to do what npm can do for you. Read through
|
||||
[`package.json`](/docs/configuring-npm/package-json) to see all the things that you can specify and enable
|
||||
[`package.json`](/configuring-npm/package-json) to see all the things that you can specify and enable
|
||||
by simply describing your package appropriately. In general, this
|
||||
will lead to a more robust and consistent state.
|
||||
* Inspect the env to determine where to put things. For instance, if
|
||||
|
|
|
@ -1,10 +1,8 @@
|
|||
import React from 'react'
|
||||
import Layout from './src/components/layout'
|
||||
require('prismjs/themes/prism-tomorrow.css')
|
||||
require('./src/main.css')
|
||||
|
||||
/**
|
||||
* Implement Gatsby's Browser APIs in this file.
|
||||
*
|
||||
* See: https://www.gatsbyjs.org/docs/browser-apis/
|
||||
*/
|
||||
|
||||
// You can delete this file if you're not using it
|
||||
export const wrapPageElement = ({ element, props }) => {
|
||||
return <Layout {...props} >{element}</Layout>
|
||||
}
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
module.exports = {
|
||||
pathPrefix: `${__dirname}/public`,
|
||||
const IS_STATIC = process.env.GATSBY_IS_STATIC
|
||||
|
||||
const OPTS = {
|
||||
siteMetadata: {
|
||||
title: 'npm cli documentation',
|
||||
description: 'Documentation for the npm cli.',
|
||||
|
@ -86,3 +87,10 @@ module.exports = {
|
|||
}
|
||||
]
|
||||
}
|
||||
|
||||
const STATIC_OPTS = Object.assign({}, OPTS, {
|
||||
pathPrefix: '__GATSBY_IPFS_PATH_PREFIX__',
|
||||
plugins: OPTS.plugins.concat(['gatsby-plugin-ipfs'])
|
||||
})
|
||||
|
||||
module.exports = IS_STATIC ? STATIC_OPTS : OPTS
|
||||
|
|
|
@ -0,0 +1,6 @@
|
|||
import React from 'react'
|
||||
import Layout from './src/components/layout'
|
||||
|
||||
export const wrapPageElement = ({ element, props }) => {
|
||||
return <Layout {...props} >{element}</Layout>
|
||||
}
|
|
@ -7583,6 +7583,47 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"gatsby-plugin-ipfs": {
|
||||
"version": "2.0.2",
|
||||
"resolved": "https://registry.npmjs.org/gatsby-plugin-ipfs/-/gatsby-plugin-ipfs-2.0.2.tgz",
|
||||
"integrity": "sha512-Igh4K0axPzfvmP8T0w5Vvo789HTaaC0XHTkHG18jTkwW04J5TV+YPULCxVqRRCGL4cEJgpLuX9TR9iCgEu5igA==",
|
||||
"requires": {
|
||||
"globby": "^8.0.1",
|
||||
"is-text-path": "^1.0.1",
|
||||
"p-map": "^2.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"globby": {
|
||||
"version": "8.0.2",
|
||||
"resolved": "https://registry.npmjs.org/globby/-/globby-8.0.2.tgz",
|
||||
"integrity": "sha512-yTzMmKygLp8RUpG1Ymu2VXPSJQZjNAZPD4ywgYEaG7e4tBJeUQBO8OpXrf1RCNcEs5alsoJYPAMiIHP0cmeC7w==",
|
||||
"requires": {
|
||||
"array-union": "^1.0.1",
|
||||
"dir-glob": "2.0.0",
|
||||
"fast-glob": "^2.0.2",
|
||||
"glob": "^7.1.2",
|
||||
"ignore": "^3.3.5",
|
||||
"pify": "^3.0.0",
|
||||
"slash": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"ignore": {
|
||||
"version": "3.3.10",
|
||||
"resolved": "https://registry.npmjs.org/ignore/-/ignore-3.3.10.tgz",
|
||||
"integrity": "sha512-Pgs951kaMm5GXP7MOvxERINe3gsaVjUWFm+UZPSq9xYriQAksyhg0csnS0KXSNRD5NmNdapXEpjxG49+AKh/ug=="
|
||||
},
|
||||
"p-map": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/p-map/-/p-map-2.1.0.tgz",
|
||||
"integrity": "sha512-y3b8Kpd8OAN444hxfBbFfj1FY/RjtTd8tzYwhUqNYXx0fXx2iX4maP4Qr6qhIKbQXI02wTLAda4fYUbDagTUFw=="
|
||||
},
|
||||
"pify": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz",
|
||||
"integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY="
|
||||
}
|
||||
}
|
||||
},
|
||||
"gatsby-plugin-manifest": {
|
||||
"version": "2.2.6",
|
||||
"resolved": "https://registry.npmjs.org/gatsby-plugin-manifest/-/gatsby-plugin-manifest-2.2.6.tgz",
|
||||
|
@ -9967,6 +10008,14 @@
|
|||
"has-symbols": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"is-text-path": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/is-text-path/-/is-text-path-1.0.1.tgz",
|
||||
"integrity": "sha1-Thqg+1G/vLPpJogAE5cgLBd1tm4=",
|
||||
"requires": {
|
||||
"text-extensions": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"is-typedarray": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz",
|
||||
|
@ -15763,6 +15812,11 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"text-extensions": {
|
||||
"version": "1.9.0",
|
||||
"resolved": "https://registry.npmjs.org/text-extensions/-/text-extensions-1.9.0.tgz",
|
||||
"integrity": "sha512-wiBrwC1EhBelW12Zy26JeOUkQ5mRu+5o8rpsJk5+2t+Y5vE7e842qtZDQ2g1NpX/29HdyFeJ4nSIhI47ENSxlQ=="
|
||||
},
|
||||
"text-table": {
|
||||
"version": "0.2.0",
|
||||
"resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz",
|
||||
|
|
|
@ -14,6 +14,7 @@
|
|||
"gatsby": "^2.13.73",
|
||||
"gatsby-image": "^2.2.10",
|
||||
"gatsby-plugin-catch-links": "^2.1.9",
|
||||
"gatsby-plugin-ipfs": "^2.0.2",
|
||||
"gatsby-plugin-manifest": "^2.2.6",
|
||||
"gatsby-plugin-no-sourcemaps": "^2.1.1",
|
||||
"gatsby-plugin-offline": "^2.2.7",
|
||||
|
|
|
@ -5,11 +5,9 @@ import {Flex} from 'rebass'
|
|||
import {SidebarLink} from './links'
|
||||
import Accordion from './Accordion'
|
||||
|
||||
const IS_STATIC = process.env.GATSBY_IS_STATIC
|
||||
|
||||
const LinkDesc = styled.span`
|
||||
font-size: 11px;
|
||||
line-height: 1.5;
|
||||
font-size: 11px;
|
||||
line-height: 1.5;
|
||||
text-transform: lowercase;
|
||||
display: block;
|
||||
font-weight: 400;
|
||||
|
@ -37,7 +35,7 @@ const DocLinks = ({data}) => {
|
|||
return (
|
||||
<Flex flexDirection='column' key={index}>
|
||||
<SidebarLink
|
||||
to={`${linkData.fields.slug}${IS_STATIC ? '/index.html' : ''}`}
|
||||
to={`${linkData.fields.slug}`}
|
||||
activeClassName='active-sidebar-link'
|
||||
>
|
||||
{title}
|
||||
|
|
|
@ -10,7 +10,7 @@ const Container = styled.div`
|
|||
const FoundTypo = () => {
|
||||
return (
|
||||
<Container>
|
||||
<p>👀 Found a typo? <a href='https://github.com/npm/cli/'>Let us know!</a></p>
|
||||
<p><span role='img' aria-label='eyes-emoji'>👀</span> Found a typo? <a href='https://github.com/npm/cli/'>Let us know!</a></p>
|
||||
<p>The current stable version of npm is <a href='https://github.com/npm/cli/'>here</a>. To upgrade, run: <code className='language-text'>npm install npm@latest -g</code></p>
|
||||
<p>
|
||||
To report bugs or submit feature requests for the docs, please post <a href='https://npm.community/c/support/docs-needed'>here</a>.
|
||||
|
|
|
@ -16,10 +16,10 @@ const MobileContainer = styled.div`
|
|||
right: 0px;
|
||||
background-color: ${(props) => props.theme.colors.white};
|
||||
z-index: 100;
|
||||
|
||||
|
||||
@media screen and (min-width: ${(props) => props.theme.breakpoints.TABLET}) {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
`
|
||||
|
||||
const MobileSidebar = () => {
|
||||
|
|
|
@ -9,19 +9,19 @@ const Container = styled.nav`
|
|||
display: none;
|
||||
width: 380px;
|
||||
position: sticky;
|
||||
overflow: scroll;
|
||||
overflow: scroll;
|
||||
padding-bottom: 200px;
|
||||
top: 54px;
|
||||
background-color: ${(props) => props.theme.colors.white};
|
||||
|
||||
@media screen and (min-width: ${(props) => props.theme.breakpoints.TABLET}) {
|
||||
display: block;
|
||||
}
|
||||
}
|
||||
`
|
||||
|
||||
const Sidebar = () => {
|
||||
return (
|
||||
<Container>
|
||||
<Container className='sidebar'>
|
||||
<DocLinks />
|
||||
</Container>
|
||||
)
|
||||
|
|
|
@ -30,7 +30,6 @@ const DarkBlock = () => {
|
|||
<Text>
|
||||
<p>The current stable version of npm is <a href={'https://github.com/npm/cli/releases/latest'} style={aStyle}>available on GitHub.</a></p>
|
||||
<p>To upgrade, run: <code className={'language-text'} style={{color: 'white'}}>npm install npm@latest -g</code></p>
|
||||
<p>To report bugs or submit feature requests, <a href={'#'} style={aStyle}>please XXX.</a></p>
|
||||
</Text>
|
||||
<Box pt={4}><LinkButton to='cli-commands/npm' w={'120px'}>read docs</LinkButton></Box>
|
||||
</ContentWrapper>
|
||||
|
|
|
@ -9,7 +9,7 @@ const Card = styled(Flex)`
|
|||
`
|
||||
|
||||
const Desc = styled.p`
|
||||
padding: 5px 0;
|
||||
padding: 5px 0;
|
||||
font-size: 16px;
|
||||
`
|
||||
|
||||
|
|
|
@ -60,7 +60,7 @@ const Features = () => {
|
|||
text={featureTexts.textTwo}
|
||||
/>
|
||||
</FeatureLink>
|
||||
<FeatureLink to={'/using-npm/coding-style'}>
|
||||
<FeatureLink to={'/using-npm/developers'}>
|
||||
<FeatureCard
|
||||
icon={networkIcon}
|
||||
title={featureTitles.titleThree}
|
||||
|
|
|
@ -4,7 +4,7 @@ import styled from 'styled-components'
|
|||
import {Flex, Box} from 'rebass'
|
||||
|
||||
const Container = styled(Flex)`
|
||||
background: center / cover no-repeat url(${boxes});
|
||||
background: center / cover no-repeat url(${boxes});
|
||||
height: 380px;
|
||||
background-color: ${(props) => props.theme.colors.offWhite};
|
||||
`
|
||||
|
|
|
@ -16,7 +16,7 @@ const TerminalBody = styled(Flex)`
|
|||
box-shadow: 0px 0px 17px 1px #dc3bc180;
|
||||
border-radius: 2px;
|
||||
top: ${(props) => props.top};
|
||||
left: ${(props) => props.left};
|
||||
left: ${(props) => props.left};
|
||||
right: 0;
|
||||
position: absolute;
|
||||
`
|
||||
|
@ -78,7 +78,7 @@ const Bracket = styled.span`
|
|||
margin-top: 10px;
|
||||
`
|
||||
|
||||
const Text = styled.strong`
|
||||
const Text = styled.span`
|
||||
font-size: 15px;
|
||||
font-weight: 400;
|
||||
letter-spacing: 1px;
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue