mirror of
https://github.com/nodejs/node.git
synced 2025-05-13 09:12:56 +00:00
deps: upgrade npm to 3.3.6
PR-URL: https://github.com/nodejs/node/pull/3310 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
This commit is contained in:
parent
9b8886446d
commit
41923c0c07
1
deps/npm/.mailmap
vendored
1
deps/npm/.mailmap
vendored
@ -24,6 +24,7 @@ Isaac Z. Schlueter <i@izs.me> <i@foohack.com>
|
||||
Isaac Z. Schlueter <i@izs.me> isaacs <i@izs.me>
|
||||
Jake Verbaten <raynos2@gmail.com>
|
||||
James Sanders <jimmyjazz14@gmail.com>
|
||||
James Treworgy <jamietre@gmail.com>
|
||||
Jason Smith <jhs@iriscouch.com>
|
||||
Jonas Weber <github@jonasw.de>
|
||||
Julien Meddah <julien.meddah@deveryware.com>
|
||||
|
2
deps/npm/.travis.yml
vendored
2
deps/npm/.travis.yml
vendored
@ -8,7 +8,7 @@ env:
|
||||
- DEPLOY_VERSION=testing
|
||||
before_install:
|
||||
- "npm config set spin false"
|
||||
- "npm install -g npm/npm#2.x"
|
||||
- "node . install -g ."
|
||||
- "sudo mkdir -p /var/run/couchdb"
|
||||
script: "npm run-script test-all"
|
||||
notifications:
|
||||
|
7
deps/npm/AUTHORS
vendored
7
deps/npm/AUTHORS
vendored
@ -291,11 +291,12 @@ Eduardo Pinho <enet4mikeenet@gmail.com>
|
||||
Rachel Hutchison <rhutchix@intel.com>
|
||||
Ryan Temple <ryantemple145@gmail.com>
|
||||
Eugene Sharygin <eush77@gmail.com>
|
||||
Nick Heiner <nick.heiner@opower.com>
|
||||
James Talmage <james@talmage.io>
|
||||
jane arc <jane@uber.com>
|
||||
Joseph Dykstra <josephdykstra@gmail.com>
|
||||
Andrew Crites <ajcrites@gmail.com>
|
||||
Joshua Egan <josh-egan@users.noreply.github.com>
|
||||
Carlos Alberto <euprogramador@gmail.com>
|
||||
Thomas Cort <thomasc@ssimicro.com>
|
||||
Thaddee Tyl <thaddee.tyl@gmail.com>
|
||||
Steve Klabnik <steve@steveklabnik.com>
|
||||
@ -308,7 +309,7 @@ murgatroid99 <mlumish@google.com>
|
||||
Marcin Cieslak <saper@saper.info>
|
||||
João Reis <reis@janeasystems.com>
|
||||
Matthew Hasbach <hasbach.git@gmail.com>
|
||||
Anna Henningsen <sqrt@entless.org>
|
||||
Jon Hall <jon_hall@outlook.com>
|
||||
Anna Henningsen <sqrt@entless.org>
|
||||
James Treworgy <jamietre@gmail.com>
|
||||
James Hartig <james@levenlabs.com>
|
||||
snopeks <stephaniesnopek@gmail.com>
|
||||
|
1353
deps/npm/CHANGELOG.md
vendored
1353
deps/npm/CHANGELOG.md
vendored
File diff suppressed because it is too large
Load Diff
6
deps/npm/LICENSE
vendored
6
deps/npm/LICENSE
vendored
@ -251,11 +251,11 @@ details.
|
||||
Any data published to The npm Registry (including user account information) may
|
||||
be removed or modified at the sole discretion of the npm server administrators.
|
||||
|
||||
"npm Logo" created by Mathias Pettersson and Brian Hammond,
|
||||
used with permission.
|
||||
"npm Logo" contributed by Mathias Pettersson and Brian Hammond,
|
||||
use is subject to https://www.npmjs.com/policies/trademark
|
||||
|
||||
"Gubblebum Blocky" font
|
||||
Copyright (c) by Tjarda Koster, http://jelloween.deviantart.com
|
||||
Copyright (c) by Tjarda Koster, https://jelloween.deviantart.com
|
||||
included for use in the npm website and documentation,
|
||||
used with permission.
|
||||
|
||||
|
24
deps/npm/Makefile
vendored
24
deps/npm/Makefile
vendored
@ -16,10 +16,6 @@ cli_mandocs = $(shell find doc/cli -name '*.md' \
|
||||
|sed 's|doc/cli/|man/man1/|g' ) \
|
||||
man/man1/npm-README.1
|
||||
|
||||
api_mandocs = $(shell find doc/api -name '*.md' \
|
||||
|sed 's|.md|.3|g' \
|
||||
|sed 's|doc/api/|man/man3/|g' )
|
||||
|
||||
files_mandocs = $(shell find doc/files -name '*.md' \
|
||||
|sed 's|.md|.5|g' \
|
||||
|sed 's|doc/files/|man/man5/|g' ) \
|
||||
@ -36,10 +32,6 @@ cli_htmldocs = $(shell find doc/cli -name '*.md' \
|
||||
|sed 's|doc/cli/|html/doc/cli/|g' ) \
|
||||
html/doc/README.html
|
||||
|
||||
api_htmldocs = $(shell find doc/api -name '*.md' \
|
||||
|sed 's|.md|.html|g' \
|
||||
|sed 's|doc/api/|html/doc/api/|g' )
|
||||
|
||||
files_htmldocs = $(shell find doc/files -name '*.md' \
|
||||
|sed 's|.md|.html|g' \
|
||||
|sed 's|doc/files/|html/doc/files/|g' ) \
|
||||
@ -51,9 +43,9 @@ misc_htmldocs = $(shell find doc/misc -name '*.md' \
|
||||
|sed 's|doc/misc/|html/doc/misc/|g' ) \
|
||||
html/doc/index.html
|
||||
|
||||
mandocs = $(api_mandocs) $(cli_mandocs) $(files_mandocs) $(misc_mandocs)
|
||||
mandocs = $(cli_mandocs) $(files_mandocs) $(misc_mandocs)
|
||||
|
||||
htmldocs = $(api_htmldocs) $(cli_htmldocs) $(files_htmldocs) $(misc_htmldocs)
|
||||
htmldocs = $(cli_htmldocs) $(files_htmldocs) $(misc_htmldocs)
|
||||
|
||||
all: doc
|
||||
|
||||
@ -93,7 +85,6 @@ doc-clean:
|
||||
.building_marked \
|
||||
.building_marked-man \
|
||||
html/doc \
|
||||
html/api \
|
||||
man
|
||||
|
||||
# use `npm install marked-man` for this to work.
|
||||
@ -105,10 +96,6 @@ man/man1/%.1: doc/cli/%.md scripts/doc-build.sh package.json
|
||||
@[ -d man/man1 ] || mkdir -p man/man1
|
||||
scripts/doc-build.sh $< $@
|
||||
|
||||
man/man3/%.3: doc/api/%.md scripts/doc-build.sh package.json
|
||||
@[ -d man/man3 ] || mkdir -p man/man3
|
||||
scripts/doc-build.sh $< $@
|
||||
|
||||
man/man5/npm-json.5: man/man5/package.json.5
|
||||
cp $< $@
|
||||
|
||||
@ -138,12 +125,9 @@ html/doc/cli/%.html: doc/cli/%.md $(html_docdeps)
|
||||
@[ -d html/doc/cli ] || mkdir -p html/doc/cli
|
||||
scripts/doc-build.sh $< $@
|
||||
|
||||
html/doc/api/%.html: doc/api/%.md $(html_docdeps)
|
||||
@[ -d html/doc/api ] || mkdir -p html/doc/api
|
||||
scripts/doc-build.sh $< $@
|
||||
|
||||
html/doc/files/npm-json.html: html/doc/files/package.json.html
|
||||
cp $< $@
|
||||
|
||||
html/doc/files/npm-global.html: html/doc/files/npm-folders.html
|
||||
cp $< $@
|
||||
|
||||
@ -168,7 +152,7 @@ node_modules/.bin/marked-man:
|
||||
|
||||
doc: man
|
||||
|
||||
man: $(cli_docs) $(api_docs)
|
||||
man: $(cli_docs)
|
||||
|
||||
test: doc
|
||||
node cli.js test
|
||||
|
8
deps/npm/bin/node-gyp-bin/node-gyp.cmd
vendored
8
deps/npm/bin/node-gyp-bin/node-gyp.cmd
vendored
@ -1,5 +1,5 @@
|
||||
if not defined npm_config_node_gyp (
|
||||
node "%~dp0\..\..\node_modules\node-gyp\bin\node-gyp.js" %*
|
||||
) else (
|
||||
if not defined npm_config_node_gyp (
|
||||
node "%~dp0\..\..\node_modules\node-gyp\bin\node-gyp.js" %*
|
||||
) else (
|
||||
node %npm_config_node_gyp% %*
|
||||
)
|
||||
)
|
||||
|
114
deps/npm/bin/npm-cli.js
vendored
114
deps/npm/bin/npm-cli.js
vendored
@ -1,75 +1,77 @@
|
||||
#!/usr/bin/env node
|
||||
;(function () { // wrapper in case we're in module_context mode
|
||||
|
||||
// windows: running "npm blah" in this folder will invoke WSH, not node.
|
||||
if (typeof WScript !== "undefined") {
|
||||
WScript.echo("npm does not work when run\n"
|
||||
+"with the Windows Scripting Host\n\n"
|
||||
+"'cd' to a different directory,\n"
|
||||
+"or type 'npm.cmd <args>',\n"
|
||||
+"or type 'node npm <args>'.")
|
||||
WScript.quit(1)
|
||||
return
|
||||
}
|
||||
// windows: running "npm blah" in this folder will invoke WSH, not node.
|
||||
/*global WScript*/
|
||||
if (typeof WScript !== 'undefined') {
|
||||
WScript.echo(
|
||||
'npm does not work when run\n' +
|
||||
'with the Windows Scripting Host\n\n' +
|
||||
"'cd' to a different directory,\n" +
|
||||
"or type 'npm.cmd <args>',\n" +
|
||||
"or type 'node npm <args>'."
|
||||
)
|
||||
WScript.quit(1)
|
||||
return
|
||||
}
|
||||
|
||||
process.title = 'npm'
|
||||
|
||||
process.title = "npm"
|
||||
var log = require('npmlog')
|
||||
log.pause() // will be unpaused when config is loaded.
|
||||
|
||||
var log = require("npmlog")
|
||||
log.pause() // will be unpaused when config is loaded.
|
||||
log.info("it worked if it ends with", "ok")
|
||||
log.info('it worked if it ends with', 'ok')
|
||||
|
||||
var path = require("path")
|
||||
, npm = require("../lib/npm.js")
|
||||
, npmconf = require("../lib/config/core.js")
|
||||
, errorHandler = require("../lib/utils/error-handler.js")
|
||||
var path = require('path')
|
||||
var npm = require('../lib/npm.js')
|
||||
var npmconf = require('../lib/config/core.js')
|
||||
var errorHandler = require('../lib/utils/error-handler.js')
|
||||
|
||||
, configDefs = npmconf.defs
|
||||
, shorthands = configDefs.shorthands
|
||||
, types = configDefs.types
|
||||
, nopt = require("nopt")
|
||||
var configDefs = npmconf.defs
|
||||
var shorthands = configDefs.shorthands
|
||||
var types = configDefs.types
|
||||
var nopt = require('nopt')
|
||||
|
||||
// if npm is called as "npmg" or "npm_g", then
|
||||
// run in global mode.
|
||||
if (path.basename(process.argv[1]).slice(-1) === "g") {
|
||||
process.argv.splice(1, 1, "npm", "-g")
|
||||
}
|
||||
// if npm is called as "npmg" or "npm_g", then
|
||||
// run in global mode.
|
||||
if (path.basename(process.argv[1]).slice(-1) === 'g') {
|
||||
process.argv.splice(1, 1, 'npm', '-g')
|
||||
}
|
||||
|
||||
log.verbose("cli", process.argv)
|
||||
log.verbose('cli', process.argv)
|
||||
|
||||
var conf = nopt(types, shorthands)
|
||||
npm.argv = conf.argv.remain
|
||||
if (npm.deref(npm.argv[0])) npm.command = npm.argv.shift()
|
||||
else conf.usage = true
|
||||
var conf = nopt(types, shorthands)
|
||||
npm.argv = conf.argv.remain
|
||||
if (npm.deref(npm.argv[0])) npm.command = npm.argv.shift()
|
||||
else conf.usage = true
|
||||
|
||||
if (conf.version) {
|
||||
console.log(npm.version)
|
||||
return
|
||||
}
|
||||
|
||||
if (conf.version) {
|
||||
console.log(npm.version)
|
||||
return
|
||||
}
|
||||
if (conf.versions) {
|
||||
npm.command = 'version'
|
||||
conf.usage = false
|
||||
npm.argv = []
|
||||
}
|
||||
|
||||
if (conf.versions) {
|
||||
npm.command = "version"
|
||||
conf.usage = false
|
||||
npm.argv = []
|
||||
}
|
||||
log.info('using', 'npm@%s', npm.version)
|
||||
log.info('using', 'node@%s', process.version)
|
||||
|
||||
log.info("using", "npm@%s", npm.version)
|
||||
log.info("using", "node@%s", process.version)
|
||||
process.on('uncaughtException', errorHandler)
|
||||
|
||||
process.on("uncaughtException", errorHandler)
|
||||
if (conf.usage && npm.command !== 'help') {
|
||||
npm.argv.unshift(npm.command)
|
||||
npm.command = 'help'
|
||||
}
|
||||
|
||||
if (conf.usage && npm.command !== "help") {
|
||||
npm.argv.unshift(npm.command)
|
||||
npm.command = "help"
|
||||
}
|
||||
|
||||
// now actually fire up npm and run the command.
|
||||
// this is how to use npm programmatically:
|
||||
conf._exit = true
|
||||
npm.load(conf, function (er) {
|
||||
if (er) return errorHandler(er)
|
||||
npm.commands[npm.command](npm.argv, errorHandler)
|
||||
})
|
||||
// now actually fire up npm and run the command.
|
||||
// this is how to use npm programmatically:
|
||||
conf._exit = true
|
||||
npm.load(conf, function (er) {
|
||||
if (er) return errorHandler(er)
|
||||
npm.commands[npm.command](npm.argv, errorHandler)
|
||||
})
|
||||
|
||||
})()
|
||||
|
26
deps/npm/bin/read-package-json.js
vendored
26
deps/npm/bin/read-package-json.js
vendored
@ -1,22 +1,24 @@
|
||||
var argv = process.argv
|
||||
if (argv.length < 3) {
|
||||
console.error("Usage: read-package.json <file> [<fields> ...]")
|
||||
console.error('Usage: read-package.json <file> [<fields> ...]')
|
||||
process.exit(1)
|
||||
}
|
||||
|
||||
var fs = require("fs")
|
||||
, file = argv[2]
|
||||
, readJson = require("read-package-json")
|
||||
var file = argv[2]
|
||||
var readJson = require('read-package-json')
|
||||
|
||||
readJson(file, function (er, data) {
|
||||
if (er) throw er
|
||||
if (argv.length === 3) console.log(data)
|
||||
else argv.slice(3).forEach(function (field) {
|
||||
field = field.split(".")
|
||||
var val = data
|
||||
field.forEach(function (f) {
|
||||
val = val[f]
|
||||
if (argv.length === 3) {
|
||||
console.log(data)
|
||||
} else {
|
||||
argv.slice(3).forEach(function (field) {
|
||||
field = field.split('.')
|
||||
var val = data
|
||||
field.forEach(function (f) {
|
||||
val = val[f]
|
||||
})
|
||||
console.log(val)
|
||||
})
|
||||
console.log(val)
|
||||
})
|
||||
}
|
||||
})
|
||||
|
2
deps/npm/cli.js
vendored
2
deps/npm/cli.js
vendored
@ -1,2 +1,2 @@
|
||||
#!/usr/bin/env node
|
||||
require("./bin/npm-cli.js")
|
||||
require('./bin/npm-cli.js')
|
||||
|
13
deps/npm/doc/api/npm-bin.md
vendored
13
deps/npm/doc/api/npm-bin.md
vendored
@ -1,13 +0,0 @@
|
||||
npm-bin(3) -- Display npm bin folder
|
||||
====================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.bin(args, cb)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Print the folder where npm will install executables.
|
||||
|
||||
This function should not be used programmatically. Instead, just refer
|
||||
to the `npm.bin` property.
|
19
deps/npm/doc/api/npm-bugs.md
vendored
19
deps/npm/doc/api/npm-bugs.md
vendored
@ -1,19 +0,0 @@
|
||||
npm-bugs(3) -- Bugs for a package in a web browser maybe
|
||||
========================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.bugs(package, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This command tries to guess at the likely location of a package's
|
||||
bug tracker URL, and then tries to open it using the `--browser`
|
||||
config param.
|
||||
|
||||
Like other commands, the first parameter is an array. This command only
|
||||
uses the first element, which is expected to be a package name with an
|
||||
optional version number.
|
||||
|
||||
This command will launch a browser, so this command may not be the most
|
||||
friendly for programmatic use.
|
30
deps/npm/doc/api/npm-cache.md
vendored
30
deps/npm/doc/api/npm-cache.md
vendored
@ -1,30 +0,0 @@
|
||||
npm-cache(3) -- manage the npm cache programmatically
|
||||
=====================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.cache([args], callback)
|
||||
|
||||
// helpers
|
||||
npm.commands.cache.clean([args], callback)
|
||||
npm.commands.cache.add([args], callback)
|
||||
npm.commands.cache.read(name, version, forceBypass, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This acts much the same ways as the npm-cache(1) command line
|
||||
functionality.
|
||||
|
||||
The callback is called with the package.json data of the thing that is
|
||||
eventually added to or read from the cache.
|
||||
|
||||
The top level `npm.commands.cache(...)` functionality is a public
|
||||
interface, and like all commands on the `npm.commands` object, it will
|
||||
match the command line behavior exactly.
|
||||
|
||||
However, the cache folder structure and the cache helper functions are
|
||||
considered **internal** API surface, and as such, may change in future
|
||||
releases of npm, potentially without warning or significant version
|
||||
incrementation.
|
||||
|
||||
Use at your own risk.
|
22
deps/npm/doc/api/npm-commands.md
vendored
22
deps/npm/doc/api/npm-commands.md
vendored
@ -1,22 +0,0 @@
|
||||
npm-commands(3) -- npm commands
|
||||
===============================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands[<command>](args, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
npm comes with a full set of commands, and each of the commands takes a
|
||||
similar set of arguments.
|
||||
|
||||
In general, all commands on the command object take an **array** of positional
|
||||
argument **strings**. The last argument to any function is a callback. Some
|
||||
commands are special and take other optional arguments.
|
||||
|
||||
All commands have their own man page. See `man npm-<command>` for command-line
|
||||
usage, or `man 3 npm-<command>` for programmatic usage.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm-index(7)
|
45
deps/npm/doc/api/npm-config.md
vendored
45
deps/npm/doc/api/npm-config.md
vendored
@ -1,45 +0,0 @@
|
||||
npm-config(3) -- Manage the npm configuration files
|
||||
===================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.config(args, callback)
|
||||
var val = npm.config.get(key)
|
||||
npm.config.set(key, val)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This function acts much the same way as the command-line version. The first
|
||||
element in the array tells config what to do. Possible values are:
|
||||
|
||||
* `set`
|
||||
|
||||
Sets a config parameter. The second element in `args` is interpreted as the
|
||||
key, and the third element is interpreted as the value.
|
||||
|
||||
* `get`
|
||||
|
||||
Gets the value of a config parameter. The second element in `args` is the
|
||||
key to get the value of.
|
||||
|
||||
* `delete` (`rm` or `del`)
|
||||
|
||||
Deletes a parameter from the config. The second element in `args` is the
|
||||
key to delete.
|
||||
|
||||
* `list` (`ls`)
|
||||
|
||||
Show all configs that aren't secret. No parameters necessary.
|
||||
|
||||
* `edit`:
|
||||
|
||||
Opens the config file in the default editor. This command isn't very useful
|
||||
programmatically, but it is made available.
|
||||
|
||||
To programmatically access npm configuration settings, or set them for
|
||||
the duration of a program, use the `npm.config.set` and `npm.config.get`
|
||||
functions instead.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm(3)
|
34
deps/npm/doc/api/npm-deprecate.md
vendored
34
deps/npm/doc/api/npm-deprecate.md
vendored
@ -1,34 +0,0 @@
|
||||
npm-deprecate(3) -- Deprecate a version of a package
|
||||
====================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.deprecate(args, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This command will update the npm registry entry for a package, providing
|
||||
a deprecation warning to all who attempt to install it.
|
||||
|
||||
The 'args' parameter must have exactly two elements:
|
||||
|
||||
* `package[@version]`
|
||||
|
||||
The `version` portion is optional, and may be either a range, or a
|
||||
specific version, or a tag.
|
||||
|
||||
* `message`
|
||||
|
||||
The warning message that will be printed whenever a user attempts to
|
||||
install the package.
|
||||
|
||||
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.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm-publish(3)
|
||||
* npm-unpublish(3)
|
||||
* npm-registry(7)
|
19
deps/npm/doc/api/npm-docs.md
vendored
19
deps/npm/doc/api/npm-docs.md
vendored
@ -1,19 +0,0 @@
|
||||
npm-docs(3) -- Docs for a package in a web browser maybe
|
||||
========================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.docs(package, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This command tries to guess at the likely location of a package's
|
||||
documentation URL, and then tries to open it using the `--browser`
|
||||
config param.
|
||||
|
||||
Like other commands, the first parameter is an array. This command only
|
||||
uses the first element, which is expected to be a package name with an
|
||||
optional version number.
|
||||
|
||||
This command will launch a browser, so this command may not be the most
|
||||
friendly for programmatic use.
|
24
deps/npm/doc/api/npm-edit.md
vendored
24
deps/npm/doc/api/npm-edit.md
vendored
@ -1,24 +0,0 @@
|
||||
npm-edit(3) -- Edit an installed package
|
||||
========================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.edit(package, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Opens the package folder in the default editor (or whatever you've
|
||||
configured as the npm `editor` config -- see `npm help config`.)
|
||||
|
||||
After it has been edited, the package is rebuilt so as to pick up any
|
||||
changes in compiled packages.
|
||||
|
||||
For instance, you can do `npm install connect` to install connect
|
||||
into your package, and then `npm.commands.edit(["connect"], callback)`
|
||||
to make a few changes to your locally installed copy.
|
||||
|
||||
The first parameter is a string array with a single element, the package
|
||||
to open. The package can optionally have a version number attached.
|
||||
|
||||
Since this command opens an editor in a new process, be careful about where
|
||||
and how this is used.
|
18
deps/npm/doc/api/npm-explore.md
vendored
18
deps/npm/doc/api/npm-explore.md
vendored
@ -1,18 +0,0 @@
|
||||
npm-explore(3) -- Browse an installed package
|
||||
=============================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.explore(args, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Spawn a subshell in the directory of the installed package specified.
|
||||
|
||||
If a command is specified, then it is run in the subshell, which then
|
||||
immediately terminates.
|
||||
|
||||
Note that the package is *not* automatically rebuilt afterwards, so be
|
||||
sure to use `npm rebuild <pkg>` if you make any changes.
|
||||
|
||||
The first element in the 'args' parameter must be a package name. After that is the optional command, which can be any number of strings. All of the strings will be combined into one, space-delimited command.
|
30
deps/npm/doc/api/npm-help-search.md
vendored
30
deps/npm/doc/api/npm-help-search.md
vendored
@ -1,30 +0,0 @@
|
||||
npm-help-search(3) -- Search the help pages
|
||||
===========================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.helpSearch(args, [silent,] callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This command is rarely useful, but it exists in the rare case that it is.
|
||||
|
||||
This command takes an array of search terms and returns the help pages that
|
||||
match in order of best match.
|
||||
|
||||
If there is only one match, then npm displays that help section. If there
|
||||
are multiple results, the results are printed to the screen formatted and the
|
||||
array of results is returned. Each result is an object with these properties:
|
||||
|
||||
* hits:
|
||||
A map of args to number of hits on that arg. For example, {"npm": 3}
|
||||
* found:
|
||||
Total number of unique args that matched.
|
||||
* totalHits:
|
||||
Total number of hits.
|
||||
* lines:
|
||||
An array of all matching lines (and some adjacent lines).
|
||||
* file:
|
||||
Name of the file that matched
|
||||
|
||||
The silent parameter is not necessary not used, but it may in the future.
|
29
deps/npm/doc/api/npm-init.md
vendored
29
deps/npm/doc/api/npm-init.md
vendored
@ -1,29 +0,0 @@
|
||||
npm init(3) -- Interactively create a package.json file
|
||||
=======================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.init(args, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This will ask you a bunch of questions, and then write a package.json for you.
|
||||
|
||||
It attempts to make reasonable guesses about what you want things to be set to,
|
||||
and then writes a package.json file with the options you've selected.
|
||||
|
||||
If you already have a package.json file, it'll read that first, and default to
|
||||
the options in there.
|
||||
|
||||
It is strictly additive, so it does not delete options from your package.json
|
||||
without a really good reason to do so.
|
||||
|
||||
Since this function expects to be run on the command-line, it doesn't work very
|
||||
well as a programmatically. The best option is to roll your own, and since
|
||||
JavaScript makes it stupid simple to output formatted JSON, that is the
|
||||
preferred method. If you're sure you want to handle command-line prompting,
|
||||
then go ahead and use this programmatically.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
package.json(5)
|
19
deps/npm/doc/api/npm-install.md
vendored
19
deps/npm/doc/api/npm-install.md
vendored
@ -1,19 +0,0 @@
|
||||
npm-install(3) -- install a package programmatically
|
||||
====================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.install([where,] packages, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This acts much the same ways as installing on the command-line.
|
||||
|
||||
The 'where' parameter is optional and only used internally, and it specifies
|
||||
where the packages should be installed to.
|
||||
|
||||
The 'packages' parameter is an array of strings. Each element in the array is
|
||||
the name of a package to be installed.
|
||||
|
||||
Finally, 'callback' is a function that will be called when all packages have been
|
||||
installed or when an error has been encountered.
|
33
deps/npm/doc/api/npm-link.md
vendored
33
deps/npm/doc/api/npm-link.md
vendored
@ -1,33 +0,0 @@
|
||||
npm-link(3) -- Symlink a package folder
|
||||
=======================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.link(callback)
|
||||
npm.commands.link(packages, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Package linking is a two-step process.
|
||||
|
||||
Without parameters, link will create a globally-installed
|
||||
symbolic link from `prefix/package-name` to the current folder.
|
||||
|
||||
With a parameters, link will create a symlink from the local `node_modules`
|
||||
folder to the global symlink.
|
||||
|
||||
When creating tarballs for `npm publish`, the linked packages are
|
||||
"snapshotted" to their current state by resolving the symbolic links.
|
||||
|
||||
This is
|
||||
handy for installing your own stuff, so that you can work on it and test it
|
||||
iteratively without having to continually rebuild.
|
||||
|
||||
For example:
|
||||
|
||||
npm.commands.link(cb) # creates global link from the cwd
|
||||
# (say redis package)
|
||||
npm.commands.link('redis', cb) # link-install the package
|
||||
|
||||
Now, any changes to the redis package will be reflected in
|
||||
the package in the current working directory
|
26
deps/npm/doc/api/npm-load.md
vendored
26
deps/npm/doc/api/npm-load.md
vendored
@ -1,26 +0,0 @@
|
||||
npm-load(3) -- Load config settings
|
||||
===================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.load(conf, cb)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
npm.load() must be called before any other function call. Both parameters are
|
||||
optional, but the second is recommended.
|
||||
|
||||
The first parameter is an object containing command-line config params, and the
|
||||
second parameter is a callback that will be called when npm is loaded and ready
|
||||
to serve.
|
||||
|
||||
The first parameter should follow a similar structure as the package.json
|
||||
config object.
|
||||
|
||||
For example, to emulate the --dev flag, pass an object that looks like this:
|
||||
|
||||
{
|
||||
"dev": true
|
||||
}
|
||||
|
||||
For a list of all the available command-line configs, see `npm help config`
|
56
deps/npm/doc/api/npm-ls.md
vendored
56
deps/npm/doc/api/npm-ls.md
vendored
@ -1,56 +0,0 @@
|
||||
npm-ls(3) -- List installed packages
|
||||
======================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.ls(args, [silent,] callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This command will print to stdout all the versions of packages that are
|
||||
installed, as well as their dependencies, in a tree-structure. It will also
|
||||
return that data using the callback.
|
||||
|
||||
This command does not take any arguments, but args must be defined.
|
||||
Beyond that, if any arguments are passed in, npm will politely warn that it
|
||||
does not take positional arguments, though you may set config flags
|
||||
like with any other command, such as `global` to list global packages.
|
||||
|
||||
It will print out extraneous, missing, and invalid packages.
|
||||
|
||||
If the silent parameter is set to true, nothing will be output to the screen,
|
||||
but the data will still be returned.
|
||||
|
||||
Callback is provided an error if one occurred, the full data about which
|
||||
packages are installed and which dependencies they will receive, and a
|
||||
"lite" data object which just shows which versions are installed where.
|
||||
Note that the full data object is a circular structure, so care must be
|
||||
taken if it is serialized to JSON.
|
||||
|
||||
## CONFIGURATION
|
||||
|
||||
### long
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show extended information.
|
||||
|
||||
### parseable
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show parseable output instead of tree view.
|
||||
|
||||
### global
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
List packages in the global install prefix instead of in the current
|
||||
project.
|
||||
|
||||
Note, if parseable is set or long isn't set, then duplicates will be trimmed.
|
||||
This means that if a submodule has the same dependency as a parent module, then the
|
||||
dependency will only be output once.
|
13
deps/npm/doc/api/npm-outdated.md
vendored
13
deps/npm/doc/api/npm-outdated.md
vendored
@ -1,13 +0,0 @@
|
||||
npm-outdated(3) -- Check for outdated packages
|
||||
==============================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.outdated([packages,] callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This command will check the registry to see if the specified packages are
|
||||
currently outdated.
|
||||
|
||||
If the 'packages' parameter is left out, npm will check all packages.
|
31
deps/npm/doc/api/npm-owner.md
vendored
31
deps/npm/doc/api/npm-owner.md
vendored
@ -1,31 +0,0 @@
|
||||
npm-owner(3) -- Manage package owners
|
||||
=====================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.owner(args, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
The first element of the 'args' parameter defines what to do, and the subsequent
|
||||
elements depend on the action. Possible values for the action are (order of
|
||||
parameters are given in parenthesis):
|
||||
|
||||
* ls (package):
|
||||
List all the users who have access to modify a package and push new versions.
|
||||
Handy when you need to know who to bug for help.
|
||||
* add (user, package):
|
||||
Add a new user as a maintainer of a package. This user is enabled to modify
|
||||
metadata, publish new versions, and add other owners.
|
||||
* rm (user, package):
|
||||
Remove a user from the package owner list. This immediately revokes their
|
||||
privileges.
|
||||
|
||||
Note that there is only one level of access. Either you can modify a package,
|
||||
or you can't. Future versions may contain more fine-grained access levels, but
|
||||
that is not implemented at this time.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm-publish(3)
|
||||
* npm-registry(7)
|
19
deps/npm/doc/api/npm-pack.md
vendored
19
deps/npm/doc/api/npm-pack.md
vendored
@ -1,19 +0,0 @@
|
||||
npm-pack(3) -- Create a tarball from a package
|
||||
==============================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.pack([packages,] callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
For anything that's installable (that is, a package folder, tarball,
|
||||
tarball url, name@tag, name@version, or name), this command will fetch
|
||||
it to the cache, and then copy the tarball to the current working
|
||||
directory as `<name>-<version>.tgz`, and then write the filenames out to
|
||||
stdout.
|
||||
|
||||
If the same package is specified multiple times, then the file will be
|
||||
overwritten the second time.
|
||||
|
||||
If no arguments are supplied, then npm packs the current package folder.
|
14
deps/npm/doc/api/npm-ping.md
vendored
14
deps/npm/doc/api/npm-ping.md
vendored
@ -1,14 +0,0 @@
|
||||
npm-ping(3) -- Ping npm registry
|
||||
================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.registry.ping(registry, options, function (er, pong))
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Attempts to connect to the given registry, returning a `pong`
|
||||
object with various metadata if it succeeds.
|
||||
|
||||
This function is primarily useful for debugging connection issues
|
||||
to npm registries.
|
15
deps/npm/doc/api/npm-prefix.md
vendored
15
deps/npm/doc/api/npm-prefix.md
vendored
@ -1,15 +0,0 @@
|
||||
npm-prefix(3) -- Display prefix
|
||||
===============================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.prefix(args, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Print the prefix to standard out.
|
||||
|
||||
'args' is never used and callback is never called with data.
|
||||
'args' must be present or things will break.
|
||||
|
||||
This function is not useful programmatically
|
17
deps/npm/doc/api/npm-prune.md
vendored
17
deps/npm/doc/api/npm-prune.md
vendored
@ -1,17 +0,0 @@
|
||||
npm-prune(3) -- Remove extraneous packages
|
||||
==========================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.prune([packages,] callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This command removes "extraneous" packages.
|
||||
|
||||
The first parameter is optional, and it specifies packages to be removed.
|
||||
|
||||
No packages are specified, then all packages will be checked.
|
||||
|
||||
Extraneous packages are packages that are not listed on the parent
|
||||
package's dependencies list.
|
30
deps/npm/doc/api/npm-publish.md
vendored
30
deps/npm/doc/api/npm-publish.md
vendored
@ -1,30 +0,0 @@
|
||||
npm-publish(3) -- Publish a package
|
||||
===================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.publish([packages,] callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Publishes a package to the registry so that it can be installed by name.
|
||||
Possible values in the 'packages' array are:
|
||||
|
||||
* `<folder>`:
|
||||
A folder containing a package.json file
|
||||
|
||||
* `<tarball>`:
|
||||
A url or file path to a gzipped tar archive containing a single folder
|
||||
with a package.json file inside.
|
||||
|
||||
If the package array is empty, npm will try to publish something in the
|
||||
current working directory.
|
||||
|
||||
This command could fails if one of the packages specified already exists in
|
||||
the registry. Overwrites when the "force" environment variable is set.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm-registry(7)
|
||||
* npm-adduser(1)
|
||||
* npm-owner(3)
|
16
deps/npm/doc/api/npm-rebuild.md
vendored
16
deps/npm/doc/api/npm-rebuild.md
vendored
@ -1,16 +0,0 @@
|
||||
npm-rebuild(3) -- Rebuild a package
|
||||
===================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.rebuild([packages,] callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This command runs the `npm build` command on each of the matched packages. This is useful
|
||||
when you install a new version of node, and must recompile all your C++ addons with
|
||||
the new binary. If no 'packages' parameter is specify, every package will be rebuilt.
|
||||
|
||||
## CONFIGURATION
|
||||
|
||||
See `npm help build`
|
19
deps/npm/doc/api/npm-repo.md
vendored
19
deps/npm/doc/api/npm-repo.md
vendored
@ -1,19 +0,0 @@
|
||||
npm-repo(3) -- Open package repository page in the browser
|
||||
========================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.repo(package, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This command tries to guess at the likely location of a package's
|
||||
repository URL, and then tries to open it using the `--browser`
|
||||
config param.
|
||||
|
||||
Like other commands, the first parameter is an array. This command only
|
||||
uses the first element, which is expected to be a package name with an
|
||||
optional version number.
|
||||
|
||||
This command will launch a browser, so this command may not be the most
|
||||
friendly for programmatic use.
|
41
deps/npm/doc/api/npm-restart.md
vendored
41
deps/npm/doc/api/npm-restart.md
vendored
@ -1,41 +0,0 @@
|
||||
npm-restart(3) -- Restart a package
|
||||
===================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.restart(packages, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This restarts a package (or multiple packages).
|
||||
|
||||
This runs a package's "stop", "restart", and "start" scripts, and associated
|
||||
pre- and post- scripts, in the order given below:
|
||||
|
||||
1. prerestart
|
||||
2. prestop
|
||||
3. stop
|
||||
4. poststop
|
||||
5. restart
|
||||
6. prestart
|
||||
7. start
|
||||
8. poststart
|
||||
9. postrestart
|
||||
|
||||
If no version is specified, then it restarts the "active" version.
|
||||
|
||||
npm can restart multiple packages. Just specify multiple packages in
|
||||
the `packages` parameter.
|
||||
|
||||
## NOTE
|
||||
|
||||
Note that the "restart" script is run **in addition to** the "stop"
|
||||
and "start" scripts, not instead of them.
|
||||
|
||||
This is the behavior as of `npm` major version 2. A change in this
|
||||
behavior will be accompanied by an increase in major version number
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm-start(3)
|
||||
* npm-stop(3)
|
15
deps/npm/doc/api/npm-root.md
vendored
15
deps/npm/doc/api/npm-root.md
vendored
@ -1,15 +0,0 @@
|
||||
npm-root(3) -- Display npm root
|
||||
===============================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.root(args, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Print the effective `node_modules` folder to standard out.
|
||||
|
||||
'args' is never used and callback is never called with data.
|
||||
'args' must be present or things will break.
|
||||
|
||||
This function is not useful programmatically.
|
27
deps/npm/doc/api/npm-run-script.md
vendored
27
deps/npm/doc/api/npm-run-script.md
vendored
@ -1,27 +0,0 @@
|
||||
npm-run-script(3) -- Run arbitrary package scripts
|
||||
==================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.run-script(args, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This runs an arbitrary command from a package's "scripts" object.
|
||||
|
||||
It is used by the test, start, restart, and stop commands, but can be
|
||||
called directly, as well.
|
||||
|
||||
The 'args' parameter is an array of strings. Behavior depends on the number
|
||||
of elements. If there is only one element, npm assumes that the element
|
||||
represents a command to be run on the local repository. If there is more than
|
||||
one element, then the first is assumed to be the package and the second is
|
||||
assumed to be the command to run. All other elements are ignored.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm-scripts(7)
|
||||
* npm-test(3)
|
||||
* npm-start(3)
|
||||
* npm-restart(3)
|
||||
* npm-stop(3)
|
35
deps/npm/doc/api/npm-search.md
vendored
35
deps/npm/doc/api/npm-search.md
vendored
@ -1,35 +0,0 @@
|
||||
npm-search(3) -- Search for packages
|
||||
====================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.search(searchTerms, [silent,] [staleness,] callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Search the registry for packages matching the search terms. The available parameters are:
|
||||
|
||||
* searchTerms:
|
||||
Array of search terms. These terms are case-insensitive.
|
||||
* silent:
|
||||
If true, npm will not log anything to the console.
|
||||
* staleness:
|
||||
This is the threshold for stale packages. "Fresh" packages are not refreshed
|
||||
from the registry. This value is measured in seconds.
|
||||
* callback:
|
||||
Returns an object where each key is the name of a package, and the value
|
||||
is information about that package along with a 'words' property, which is
|
||||
a space-delimited string of all of the interesting words in that package.
|
||||
The only properties included are those that are searched, which generally include:
|
||||
|
||||
* name
|
||||
* description
|
||||
* maintainers
|
||||
* url
|
||||
* keywords
|
||||
|
||||
A search on the registry excludes any result that does not match all of the
|
||||
search terms. It also removes any items from the results that contain an
|
||||
excluded term (the "searchexclude" config). The search is case insensitive
|
||||
and doesn't try to read your mind (it doesn't do any verb tense matching or the
|
||||
like).
|
20
deps/npm/doc/api/npm-shrinkwrap.md
vendored
20
deps/npm/doc/api/npm-shrinkwrap.md
vendored
@ -1,20 +0,0 @@
|
||||
npm-shrinkwrap(3) -- programmatically generate package shrinkwrap file
|
||||
====================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.shrinkwrap(args, [silent,] callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This acts much the same ways as shrinkwrapping on the command-line.
|
||||
|
||||
This command does not take any arguments, but 'args' must be defined.
|
||||
Beyond that, if any arguments are passed in, npm will politely warn that it
|
||||
does not take positional arguments.
|
||||
|
||||
If the 'silent' parameter is set to true, nothing will be output to the screen,
|
||||
but the shrinkwrap file will still be written.
|
||||
|
||||
Finally, 'callback' is a function that will be called when the shrinkwrap has
|
||||
been saved.
|
13
deps/npm/doc/api/npm-start.md
vendored
13
deps/npm/doc/api/npm-start.md
vendored
@ -1,13 +0,0 @@
|
||||
npm-start(3) -- Start a package
|
||||
===============================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.start(packages, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This runs a package's "start" script, if one was provided.
|
||||
|
||||
npm can start multiple packages. Just specify multiple packages in the
|
||||
`packages` parameter.
|
13
deps/npm/doc/api/npm-stop.md
vendored
13
deps/npm/doc/api/npm-stop.md
vendored
@ -1,13 +0,0 @@
|
||||
npm-stop(3) -- Stop a package
|
||||
=============================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.stop(packages, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This runs a package's "stop" script, if one was provided.
|
||||
|
||||
npm can run stop on multiple packages. Just specify multiple packages
|
||||
in the `packages` parameter.
|
23
deps/npm/doc/api/npm-tag.md
vendored
23
deps/npm/doc/api/npm-tag.md
vendored
@ -1,23 +0,0 @@
|
||||
npm-tag(3) -- Tag a published version
|
||||
=====================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.tag(package@version, tag, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Tags the specified version of the package with the specified tag, or the
|
||||
`--tag` config if not specified.
|
||||
|
||||
The 'package@version' is an array of strings, but only the first two elements are
|
||||
currently used.
|
||||
|
||||
The first element must be in the form package@version, where package
|
||||
is the package name and version is the version number (much like installing a
|
||||
specific version).
|
||||
|
||||
The second element is the name of the tag to tag this version with. If this
|
||||
parameter is missing or falsey (empty), the default from the config will be
|
||||
used. For more information about how to set this config, check
|
||||
`man 3 npm-config` for programmatic usage or `man npm-config` for cli usage.
|
16
deps/npm/doc/api/npm-test.md
vendored
16
deps/npm/doc/api/npm-test.md
vendored
@ -1,16 +0,0 @@
|
||||
npm-test(3) -- Test a package
|
||||
=============================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.test(packages, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This runs a package's "test" script, if one was provided.
|
||||
|
||||
To run tests as a condition of installation, set the `npat` config to
|
||||
true.
|
||||
|
||||
npm can run tests on multiple packages. Just specify multiple packages
|
||||
in the `packages` parameter.
|
16
deps/npm/doc/api/npm-uninstall.md
vendored
16
deps/npm/doc/api/npm-uninstall.md
vendored
@ -1,16 +0,0 @@
|
||||
npm-uninstall(3) -- uninstall a package programmatically
|
||||
========================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.uninstall(packages, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This acts much the same ways as uninstalling on the command-line.
|
||||
|
||||
The 'packages' parameter is an array of strings. Each element in the array is
|
||||
the name of a package to be uninstalled.
|
||||
|
||||
Finally, 'callback' is a function that will be called when all packages have been
|
||||
uninstalled or when an error has been encountered.
|
20
deps/npm/doc/api/npm-unpublish.md
vendored
20
deps/npm/doc/api/npm-unpublish.md
vendored
@ -1,20 +0,0 @@
|
||||
npm-unpublish(3) -- Remove a package from the registry
|
||||
======================================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.unpublish(package, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This removes a package version from the registry, deleting its
|
||||
entry and removing the tarball.
|
||||
|
||||
The package parameter must be defined.
|
||||
|
||||
Only the first element in the package parameter is used. If there is no first
|
||||
element, then npm assumes that the package at the current working directory
|
||||
is what is meant.
|
||||
|
||||
If no version is specified, or if all versions are removed then
|
||||
the root package entry is removed from the registry entirely.
|
18
deps/npm/doc/api/npm-update.md
vendored
18
deps/npm/doc/api/npm-update.md
vendored
@ -1,18 +0,0 @@
|
||||
npm-update(3) -- Update a package
|
||||
=================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.update(packages, callback)
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Updates a package, upgrading it to the latest version. It also installs any
|
||||
missing packages.
|
||||
|
||||
The `packages` argument is an array of packages to update. The `callback`
|
||||
parameter will be called when done or when an error occurs.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm-update(1)
|
18
deps/npm/doc/api/npm-version.md
vendored
18
deps/npm/doc/api/npm-version.md
vendored
@ -1,18 +0,0 @@
|
||||
npm-version(3) -- Bump a package version
|
||||
========================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.version(newversion, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Run this in a package directory to bump the version and write the new
|
||||
data back to the package.json file.
|
||||
|
||||
If run in a git repo, it will also create a version commit and tag, and
|
||||
fail if the repo is not clean.
|
||||
|
||||
Like all other commands, this function takes a string array as its first
|
||||
parameter. The difference, however, is this function will fail if it does
|
||||
not have exactly one element. The only element should be a version number.
|
93
deps/npm/doc/api/npm-view.md
vendored
93
deps/npm/doc/api/npm-view.md
vendored
@ -1,93 +0,0 @@
|
||||
npm-view(3) -- View registry info
|
||||
=================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.view(args, [silent,] callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This command shows data about a package and prints it to the stream
|
||||
referenced by the `outfd` config, which defaults to stdout.
|
||||
|
||||
The "args" parameter is an ordered list that closely resembles the command-line
|
||||
usage. The elements should be ordered such that the first element is
|
||||
the package and version (package@version). The version is optional. After that,
|
||||
the rest of the parameters are fields with optional subfields ("field.subfield")
|
||||
which can be used to get only the information desired from the registry.
|
||||
|
||||
The callback will be passed all of the data returned by the query.
|
||||
|
||||
For example, to get the package registry entry for the `connect` package,
|
||||
you can do this:
|
||||
|
||||
npm.commands.view(["connect"], callback)
|
||||
|
||||
If no version is specified, "latest" is assumed.
|
||||
|
||||
Field names can be specified after the package descriptor.
|
||||
For example, to show the dependencies of the `ronn` package at version
|
||||
0.3.5, you could do the following:
|
||||
|
||||
npm.commands.view(["ronn@0.3.5", "dependencies"], callback)
|
||||
|
||||
You can view child field by separating them with a period.
|
||||
To view the git repository URL for the latest version of npm, you could
|
||||
do this:
|
||||
|
||||
npm.commands.view(["npm", "repository.url"], callback)
|
||||
|
||||
For fields that are arrays, requesting a non-numeric field will return
|
||||
all of the values from the objects in the list. For example, to get all
|
||||
the contributor names for the "express" project, you can do this:
|
||||
|
||||
npm.commands.view(["express", "contributors.email"], callback)
|
||||
|
||||
You may also use numeric indices in square braces to specifically select
|
||||
an item in an array field. To just get the email address of the first
|
||||
contributor in the list, you can do this:
|
||||
|
||||
npm.commands.view(["express", "contributors[0].email"], callback)
|
||||
|
||||
Multiple fields may be specified, and will be printed one after another.
|
||||
For exampls, to get all the contributor names and email addresses, you
|
||||
can do this:
|
||||
|
||||
npm.commands.view(["express", "contributors.name", "contributors.email"], callback)
|
||||
|
||||
"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 `npm help json` for more on this.)
|
||||
|
||||
npm.commands.view(["npm", "contributors"], callback)
|
||||
|
||||
If a version range is provided, then data will be printed for every
|
||||
matching version of the package. This will show which version of jsdom
|
||||
was required by each matching version of yui3:
|
||||
|
||||
npm.commands.view(["yui3@>0.5.4", "dependencies.jsdom"], callback)
|
||||
|
||||
## OUTPUT
|
||||
|
||||
If only a single string field for a single version is output, then it
|
||||
will not be colorized or quoted, so as to enable piping the output to
|
||||
another command.
|
||||
|
||||
If the version range matches multiple versions, than each printed value
|
||||
will be prefixed with the version it applies to.
|
||||
|
||||
If multiple fields are requested, than each of them are prefixed with
|
||||
the field name.
|
||||
|
||||
Console output can be disabled by setting the 'silent' parameter to true.
|
||||
|
||||
## RETURN VALUE
|
||||
|
||||
The data returned will be an object in this formation:
|
||||
|
||||
{ <version>:
|
||||
{ <field>: <value>
|
||||
, ... }
|
||||
, ... }
|
||||
|
||||
corresponding to the list of fields selected.
|
15
deps/npm/doc/api/npm-whoami.md
vendored
15
deps/npm/doc/api/npm-whoami.md
vendored
@ -1,15 +0,0 @@
|
||||
npm-whoami(3) -- Display npm username
|
||||
=====================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm.commands.whoami(args, callback)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Print the `username` config to standard output.
|
||||
|
||||
'args' is never used and callback is never called with data.
|
||||
'args' must be present or things will break.
|
||||
|
||||
This function is not useful programmatically
|
115
deps/npm/doc/api/npm.md
vendored
115
deps/npm/doc/api/npm.md
vendored
@ -1,115 +0,0 @@
|
||||
npm(3) -- javascript package manager
|
||||
====================================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
var npm = require("npm")
|
||||
npm.load([configObject, ]function (er, npm) {
|
||||
// use the npm object, now that it's loaded.
|
||||
|
||||
npm.config.set(key, val)
|
||||
val = npm.config.get(key)
|
||||
|
||||
console.log("prefix = %s", npm.prefix)
|
||||
|
||||
npm.commands.install(["package"], cb)
|
||||
})
|
||||
|
||||
## VERSION
|
||||
|
||||
@VERSION@
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This is the API documentation for npm.
|
||||
To find documentation of the command line
|
||||
client, see `npm(1)`.
|
||||
|
||||
Prior to using npm's commands, `npm.load()` must be called. If you provide
|
||||
`configObject` as an object map of top-level configs, they override the values
|
||||
stored in the various config locations. In the npm command line client, this
|
||||
set of configs is parsed from the command line options. Additional
|
||||
configuration params are loaded from two configuration files. See
|
||||
`npm-config(1)`, `npm-config(7)`, and `npmrc(5)` for more information.
|
||||
|
||||
After that, each of the functions are accessible in the
|
||||
commands object: `npm.commands.<cmd>`. See `npm-index(7)` for a list of
|
||||
all possible commands.
|
||||
|
||||
All commands on the command object take an **array** of positional argument
|
||||
**strings**. The last argument to any function is a callback. Some
|
||||
commands take other optional arguments.
|
||||
|
||||
Configs cannot currently be set on a per function basis, as each call to
|
||||
npm.config.set will change the value for *all* npm commands in that process.
|
||||
|
||||
To find API documentation for a specific command, run the `npm apihelp`
|
||||
command.
|
||||
|
||||
## METHODS AND PROPERTIES
|
||||
|
||||
* `npm.load(configs, cb)`
|
||||
|
||||
Load the configuration params, and call the `cb` function once the
|
||||
globalconfig and userconfig files have been loaded as well, or on
|
||||
nextTick if they've already been loaded.
|
||||
|
||||
* `npm.config`
|
||||
|
||||
An object for accessing npm configuration parameters.
|
||||
|
||||
* `npm.config.get(key)`
|
||||
* `npm.config.set(key, val)`
|
||||
* `npm.config.del(key)`
|
||||
|
||||
* `npm.dir` or `npm.root`
|
||||
|
||||
The `node_modules` directory where npm will operate.
|
||||
|
||||
* `npm.prefix`
|
||||
|
||||
The prefix where npm is operating. (Most often the current working
|
||||
directory.)
|
||||
|
||||
* `npm.cache`
|
||||
|
||||
The place where npm keeps JSON and tarballs it fetches from the
|
||||
registry (or uploads to the registry).
|
||||
|
||||
* `npm.tmp`
|
||||
|
||||
npm's temporary working directory.
|
||||
|
||||
* `npm.deref`
|
||||
|
||||
Get the "real" name for a command that has either an alias or
|
||||
abbreviation.
|
||||
|
||||
## MAGIC
|
||||
|
||||
For each of the methods in the `npm.commands` object, a method is added to the
|
||||
npm object, which takes a set of positional string arguments rather than an
|
||||
array and a callback.
|
||||
|
||||
If the last argument is a callback, then it will use the supplied
|
||||
callback. However, if no callback is provided, then it will print out
|
||||
the error or results.
|
||||
|
||||
For example, this would work in a node repl:
|
||||
|
||||
> npm = require("npm")
|
||||
> npm.load() // wait a sec...
|
||||
> npm.install("dnode", "express")
|
||||
|
||||
Note that that *won't* work in a node program, since the `install`
|
||||
method will get called before the configuration load is completed.
|
||||
|
||||
## ABBREVS
|
||||
|
||||
In order to support `npm ins foo` instead of `npm install foo`, the
|
||||
`npm.commands` object has a set of abbreviations as well as the full
|
||||
method names. Use the `npm.deref` method to find the real name.
|
||||
|
||||
For example:
|
||||
|
||||
var cmd = npm.deref("unp") // cmd === "unpublish"
|
2
deps/npm/doc/cli/npm-bin.md
vendored
2
deps/npm/doc/cli/npm-bin.md
vendored
@ -3,7 +3,7 @@ npm-bin(1) -- Display npm bin folder
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm bin
|
||||
npm bin [--global]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
3
deps/npm/doc/cli/npm-bugs.md
vendored
3
deps/npm/doc/cli/npm-bugs.md
vendored
@ -3,8 +3,7 @@ npm-bugs(1) -- Bugs for a package in a web browser maybe
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm bugs <pkgname>
|
||||
npm bugs (with no args in a package dir)
|
||||
npm bugs [<pkgname>]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
2
deps/npm/doc/cli/npm-build.md
vendored
2
deps/npm/doc/cli/npm-build.md
vendored
@ -3,7 +3,7 @@ npm-build(1) -- Build a package
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm build <package-folder>
|
||||
npm build [<package-folder>]
|
||||
|
||||
* `<package-folder>`:
|
||||
A folder containing a `package.json` file in its root.
|
||||
|
7
deps/npm/doc/cli/npm-completion.md
vendored
7
deps/npm/doc/cli/npm-completion.md
vendored
@ -3,7 +3,7 @@ npm-completion(1) -- Tab Completion for npm
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
. <(npm completion)
|
||||
source <(npm completion)
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
@ -12,7 +12,10 @@ Enables tab-completion in all npm commands.
|
||||
The synopsis above
|
||||
loads the completions into your current shell. Adding it to
|
||||
your ~/.bashrc or ~/.zshrc will make the completions available
|
||||
everywhere.
|
||||
everywhere:
|
||||
|
||||
npm completion >> ~/.bashrc
|
||||
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` if you have a system
|
||||
|
1
deps/npm/doc/cli/npm-config.md
vendored
1
deps/npm/doc/cli/npm-config.md
vendored
@ -8,7 +8,6 @@ npm-config(1) -- Manage the npm configuration files
|
||||
npm config delete <key>
|
||||
npm config list
|
||||
npm config edit
|
||||
npm c [set|get|delete|list]
|
||||
npm get <key>
|
||||
npm set <key> <value> [--global]
|
||||
|
||||
|
21
deps/npm/doc/cli/npm-dedupe.md
vendored
21
deps/npm/doc/cli/npm-dedupe.md
vendored
@ -31,25 +31,20 @@ Because of the hierarchical nature of node's module lookup, b and d
|
||||
will both get their dependency met by the single c package at the root
|
||||
level of the tree.
|
||||
|
||||
The deduplication algorithm walks the tree, moving each dependency as far
|
||||
up in the tree as possible, even if duplicates are not found. This will
|
||||
result in both a flat and deduplicated tree.
|
||||
|
||||
If a suitable version exists at the target location in the tree
|
||||
already, then it will be left untouched, but the other duplicates will
|
||||
be deleted.
|
||||
|
||||
If no suitable version can be found, then a warning is printed, and
|
||||
nothing is done.
|
||||
Arguments are ignored. Dedupe always acts on the entire tree.
|
||||
|
||||
If any arguments are supplied, then they are filters, and only the
|
||||
named packages will be touched.
|
||||
Modules
|
||||
|
||||
Note that this operation transforms the dependency tree, and may
|
||||
result in packages getting updated versions, perhaps from the npm
|
||||
registry.
|
||||
|
||||
This feature is experimental, and may change in future versions.
|
||||
|
||||
The `--tag` argument will apply to all of the affected dependencies. If a
|
||||
tag with the given name exists, the tagged version is preferred over newer
|
||||
versions.
|
||||
Note that this operation transforms the dependency tree, but will never
|
||||
result in new modules being installed.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
|
2
deps/npm/doc/cli/npm-deprecate.md
vendored
2
deps/npm/doc/cli/npm-deprecate.md
vendored
@ -3,7 +3,7 @@ npm-deprecate(1) -- Deprecate a version of a package
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm deprecate <name>[@<version>] <message>
|
||||
npm deprecate <pkg>[@<version>] <message>
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
4
deps/npm/doc/cli/npm-docs.md
vendored
4
deps/npm/doc/cli/npm-docs.md
vendored
@ -4,9 +4,9 @@ npm-docs(1) -- Docs for a package in a web browser maybe
|
||||
## SYNOPSIS
|
||||
|
||||
npm docs [<pkgname> [<pkgname> ...]]
|
||||
npm docs (with no args in a package dir)
|
||||
npm docs .
|
||||
npm home [<pkgname> [<pkgname> ...]]
|
||||
npm home (with no args in a package dir)
|
||||
npm home .
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
2
deps/npm/doc/cli/npm-edit.md
vendored
2
deps/npm/doc/cli/npm-edit.md
vendored
@ -3,7 +3,7 @@ npm-edit(1) -- Edit an installed package
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm edit <name>[@<version>]
|
||||
npm edit <pkg>[@<version>]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
2
deps/npm/doc/cli/npm-explore.md
vendored
2
deps/npm/doc/cli/npm-explore.md
vendored
@ -3,7 +3,7 @@ npm-explore(1) -- Browse an installed package
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm explore <name> [ -- <cmd>]
|
||||
npm explore <pkg> [ -- <cmd>]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
2
deps/npm/doc/cli/npm-help-search.md
vendored
2
deps/npm/doc/cli/npm-help-search.md
vendored
@ -3,7 +3,7 @@ npm-help-search(1) -- Search npm help documentation
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm help-search some search terms
|
||||
npm help-search <text>
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
3
deps/npm/doc/cli/npm-help.md
vendored
3
deps/npm/doc/cli/npm-help.md
vendored
@ -3,8 +3,7 @@ npm-help(1) -- Get help on npm
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm help <topic>
|
||||
npm help some search terms
|
||||
npm help <term> [<terms..>]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
2
deps/npm/doc/cli/npm-init.md
vendored
2
deps/npm/doc/cli/npm-init.md
vendored
@ -3,7 +3,7 @@ npm-init(1) -- Interactively create a package.json file
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm init [-f|--force|-y|--yes]
|
||||
npm init [--force|-f|--yes|-y]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
76
deps/npm/doc/cli/npm-install.md
vendored
76
deps/npm/doc/cli/npm-install.md
vendored
@ -3,15 +3,17 @@ npm-install(1) -- Install a package
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm install (with no args in a package dir)
|
||||
npm install (with no args, in package dir)
|
||||
npm install [<@scope>/]<name>
|
||||
npm install [<@scope>/]<name>@<tag>
|
||||
npm install [<@scope>/]<name>@<version>
|
||||
npm install [<@scope>/]<name>@<version range>
|
||||
npm install <tarball file>
|
||||
npm install <tarball url>
|
||||
npm install <folder>
|
||||
npm install [@<scope>/]<name> [--save|--save-dev|--save-optional] [--save-exact]
|
||||
npm install [@<scope>/]<name>@<tag>
|
||||
npm install [@<scope>/]<name>@<version>
|
||||
npm install [@<scope>/]<name>@<version range>
|
||||
npm i (with any of the previous argument usage)
|
||||
|
||||
alias: npm i
|
||||
common options: [--save|--save-dev|--save-optional] [--save-exact] [--dry-run]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
@ -27,7 +29,7 @@ A `package` is:
|
||||
* d) a `<name>@<version>` that is published on the registry (see `npm-registry(7)`) with (c)
|
||||
* e) a `<name>@<tag>` that points to (d)
|
||||
* f) a `<name>` that has a "latest" tag satisfying (e)
|
||||
* g) a `<git remote url>` that resolves to (b)
|
||||
* g) a `<git remote url>` that resolves to (a)
|
||||
|
||||
Even if you never publish your package, you can still get a lot of
|
||||
benefits of using npm if you just want to write a node program (a), and
|
||||
@ -71,7 +73,7 @@ after packing it up into a tarball (b).
|
||||
|
||||
npm install https://github.com/indexzero/forever/tarball/v0.5.6
|
||||
|
||||
* `npm install [@<scope>/]<name> [--save|--save-dev|--save-optional]`:
|
||||
* `npm install [<@scope>/]<name> [--save|--save-dev|--save-optional]`:
|
||||
|
||||
Do a `<name>@<tag>` install, where `<tag>` is the "tag" config. (See
|
||||
`npm-config(7)`.)
|
||||
@ -99,6 +101,9 @@ after packing it up into a tarball (b).
|
||||
exact version rather than using npm's default semver range
|
||||
operator.
|
||||
|
||||
Further, if you have an `npm-shrinkwrap.json` then it will be updated as
|
||||
well.
|
||||
|
||||
`<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(7)`.
|
||||
@ -121,7 +126,7 @@ after packing it up into a tarball (b).
|
||||
working directory, then it will try to install that, and only try to
|
||||
fetch the package by name if it is not valid.
|
||||
|
||||
* `npm install [@<scope>/]<name>@<tag>`:
|
||||
* `npm install [<@scope>/]<name>@<tag>`:
|
||||
|
||||
Install the version of the package that is referenced by the specified tag.
|
||||
If the tag does not exist in the registry data for that package, then this
|
||||
@ -132,7 +137,7 @@ after packing it up into a tarball (b).
|
||||
npm install sax@latest
|
||||
npm install @myorg/mypackage@latest
|
||||
|
||||
* `npm install [@<scope>/]<name>@<version>`:
|
||||
* `npm install [<@scope>/]<name>@<version>`:
|
||||
|
||||
Install the specified version of the package. This will fail if the
|
||||
version has not been published to the registry.
|
||||
@ -142,7 +147,7 @@ after packing it up into a tarball (b).
|
||||
npm install sax@0.1.1
|
||||
npm install @myorg/privatepackage@1.5.0
|
||||
|
||||
* `npm install [@<scope>/]<name>@<version range>`:
|
||||
* `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(5)`.
|
||||
@ -157,10 +162,10 @@ after packing it up into a tarball (b).
|
||||
|
||||
* `npm install <git remote url>`:
|
||||
|
||||
Install a package by cloning a git remote url. The format of the git
|
||||
url is:
|
||||
Installs the package from the hosted git provider, cloning it with
|
||||
`git`. First it tries via the https (git with github) and if that fails, via ssh.
|
||||
|
||||
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:/]<path>[#<commit-ish>]
|
||||
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish>]
|
||||
|
||||
`<protocol>` is one of `git`, `git+ssh`, `git+http`, or
|
||||
`git+https`. If no `<commit-ish>` is specified, then `master` is
|
||||
@ -241,6 +246,9 @@ The `--tag` argument will apply to all of the specified install targets. If a
|
||||
tag with the given name exists, the tagged version is preferred over newer
|
||||
versions.
|
||||
|
||||
The `--dry-run` argument will report in the usual way what the install would
|
||||
have done without actually installing anything.
|
||||
|
||||
The `--force` argument will force npm to fetch remote resources even if a
|
||||
local copy exists on disk.
|
||||
|
||||
@ -264,6 +272,9 @@ shrinkwrap file and use the package.json instead.
|
||||
The `--nodedir=/path/to/node/source` argument will allow npm to find the
|
||||
node source code so that npm can compile native modules.
|
||||
|
||||
The `--only={prod[uction]|dev[elopment]}` argument will cause either only
|
||||
`devDependencies` or only non-`devDependencies` to be installed.
|
||||
|
||||
See `npm-config(7)`. Many of the configuration params have some
|
||||
effect on installation, since that's most of what npm does.
|
||||
|
||||
@ -271,26 +282,39 @@ effect on installation, since that's most of what npm does.
|
||||
|
||||
To install a package, npm uses the following algorithm:
|
||||
|
||||
install(where, what, family, ancestors)
|
||||
fetch what, unpack to <where>/node_modules/<what>
|
||||
for each dep in what.dependencies
|
||||
resolve dep to precise version
|
||||
for each dep@version in what.dependencies
|
||||
not in <where>/node_modules/<what>/node_modules/*
|
||||
and not in <family>
|
||||
add precise version deps to <family>
|
||||
install(<where>/node_modules/<what>, dep, family)
|
||||
load the existing node_modules tree from disk
|
||||
clone the tree
|
||||
fetch the package.json and assorted metadata and add it to the clone
|
||||
walk the clone and add any missing dependencies
|
||||
dependencies will be added as close to the top as is possible
|
||||
without breaking any other modules
|
||||
compare the original tree with the cloned tree and make a list of
|
||||
actions to take to convert one to the other
|
||||
execute all of the actions, deepest first
|
||||
kinds of actions are install, update, remove and move
|
||||
|
||||
For this `package{dep}` structure: `A{B,C}, B{C}, C{D}`,
|
||||
this algorithm produces:
|
||||
|
||||
A
|
||||
+-- B
|
||||
`-- C
|
||||
`-- D
|
||||
+-- C
|
||||
+-- D
|
||||
|
||||
That is, the dependency from B to C is satisfied by the fact that A
|
||||
already caused C to be installed at a higher level.
|
||||
already caused C to be installed at a higher level. D is still installed
|
||||
at the top level because nothing conflicts with it.
|
||||
|
||||
For `A{B,C}, B{C,D@1}, C{D@2}`, this algorithm produces:
|
||||
|
||||
A
|
||||
+-- B
|
||||
+-- C
|
||||
`-- D@2
|
||||
+-- D@1
|
||||
|
||||
Because B's D@1 will be installed in the top leve, C now has to install D@2
|
||||
privately for itself.
|
||||
|
||||
See npm-folders(5) for a more detailed description of the specific
|
||||
folder structures that npm creates.
|
||||
|
7
deps/npm/doc/cli/npm-link.md
vendored
7
deps/npm/doc/cli/npm-link.md
vendored
@ -3,9 +3,10 @@ npm-link(1) -- Symlink a package folder
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm link (in package folder)
|
||||
npm link [@<scope>/]<pkgname>
|
||||
npm ln (with any of the previous argument usage)
|
||||
npm link (in package dir)
|
||||
npm link [<@scope>/]<pkg>[@<version>]
|
||||
|
||||
alias: npm ln
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
2
deps/npm/doc/cli/npm-logout.md
vendored
2
deps/npm/doc/cli/npm-logout.md
vendored
@ -3,7 +3,7 @@ npm-logout(1) -- Log out of the registry
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm logout [--registry=url] [--scope=@orgname]
|
||||
npm logout [--registry=<url>] [--scope=<@scope>]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
18
deps/npm/doc/cli/npm-ls.md
vendored
18
deps/npm/doc/cli/npm-ls.md
vendored
@ -3,10 +3,9 @@ npm-ls(1) -- List installed packages
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm list [[@<scope>/]<pkg> ...]
|
||||
npm ls [[@<scope>/]<pkg> ...]
|
||||
npm la [[@<scope>/]<pkg> ...]
|
||||
npm ll [[@<scope>/]<pkg> ...]
|
||||
npm ls [[<@scope>/]<pkg> ...]
|
||||
|
||||
aliases: list, la, ll
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
@ -28,6 +27,9 @@ If a project specifies git urls for dependencies these are shown
|
||||
in parentheses after the name@version to make it easier for users to
|
||||
recognize potential forks of a project.
|
||||
|
||||
The tree shown is the logical dependency tree, based on package
|
||||
dependencies, not the physical layout of your node_modules folder.
|
||||
|
||||
When run as `ll` or `la`, it shows extended information by default.
|
||||
|
||||
## CONFIGURATION
|
||||
@ -81,6 +83,14 @@ Display only the dependency tree for packages in `dependencies`.
|
||||
|
||||
Display only the dependency tree for packages in `devDependencies`.
|
||||
|
||||
### only
|
||||
|
||||
* Type: String
|
||||
|
||||
When "dev" or "development", is an alias to `dev`.
|
||||
|
||||
When "prod" or "production", is an alias to `production`.`
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm-config(1)
|
||||
|
2
deps/npm/doc/cli/npm-outdated.md
vendored
2
deps/npm/doc/cli/npm-outdated.md
vendored
@ -3,7 +3,7 @@ npm-outdated(1) -- Check for outdated packages
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm outdated [<name> [<name> ...]]
|
||||
npm outdated [[<@scope>/]<pkg> ...]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
6
deps/npm/doc/cli/npm-owner.md
vendored
6
deps/npm/doc/cli/npm-owner.md
vendored
@ -3,9 +3,9 @@ npm-owner(1) -- Manage package owners
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm owner ls <package name>
|
||||
npm owner add <user> <package name>
|
||||
npm owner rm <user> <package name>
|
||||
npm owner add <user> [<@scope>/]<pkg>
|
||||
npm owner rm <user> [<@scope>/]<pkg>
|
||||
npm owner ls [<@scope>/]<pkg>
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
10
deps/npm/doc/cli/npm-pack.md
vendored
10
deps/npm/doc/cli/npm-pack.md
vendored
@ -3,15 +3,15 @@ npm-pack(1) -- Create a tarball from a package
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm pack [<pkg> [<pkg> ...]]
|
||||
npm pack [[<@scope>/]<pkg>...]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
For anything that's installable (that is, a package folder, tarball,
|
||||
tarball url, name@tag, name@version, or name), this command will fetch
|
||||
it to the cache, and then copy the tarball to the current working
|
||||
directory as `<name>-<version>.tgz`, and then write the filenames out to
|
||||
stdout.
|
||||
tarball url, name@tag, name@version, name, or scoped name), this
|
||||
command will fetch it to the cache, and then copy the tarball to the
|
||||
current working directory as `<name>-<version>.tgz`, and then write
|
||||
the filenames out to stdout.
|
||||
|
||||
If the same package is specified multiple times, then the file will be
|
||||
overwritten the second time.
|
||||
|
3
deps/npm/doc/cli/npm-prune.md
vendored
3
deps/npm/doc/cli/npm-prune.md
vendored
@ -3,8 +3,7 @@ npm-prune(1) -- Remove extraneous packages
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm prune [<name> [<name ...]]
|
||||
npm prune [<name> [<name ...]] [--production]
|
||||
npm prune [[<@scope>/]<pkg>...] [--production]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
6
deps/npm/doc/cli/npm-publish.md
vendored
6
deps/npm/doc/cli/npm-publish.md
vendored
@ -4,8 +4,10 @@ npm-publish(1) -- Publish a package
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm publish <tarball> [--tag <tag>] [--access <public|restricted>]
|
||||
npm publish <folder> [--tag <tag>] [--access <public|restricted>]
|
||||
npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>]
|
||||
|
||||
Publishes '.' if no argument supplied
|
||||
Sets tag 'latest' if no --tag specified
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
6
deps/npm/doc/cli/npm-rebuild.md
vendored
6
deps/npm/doc/cli/npm-rebuild.md
vendored
@ -3,11 +3,9 @@ npm-rebuild(1) -- Rebuild a package
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm rebuild [<name> [<name> ...]]
|
||||
npm rb [<name> [<name> ...]]
|
||||
npm rebuild [[<@scope>/<name>]...]
|
||||
|
||||
* `<name>`:
|
||||
The package to rebuild
|
||||
alias: npm rb
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
3
deps/npm/doc/cli/npm-repo.md
vendored
3
deps/npm/doc/cli/npm-repo.md
vendored
@ -3,8 +3,7 @@ npm-repo(1) -- Open package repository page in the browser
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm repo <pkgname>
|
||||
npm repo (with no args in a package dir)
|
||||
npm repo [<pkg>]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
23
deps/npm/doc/cli/npm-rm.md
vendored
23
deps/npm/doc/cli/npm-rm.md
vendored
@ -1,23 +0,0 @@
|
||||
npm-rm(1) -- Remove a package
|
||||
=============================
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm rm <name>
|
||||
npm r <name>
|
||||
npm uninstall <name>
|
||||
npm un <name>
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This uninstalls a package, completely removing everything npm installed
|
||||
on its behalf.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm-prune(1)
|
||||
* npm-install(1)
|
||||
* npm-folders(5)
|
||||
* npm-config(1)
|
||||
* npm-config(7)
|
||||
* npmrc(5)
|
2
deps/npm/doc/cli/npm-root.md
vendored
2
deps/npm/doc/cli/npm-root.md
vendored
@ -3,7 +3,7 @@ npm-root(1) -- Display npm root
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm root
|
||||
npm root [-g]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
5
deps/npm/doc/cli/npm-run-script.md
vendored
5
deps/npm/doc/cli/npm-run-script.md
vendored
@ -3,8 +3,9 @@ npm-run-script(1) -- Run arbitrary package scripts
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm run-script [command] [-- <args>]
|
||||
npm run [command] [-- <args>]
|
||||
npm run-script <command> [-- <args>...]
|
||||
|
||||
alias: npm run
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
4
deps/npm/doc/cli/npm-search.md
vendored
4
deps/npm/doc/cli/npm-search.md
vendored
@ -4,8 +4,8 @@ npm-search(1) -- Search for packages
|
||||
## SYNOPSIS
|
||||
|
||||
npm search [--long] [search terms ...]
|
||||
npm s [search terms ...]
|
||||
npm se [search terms ...]
|
||||
|
||||
aliases: s, se
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
38
deps/npm/doc/cli/npm-shrinkwrap.md
vendored
38
deps/npm/doc/cli/npm-shrinkwrap.md
vendored
@ -82,29 +82,32 @@ This generates `npm-shrinkwrap.json`, which will look something like this:
|
||||
|
||||
{
|
||||
"name": "A",
|
||||
"version": "0.1.0",
|
||||
"version": "1.1.0",
|
||||
"dependencies": {
|
||||
"B": {
|
||||
"version": "0.0.1",
|
||||
"version": "1.0.1",
|
||||
"from": "B@^1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/B/-/B-1.0.1.tgz",
|
||||
"dependencies": {
|
||||
"C": {
|
||||
"version": "0.0.1"
|
||||
"version": "1.0.1",
|
||||
"from": "org/C#v1.0.1",
|
||||
"resolved": "git://github.com/org/C.git#5c380ae319fc4efe9e7f2d9c78b0faa588fd99b4"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
The shrinkwrap command has locked down the dependencies based on
|
||||
what's currently installed in node_modules. When `npm install`
|
||||
installs a package with an `npm-shrinkwrap.json` in the package
|
||||
root, the shrinkwrap file (rather than `package.json` files) completely
|
||||
drives the installation of that package and all of its dependencies
|
||||
(recursively). So now the author publishes A@0.1.0, and subsequent
|
||||
installs of this package will use B@0.0.1 and C@0.0.1, regardless the
|
||||
dependencies and versions listed in A's, B's, and C's `package.json`
|
||||
files.
|
||||
The shrinkwrap command has locked down the dependencies based on what's
|
||||
currently installed in `node_modules`. The installation behavior is changed to:
|
||||
|
||||
1. The module tree described by the shrinkwrap is reproduced. This means
|
||||
reproducing the structure described in the file, using the specific files
|
||||
referenced in "resolved" if available, falling back to normal package
|
||||
resolution using "version" if one isn't.
|
||||
|
||||
2. The tree is walked and any missing dependencies are installed in the usual fasion.
|
||||
|
||||
### Using shrinkwrapped packages
|
||||
|
||||
@ -126,15 +129,14 @@ To add or update a dependency in a shrinkwrapped package:
|
||||
|
||||
1. Run `npm install` in the package root to install the current
|
||||
versions of all dependencies.
|
||||
2. Add or update dependencies. `npm install` each new or updated
|
||||
package individually and then update `package.json`. Note that they
|
||||
must be explicitly named in order to be installed: running `npm
|
||||
install` with no arguments will merely reproduce the existing
|
||||
2. Add or update dependencies. `npm install --save` each new or updated
|
||||
package individually to update the `package.json` and the shrinkwrap.
|
||||
Note that they must be explicitly named in order to be installed: running
|
||||
`npm install` with no arguments will merely reproduce the existing
|
||||
shrinkwrap.
|
||||
3. Validate that the package works as expected with the new
|
||||
dependencies.
|
||||
4. Run `npm shrinkwrap`, commit the new `npm-shrinkwrap.json`, and
|
||||
publish your package.
|
||||
4. Commit the new `npm-shrinkwrap.json`, and publish your package.
|
||||
|
||||
You can use npm-outdated(1) to view dependencies with newer versions
|
||||
available.
|
||||
|
4
deps/npm/doc/cli/npm-star.md
vendored
4
deps/npm/doc/cli/npm-star.md
vendored
@ -3,8 +3,8 @@ npm-star(1) -- Mark your favorite packages
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm star <pkgname> [<pkg>, ...]
|
||||
npm unstar <pkgname> [<pkg>, ...]
|
||||
npm star [<pkg>...]
|
||||
npm unstar [<pkg>...]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
3
deps/npm/doc/cli/npm-stars.md
vendored
3
deps/npm/doc/cli/npm-stars.md
vendored
@ -3,8 +3,7 @@ npm-stars(1) -- View packages marked as favorites
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm stars
|
||||
npm stars [username]
|
||||
npm stars [<user>]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
3
deps/npm/doc/cli/npm-tag.md
vendored
3
deps/npm/doc/cli/npm-tag.md
vendored
@ -3,7 +3,8 @@ npm-tag(1) -- Tag a published version
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm tag <name>@<version> [<tag>]
|
||||
[DEPRECATED] npm tag <name>@<version> [<tag>]
|
||||
See `dist-tag`
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
8
deps/npm/doc/cli/npm-uninstall.md
vendored
8
deps/npm/doc/cli/npm-uninstall.md
vendored
@ -3,8 +3,9 @@ npm-rm(1) -- Remove a package
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm uninstall [@<scope>/]<package> [--save|--save-dev|--save-optional]
|
||||
npm rm (with any of the previous argument usage)
|
||||
npm uninstall [<@scope>/]<pkg>[@<version>]... [--save|--save-dev|--save-optional]
|
||||
|
||||
aliases: remove, rm, r, un, unlink
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
@ -27,6 +28,9 @@ the package version in your main package.json:
|
||||
|
||||
* `--save-optional`: Package will be removed from your `optionalDependencies`.
|
||||
|
||||
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(7)`.
|
||||
|
||||
Examples:
|
||||
|
2
deps/npm/doc/cli/npm-unpublish.md
vendored
2
deps/npm/doc/cli/npm-unpublish.md
vendored
@ -3,7 +3,7 @@ npm-unpublish(1) -- Remove a package from the registry
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm unpublish [@<scope>/]<name>[@<version>]
|
||||
npm unpublish [<@scope>/]<pkg>[@<version>]
|
||||
|
||||
## WARNING
|
||||
|
||||
|
2
deps/npm/doc/cli/npm-update.md
vendored
2
deps/npm/doc/cli/npm-update.md
vendored
@ -3,7 +3,7 @@ npm-update(1) -- Update a package
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm update [-g] [<name> [<name> ...]]
|
||||
npm update [-g] [<pkg>...]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
4
deps/npm/doc/cli/npm-version.md
vendored
4
deps/npm/doc/cli/npm-version.md
vendored
@ -5,6 +5,10 @@ npm-version(1) -- Bump a package version
|
||||
|
||||
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease]
|
||||
|
||||
'npm -v' or 'npm --version' to print npm version
|
||||
'npm view <pkg> version' to view a package's published version
|
||||
'npm ls' to inspect current package/dependency versions
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
Run this in a package directory to bump the version and write the new
|
||||
|
5
deps/npm/doc/cli/npm-view.md
vendored
5
deps/npm/doc/cli/npm-view.md
vendored
@ -3,8 +3,9 @@ npm-view(1) -- View registry info
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm view [@<scope>/]<name>[@<version>] [<field>[.<subfield>]...]
|
||||
npm v [@<scope>/]<name>[@<version>] [<field>[.<subfield>]...]
|
||||
npm view [<@scope>/]<name>[@<version>] [<field>[.<subfield>]...]
|
||||
|
||||
aliases: info, show, v
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
2
deps/npm/doc/cli/npm-whoami.md
vendored
2
deps/npm/doc/cli/npm-whoami.md
vendored
@ -3,7 +3,7 @@ npm-whoami(1) -- Display npm username
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm whoami
|
||||
npm whoami [--registry <registry>]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
|
13
deps/npm/doc/files/package.json.md
vendored
13
deps/npm/doc/files/package.json.md
vendored
@ -626,17 +626,10 @@ field is advisory only.
|
||||
|
||||
## engineStrict
|
||||
|
||||
**NOTE: This feature is deprecated and will be removed in npm 3.0.0.**
|
||||
**This feature was deprecated with npm 3.0.0**
|
||||
|
||||
If you are sure that your module will *definitely not* run properly on
|
||||
versions of Node/npm other than those specified in the `engines` object,
|
||||
then you can set `"engineStrict": true` in your package.json file.
|
||||
This will override the user's `engine-strict` config setting.
|
||||
|
||||
Please do not do this unless you are really very very sure. If your
|
||||
engines object is something overly restrictive, you can quite easily and
|
||||
inadvertently lock yourself into obscurity and prevent your users from
|
||||
updating to new versions of Node. Consider this choice carefully.
|
||||
Prior to npm 3.0.0, this feature was used to treat this package as if the
|
||||
user had set `engine-strict`.
|
||||
|
||||
## os
|
||||
|
||||
|
62
deps/npm/doc/misc/npm-config.md
vendored
62
deps/npm/doc/misc/npm-config.md
vendored
@ -28,7 +28,7 @@ The four relevant files are:
|
||||
|
||||
* per-project config file (/path/to/my/project/.npmrc)
|
||||
* per-user config file (~/.npmrc)
|
||||
* global config file ($PREFIX/npmrc)
|
||||
* global config file ($PREFIX/etc/npmrc)
|
||||
* npm builtin config file (/path/to/npm/npmrc)
|
||||
|
||||
See npmrc(5) for more details.
|
||||
@ -124,6 +124,14 @@ you want your scoped package to be publicly viewable (and installable) set
|
||||
Force npm to always require authentication when accessing the registry,
|
||||
even for `GET` requests.
|
||||
|
||||
### also
|
||||
|
||||
* Default: null
|
||||
* Type: String
|
||||
|
||||
When "dev" or "development" and running local `npm shrinkwrap`,
|
||||
`npm outdated`, or `npm update`, is an alias for `--dev`.
|
||||
|
||||
### bin-links
|
||||
|
||||
* Default: `true`
|
||||
@ -268,6 +276,17 @@ Install `dev-dependencies` along with packages.
|
||||
Note that `dev-dependencies` are also installed if the `npat` flag is
|
||||
set.
|
||||
|
||||
### dry-run
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Indicates that you don't want npm to make any changes and that it should
|
||||
only report what it would have done. This can be passed into any of the
|
||||
commands that modify your local installation, eg, `install`, `update`,
|
||||
`dedupe`, `uninstall`. This is NOT currently honored by network related
|
||||
commands, eg `dist-tags`, `owner`, `publish`, etc.
|
||||
|
||||
### editor
|
||||
|
||||
* Default: `EDITOR` environment variable if set, or `"vi"` on Posix,
|
||||
@ -561,6 +580,24 @@ Run tests on installation.
|
||||
A node module to `require()` when npm loads. Useful for programmatic
|
||||
usage.
|
||||
|
||||
### only
|
||||
|
||||
* Default: null
|
||||
* Type: String
|
||||
|
||||
When "dev" or "development" and running local `npm install` without any
|
||||
arguments, only devDependencies (and their dependencies) are installed.
|
||||
|
||||
When "dev" or "development" and running local `npm ls`, `npm outdated`, or
|
||||
`npm update`, is an alias for `--dev`.
|
||||
|
||||
When "prod" or "production" and running local `npm install` without any
|
||||
arguments, only non-devDependencies (and their dependencies) are
|
||||
installed.
|
||||
|
||||
When "prod" or "production" and running local `npm ls`, `npm outdated`, or
|
||||
`npm update`, is an alias for `--production`.
|
||||
|
||||
### optional
|
||||
|
||||
* Default: true
|
||||
@ -597,6 +634,16 @@ Set to true to run in "production" mode.
|
||||
local `npm install` without any arguments.
|
||||
2. Set the NODE_ENV="production" for lifecycle scripts.
|
||||
|
||||
### progress
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When set to `true`, npm will display a progress bar during time intensive
|
||||
operations, if `process.stderr` is a TTY.
|
||||
|
||||
Set to `false` to suppress the progress bar.
|
||||
|
||||
### proprietary-attribs
|
||||
|
||||
* Default: true
|
||||
@ -772,17 +819,6 @@ using `-s` to add a signature.
|
||||
Note that git requires you to have set up GPG keys in your git configs
|
||||
for this to work properly.
|
||||
|
||||
### spin
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean or `"always"`
|
||||
|
||||
When set to `true`, npm will display an ascii spinner while it is doing
|
||||
things, if `process.stderr` is a TTY.
|
||||
|
||||
Set to `false` to suppress the spinner, or set to `always` to output
|
||||
the spinner even for non-TTY outputs.
|
||||
|
||||
### strict-ssl
|
||||
|
||||
* Default: true
|
||||
@ -827,7 +863,7 @@ on success, but left behind on failure for forensic purposes.
|
||||
|
||||
### unicode
|
||||
|
||||
* Default: true
|
||||
* Default: true on windows and mac/unix systems with a unicode locale
|
||||
* Type: Boolean
|
||||
|
||||
When set to true, npm uses unicode characters in the tree output. When
|
||||
|
168
deps/npm/doc/misc/npm-index.md
vendored
168
deps/npm/doc/misc/npm-index.md
vendored
@ -141,10 +141,6 @@ Open package repository page in the browser
|
||||
|
||||
Restart a package
|
||||
|
||||
### npm-rm(1)
|
||||
|
||||
Remove a package
|
||||
|
||||
### npm-root(1)
|
||||
|
||||
Display npm root
|
||||
@ -217,166 +213,6 @@ Display npm username
|
||||
|
||||
Using npm in your Node programs
|
||||
|
||||
### npm(3)
|
||||
|
||||
javascript package manager
|
||||
|
||||
### npm-bin(3)
|
||||
|
||||
Display npm bin folder
|
||||
|
||||
### npm-bugs(3)
|
||||
|
||||
Bugs for a package in a web browser maybe
|
||||
|
||||
### npm-cache(3)
|
||||
|
||||
manage the npm cache programmatically
|
||||
|
||||
### npm-commands(3)
|
||||
|
||||
npm commands
|
||||
|
||||
### npm-config(3)
|
||||
|
||||
Manage the npm configuration files
|
||||
|
||||
### npm-deprecate(3)
|
||||
|
||||
Deprecate a version of a package
|
||||
|
||||
### npm-docs(3)
|
||||
|
||||
Docs for a package in a web browser maybe
|
||||
|
||||
### npm-edit(3)
|
||||
|
||||
Edit an installed package
|
||||
|
||||
### npm-explore(3)
|
||||
|
||||
Browse an installed package
|
||||
|
||||
### npm-help-search(3)
|
||||
|
||||
Search the help pages
|
||||
|
||||
### npm-init(3)
|
||||
|
||||
Interactively create a package.json file
|
||||
|
||||
### npm-install(3)
|
||||
|
||||
install a package programmatically
|
||||
|
||||
### npm-link(3)
|
||||
|
||||
Symlink a package folder
|
||||
|
||||
### npm-load(3)
|
||||
|
||||
Load config settings
|
||||
|
||||
### npm-ls(3)
|
||||
|
||||
List installed packages
|
||||
|
||||
### npm-outdated(3)
|
||||
|
||||
Check for outdated packages
|
||||
|
||||
### npm-owner(3)
|
||||
|
||||
Manage package owners
|
||||
|
||||
### npm-pack(3)
|
||||
|
||||
Create a tarball from a package
|
||||
|
||||
### npm-ping(3)
|
||||
|
||||
Ping npm registry
|
||||
|
||||
### npm-prefix(3)
|
||||
|
||||
Display prefix
|
||||
|
||||
### npm-prune(3)
|
||||
|
||||
Remove extraneous packages
|
||||
|
||||
### npm-publish(3)
|
||||
|
||||
Publish a package
|
||||
|
||||
### npm-rebuild(3)
|
||||
|
||||
Rebuild a package
|
||||
|
||||
### npm-repo(3)
|
||||
|
||||
Open package repository page in the browser
|
||||
|
||||
### npm-restart(3)
|
||||
|
||||
Restart a package
|
||||
|
||||
### npm-root(3)
|
||||
|
||||
Display npm root
|
||||
|
||||
### npm-run-script(3)
|
||||
|
||||
Run arbitrary package scripts
|
||||
|
||||
### npm-search(3)
|
||||
|
||||
Search for packages
|
||||
|
||||
### npm-shrinkwrap(3)
|
||||
|
||||
programmatically generate package shrinkwrap file
|
||||
|
||||
### npm-start(3)
|
||||
|
||||
Start a package
|
||||
|
||||
### npm-stop(3)
|
||||
|
||||
Stop a package
|
||||
|
||||
### npm-tag(3)
|
||||
|
||||
Tag a published version
|
||||
|
||||
### npm-test(3)
|
||||
|
||||
Test a package
|
||||
|
||||
### npm-uninstall(3)
|
||||
|
||||
uninstall a package programmatically
|
||||
|
||||
### npm-unpublish(3)
|
||||
|
||||
Remove a package from the registry
|
||||
|
||||
### npm-update(3)
|
||||
|
||||
Update a package
|
||||
|
||||
### npm-version(3)
|
||||
|
||||
Bump a package version
|
||||
|
||||
### npm-view(3)
|
||||
|
||||
View registry info
|
||||
|
||||
### npm-whoami(3)
|
||||
|
||||
Display npm username
|
||||
|
||||
## Files
|
||||
|
||||
File system structures npm uses
|
||||
@ -421,10 +257,6 @@ Frequently Asked Questions
|
||||
|
||||
Index of all npm documentation
|
||||
|
||||
### npm-orgs(7)
|
||||
|
||||
Working with Teams & Orgs
|
||||
|
||||
### npm-registry(7)
|
||||
|
||||
The JavaScript Package Registry
|
||||
|
90
deps/npm/doc/misc/npm-orgs.md
vendored
90
deps/npm/doc/misc/npm-orgs.md
vendored
@ -1,90 +0,0 @@
|
||||
npm-orgs(7) -- Working with Teams & Orgs
|
||||
========================================
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
There are three levels of org users:
|
||||
|
||||
1. Super admin, controls billing & adding people to the org.
|
||||
2. Team admin, manages team membership & package access.
|
||||
3. Developer, works on packages they are given access to.
|
||||
|
||||
The super admin is the only person who can add users to the org because it impacts the monthly bill. The super admin will use the website to manage membership. Every org has a `developers` team that all users are automatically added to.
|
||||
|
||||
The team admin is the person who manages team creation, team membership, and package access for teams. The team admin grants package access to teams, not individuals.
|
||||
|
||||
The developer will be able to access packages based on the teams they are on. Access is either read-write or read-only.
|
||||
|
||||
There are two main commands:
|
||||
|
||||
1. `npm team` see npm-access(1) for more details
|
||||
2. `npm access` see npm-team(1) for more details
|
||||
|
||||
## Team Admins create teams
|
||||
|
||||
* Check who you’ve added to your org:
|
||||
|
||||
```
|
||||
npm team ls <org>:developers
|
||||
```
|
||||
|
||||
* Each org is automatically given a `developers` team, so you can see the whole list of team members in your org. This team automatically gets read-write access to all packages, but you can change that with the `access` command.
|
||||
|
||||
* Create a new team:
|
||||
|
||||
```
|
||||
npm team create <org:team>
|
||||
```
|
||||
|
||||
* Add members to that team:
|
||||
|
||||
```
|
||||
npm team add <org:team> <user>
|
||||
```
|
||||
|
||||
## Publish a package and adjust package access
|
||||
|
||||
* In package directory, run
|
||||
|
||||
```
|
||||
npm init --scope=<org>
|
||||
```
|
||||
to scope it for your org & publish as usual
|
||||
|
||||
* Grant access:
|
||||
|
||||
```
|
||||
npm access grant <read-only|read-write> <org:team> [<package>]
|
||||
```
|
||||
|
||||
* Revoke access:
|
||||
|
||||
```
|
||||
npm access revoke <org:team> [<package>]
|
||||
```
|
||||
|
||||
## Monitor your package access
|
||||
|
||||
* See what org packages a team member can access:
|
||||
|
||||
```
|
||||
npm access ls-packages <org> <user>
|
||||
```
|
||||
|
||||
* See packages available to a specific team:
|
||||
|
||||
```
|
||||
npm access ls-packages <org:team>
|
||||
```
|
||||
|
||||
* Check which teams are collaborating on a package:
|
||||
|
||||
```
|
||||
npm access ls-collaborators <pkg>
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm-team(1)
|
||||
* npm-access(1)
|
||||
* npm-scope(7)
|
4
deps/npm/html/doc/README.html
vendored
4
deps/npm/html/doc/README.html
vendored
@ -140,7 +140,7 @@ specific purpose, or lack of malice in any given npm package.</p>
|
||||
<p>If you have a complaint about a package in the public npm registry,
|
||||
and cannot <a href="https://docs.npmjs.com/misc/disputes">resolve it with the package
|
||||
owner</a>, please email
|
||||
<a href="mailto:support@npmjs.com">support@npmjs.com</a> and explain the situation.</p>
|
||||
<a href="mailto:support@npmjs.com">support@npmjs.com</a> and explain the situation.</p>
|
||||
<p>Any data published to The npm Registry (including user account
|
||||
information) may be removed or modified at the sole discretion of the
|
||||
npm server administrators.</p>
|
||||
@ -183,5 +183,5 @@ will no doubt tell you to put the output in a gist or email.</p>
|
||||
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
|
||||
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
|
||||
</table>
|
||||
<p id="footer"><a href="../doc/README.html">README</a> — npm@2.14.7</p>
|
||||
<p id="footer"><a href="../doc/README.html">README</a> — npm@3.3.6</p>
|
||||
|
||||
|
2
deps/npm/html/doc/api/npm-bin.html
vendored
2
deps/npm/html/doc/api/npm-bin.html
vendored
@ -28,5 +28,5 @@ to the <code>npm.bin</code> property.</p>
|
||||
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
|
||||
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
|
||||
</table>
|
||||
<p id="footer">npm-bin — npm@2.14.7</p>
|
||||
<p id="footer">npm-bin — npm@3.3.0</p>
|
||||
|
||||
|
2
deps/npm/html/doc/api/npm-bugs.html
vendored
2
deps/npm/html/doc/api/npm-bugs.html
vendored
@ -33,5 +33,5 @@ friendly for programmatic use.</p>
|
||||
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
|
||||
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
|
||||
</table>
|
||||
<p id="footer">npm-bugs — npm@2.14.7</p>
|
||||
<p id="footer">npm-bugs — npm@3.3.0</p>
|
||||
|
||||
|
2
deps/npm/html/doc/api/npm-cache.html
vendored
2
deps/npm/html/doc/api/npm-cache.html
vendored
@ -42,5 +42,5 @@ incrementation.</p>
|
||||
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
|
||||
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
|
||||
</table>
|
||||
<p id="footer">npm-cache — npm@2.14.7</p>
|
||||
<p id="footer">npm-cache — npm@3.3.0</p>
|
||||
|
||||
|
2
deps/npm/html/doc/api/npm-commands.html
vendored
2
deps/npm/html/doc/api/npm-commands.html
vendored
@ -36,5 +36,5 @@ usage, or <code>man 3 npm-<command></code> for programmatic usage.</p>
|
||||
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
|
||||
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
|
||||
</table>
|
||||
<p id="footer">npm-commands — npm@2.14.7</p>
|
||||
<p id="footer">npm-commands — npm@3.3.0</p>
|
||||
|
||||
|
2
deps/npm/html/doc/api/npm-config.html
vendored
2
deps/npm/html/doc/api/npm-config.html
vendored
@ -57,5 +57,5 @@ functions instead.</p>
|
||||
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
|
||||
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
|
||||
</table>
|
||||
<p id="footer">npm-config — npm@2.14.7</p>
|
||||
<p id="footer">npm-config — npm@3.3.0</p>
|
||||
|
||||
|
2
deps/npm/html/doc/api/npm-deprecate.html
vendored
2
deps/npm/html/doc/api/npm-deprecate.html
vendored
@ -47,5 +47,5 @@ a deprecation warning to all who attempt to install it.</p>
|
||||
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
|
||||
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
|
||||
</table>
|
||||
<p id="footer">npm-deprecate — npm@2.14.7</p>
|
||||
<p id="footer">npm-deprecate — npm@3.3.0</p>
|
||||
|
||||
|
2
deps/npm/html/doc/api/npm-docs.html
vendored
2
deps/npm/html/doc/api/npm-docs.html
vendored
@ -33,5 +33,5 @@ friendly for programmatic use.</p>
|
||||
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
|
||||
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
|
||||
</table>
|
||||
<p id="footer">npm-docs — npm@2.14.7</p>
|
||||
<p id="footer">npm-docs — npm@3.3.0</p>
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user