Fix stuff up and add .env to .gitignore
This commit is contained in:
parent
e743f70128
commit
e66197568e
4976 changed files with 539387 additions and 6 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -1 +1 @@
|
|||
node_modules
|
||||
.env
|
7
node/lib/node_modules/corepack/LICENSE.md
generated
vendored
Normal file
7
node/lib/node_modules/corepack/LICENSE.md
generated
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
**Copyright © Corepack contributors**
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
132
node/lib/node_modules/corepack/README.md
generated
vendored
Normal file
132
node/lib/node_modules/corepack/README.md
generated
vendored
Normal file
|
@ -0,0 +1,132 @@
|
|||
# <img src="./icon.svg" height="25" /> corepack
|
||||
|
||||
Corepack is a zero-runtime-dependency Node.js script that acts as a bridge between Node.js projects and the package managers they are intended to be used with during development. In practical terms, **Corepack will let you use Yarn and pnpm without having to install them** - just like what currently happens with npm, which is shipped by Node.js by default.
|
||||
|
||||
**Important:** At the moment, Corepack only covers Yarn and pnpm. Given that we have little control on the npm project, we prefer to focus on the Yarn and pnpm use cases. As a result, Corepack doesn't have any effect at all on the way you use npm.
|
||||
|
||||
## How to Install
|
||||
|
||||
### Default Installs
|
||||
|
||||
Corepack is distributed by default with Node.js 16.9, but is opt-in for the time being. Run `corepack enable` to install the required shims.
|
||||
|
||||
### Manual Installs
|
||||
|
||||
<details>
|
||||
<summary>Click here to see how to install Corepack using npm</summary>
|
||||
|
||||
First uninstall your global Yarn and pnpm binaries (just leave npm). In general, you'd do this by running the following command:
|
||||
|
||||
```shell
|
||||
npm uninstall -g yarn pnpm
|
||||
|
||||
# That should be enough, but if you installed Yarn without going through npm it might
|
||||
# be more tedious - for example, you might need to run `brew uninstall yarn` as well.
|
||||
```
|
||||
|
||||
Then install Corepack:
|
||||
|
||||
```shell
|
||||
npm install -g corepack
|
||||
```
|
||||
|
||||
We do acknowledge the irony and overhead of using npm to install Corepack, which is at least part of why the preferred option is to use the Corepack version that is distributed along with Node.js itself.
|
||||
|
||||
</details>
|
||||
|
||||
## Usage
|
||||
|
||||
Just use your package managers as you usually would. Run `yarn install` in Yarn projects, `pnpm install` in pnpm projects, and `npm` in npm projects. Corepack will catch these calls, and depending on the situation:
|
||||
|
||||
- **If the local project is configured for the package manager you're using**, Corepack will silently download and cache the latest compatible version.
|
||||
|
||||
- **If the local project is configured for a different package manager**, Corepack will request you to run the command again using the right package manager - thus avoiding corruptions of your install artifacts.
|
||||
|
||||
- **If the local project isn't configured for any package manager**, Corepack will assume that you know what you're doing, and will use whatever package manager version has been pinned as "known good release". Check the relevant section for more details.
|
||||
|
||||
## Known Good Releases
|
||||
|
||||
When running Yarn or pnpm within projects that don't list a supported package manager, Corepack will default to a set of Known Good Releases. In a way, you can compare this to Node.js, where each version ships with a specific version of npm.
|
||||
|
||||
The Known Good Releases can be updated system-wide using the `--activate` flag from the `corepack prepare` and `corepack hydrate` commands.
|
||||
|
||||
## Offline Workflow
|
||||
|
||||
The utility commands detailed in the next section.
|
||||
|
||||
- Either you can use the network while building your container image, in which case you'll simply run `corepack prepare` to make sure that your image includes the Last Known Good release for the specified package manager.
|
||||
|
||||
- If you want to have *all* Last Known Good releases for all package managers, just use the `--all` flag which will do just that.
|
||||
|
||||
- Or you're publishing your project to a system where the network is unavailable, in which case you'll preemptively generate a package manager archive from your local computer (using `corepack prepare -o`) before storing it somewhere your container will be able to access (for example within your repository). After that it'll just be a matter of running `corepack hydrate <path/to/corepack.tgz>` to setup the cache.
|
||||
|
||||
## Utility Commands
|
||||
|
||||
### `corepack <binary name>[@<version>] [... args]`
|
||||
|
||||
This meta-command runs the specified package manager in the local folder. You can use it to force an install to run with a given version, which can be useful when looking for regressions.
|
||||
|
||||
Note that those commands still check whether the local project is configured for the given package manager (ie you won't be able to run `corepack yarn install` on a project where the `packageManager` field references `pnpm`).
|
||||
|
||||
### `corepack enable [... name]`
|
||||
|
||||
| Option | Description |
|
||||
| --- | --- |
|
||||
| `--install-directory` | Add the shims to the specified location |
|
||||
|
||||
This command will detect where Node.js is installed and will create shims next to it for each of the specified package managers (or all of them if the command is called without parameters). Note that the npm shims will not be installed unless explicitly requested, as npm is currently distributed with Node.js through other means.
|
||||
|
||||
### `corepack disable [... name]`
|
||||
|
||||
| Option | Description |
|
||||
| --- | --- |
|
||||
| `--install-directory` | Remove the shims to the specified location |
|
||||
|
||||
This command will detect where Node.js is installed and will remove the shims from there.
|
||||
|
||||
### `corepack prepare [... name@version]`
|
||||
|
||||
| Option | Description |
|
||||
| --- | --- |
|
||||
| `--all` | Prepare the "Last Known Good" version of all supported package managers |
|
||||
| `-o,--output` | Also generate an archive containing the package managers |
|
||||
| `--activate` | Also update the "Last Known Good" release |
|
||||
|
||||
This command will download the given package managers (or the one configured for the local project if no argument is passed in parameter) and store it within the Corepack cache. If the `-o,--output` flag is set (optionally with a path as parameter), an archive will also be generated that can be used by the `corepack hydrate` command.
|
||||
|
||||
### `corepack hydrate <path/to/corepack.tgz>`
|
||||
|
||||
| Option | Description |
|
||||
| --- | --- |
|
||||
| `--activate` | Also update the "Last Known Good" release |
|
||||
|
||||
This command will retrieve the given package manager from the specified archive and will install it within the Corepack cache, ready to be used without further network interaction.
|
||||
|
||||
## Environment Variables
|
||||
|
||||
- `COREPACK_ROOT` has no functional impact on Corepack itself; it's automatically being set in your environment by Corepack when it shells out to the underlying package managers, so that they can feature-detect its presence (useful for commands like `yarn init`).
|
||||
|
||||
## Contributing
|
||||
|
||||
If you want to build corepack yourself, you can build the project like this:
|
||||
|
||||
1. Clone this repository
|
||||
2. Run `yarn build` (no need for `yarn install`)
|
||||
3. The `dist/` directory now contains the corepack build and the shims
|
||||
4. Call `node ./dist/corepack --help` and behold
|
||||
|
||||
You can also run the tests with `yarn jest` (still no install needed).
|
||||
|
||||
## Design
|
||||
|
||||
Various tidbits about Corepack's design are explained in more details in [DESIGN.md](/DESIGN.md).
|
||||
|
||||
## License (MIT)
|
||||
|
||||
> **Copyright © Corepack contributors**
|
||||
>
|
||||
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
>
|
||||
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
>
|
||||
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
14865
node/lib/node_modules/corepack/dist/corepack.js
generated
vendored
Executable file
14865
node/lib/node_modules/corepack/dist/corepack.js
generated
vendored
Executable file
File diff suppressed because it is too large
Load diff
2
node/lib/node_modules/corepack/dist/npm.js
generated
vendored
Executable file
2
node/lib/node_modules/corepack/dist/npm.js
generated
vendored
Executable file
|
@ -0,0 +1,2 @@
|
|||
#!/usr/bin/env node
|
||||
require('./corepack').runMain(['npm', ...process.argv.slice(2)]);
|
2
node/lib/node_modules/corepack/dist/npx.js
generated
vendored
Executable file
2
node/lib/node_modules/corepack/dist/npx.js
generated
vendored
Executable file
|
@ -0,0 +1,2 @@
|
|||
#!/usr/bin/env node
|
||||
require('./corepack').runMain(['npx', ...process.argv.slice(2)]);
|
2
node/lib/node_modules/corepack/dist/pnpm.js
generated
vendored
Executable file
2
node/lib/node_modules/corepack/dist/pnpm.js
generated
vendored
Executable file
|
@ -0,0 +1,2 @@
|
|||
#!/usr/bin/env node
|
||||
require('./corepack').runMain(['pnpm', ...process.argv.slice(2)]);
|
2
node/lib/node_modules/corepack/dist/pnpx.js
generated
vendored
Executable file
2
node/lib/node_modules/corepack/dist/pnpx.js
generated
vendored
Executable file
|
@ -0,0 +1,2 @@
|
|||
#!/usr/bin/env node
|
||||
require('./corepack').runMain(['pnpx', ...process.argv.slice(2)]);
|
424
node/lib/node_modules/corepack/dist/vcc.js
generated
vendored
Normal file
424
node/lib/node_modules/corepack/dist/vcc.js
generated
vendored
Normal file
|
@ -0,0 +1,424 @@
|
|||
#!/usr/bin/env node
|
||||
/* eslint-disable */
|
||||
/******/ (() => { // webpackBootstrap
|
||||
/******/ var __webpack_modules__ = ({
|
||||
|
||||
/***/ "./.yarn/cache/v8-compile-cache-npm-2.3.0-961375f150-adb0a271ea.zip/node_modules/v8-compile-cache/v8-compile-cache.js":
|
||||
/*!****************************************************************************************************************************!*\
|
||||
!*** ./.yarn/cache/v8-compile-cache-npm-2.3.0-961375f150-adb0a271ea.zip/node_modules/v8-compile-cache/v8-compile-cache.js ***!
|
||||
\****************************************************************************************************************************/
|
||||
/***/ (function(module, exports) {
|
||||
|
||||
'use strict';
|
||||
|
||||
const Module = require('module');
|
||||
const crypto = require('crypto');
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const vm = require('vm');
|
||||
const os = require('os');
|
||||
|
||||
const hasOwnProperty = Object.prototype.hasOwnProperty;
|
||||
|
||||
//------------------------------------------------------------------------------
|
||||
// FileSystemBlobStore
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
class FileSystemBlobStore {
|
||||
constructor(directory, prefix) {
|
||||
const name = prefix ? slashEscape(prefix + '.') : '';
|
||||
this._blobFilename = path.join(directory, name + 'BLOB');
|
||||
this._mapFilename = path.join(directory, name + 'MAP');
|
||||
this._lockFilename = path.join(directory, name + 'LOCK');
|
||||
this._directory = directory;
|
||||
this._load();
|
||||
}
|
||||
|
||||
has(key, invalidationKey) {
|
||||
if (hasOwnProperty.call(this._memoryBlobs, key)) {
|
||||
return this._invalidationKeys[key] === invalidationKey;
|
||||
} else if (hasOwnProperty.call(this._storedMap, key)) {
|
||||
return this._storedMap[key][0] === invalidationKey;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
get(key, invalidationKey) {
|
||||
if (hasOwnProperty.call(this._memoryBlobs, key)) {
|
||||
if (this._invalidationKeys[key] === invalidationKey) {
|
||||
return this._memoryBlobs[key];
|
||||
}
|
||||
} else if (hasOwnProperty.call(this._storedMap, key)) {
|
||||
const mapping = this._storedMap[key];
|
||||
if (mapping[0] === invalidationKey) {
|
||||
return this._storedBlob.slice(mapping[1], mapping[2]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
set(key, invalidationKey, buffer) {
|
||||
this._invalidationKeys[key] = invalidationKey;
|
||||
this._memoryBlobs[key] = buffer;
|
||||
this._dirty = true;
|
||||
}
|
||||
|
||||
delete(key) {
|
||||
if (hasOwnProperty.call(this._memoryBlobs, key)) {
|
||||
this._dirty = true;
|
||||
delete this._memoryBlobs[key];
|
||||
}
|
||||
if (hasOwnProperty.call(this._invalidationKeys, key)) {
|
||||
this._dirty = true;
|
||||
delete this._invalidationKeys[key];
|
||||
}
|
||||
if (hasOwnProperty.call(this._storedMap, key)) {
|
||||
this._dirty = true;
|
||||
delete this._storedMap[key];
|
||||
}
|
||||
}
|
||||
|
||||
isDirty() {
|
||||
return this._dirty;
|
||||
}
|
||||
|
||||
save() {
|
||||
const dump = this._getDump();
|
||||
const blobToStore = Buffer.concat(dump[0]);
|
||||
const mapToStore = JSON.stringify(dump[1]);
|
||||
|
||||
try {
|
||||
mkdirpSync(this._directory);
|
||||
fs.writeFileSync(this._lockFilename, 'LOCK', {flag: 'wx'});
|
||||
} catch (error) {
|
||||
// Swallow the exception if we fail to acquire the lock.
|
||||
return false;
|
||||
}
|
||||
|
||||
try {
|
||||
fs.writeFileSync(this._blobFilename, blobToStore);
|
||||
fs.writeFileSync(this._mapFilename, mapToStore);
|
||||
} finally {
|
||||
fs.unlinkSync(this._lockFilename);
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
_load() {
|
||||
try {
|
||||
this._storedBlob = fs.readFileSync(this._blobFilename);
|
||||
this._storedMap = JSON.parse(fs.readFileSync(this._mapFilename));
|
||||
} catch (e) {
|
||||
this._storedBlob = Buffer.alloc(0);
|
||||
this._storedMap = {};
|
||||
}
|
||||
this._dirty = false;
|
||||
this._memoryBlobs = {};
|
||||
this._invalidationKeys = {};
|
||||
}
|
||||
|
||||
_getDump() {
|
||||
const buffers = [];
|
||||
const newMap = {};
|
||||
let offset = 0;
|
||||
|
||||
function push(key, invalidationKey, buffer) {
|
||||
buffers.push(buffer);
|
||||
newMap[key] = [invalidationKey, offset, offset + buffer.length];
|
||||
offset += buffer.length;
|
||||
}
|
||||
|
||||
for (const key of Object.keys(this._memoryBlobs)) {
|
||||
const buffer = this._memoryBlobs[key];
|
||||
const invalidationKey = this._invalidationKeys[key];
|
||||
push(key, invalidationKey, buffer);
|
||||
}
|
||||
|
||||
for (const key of Object.keys(this._storedMap)) {
|
||||
if (hasOwnProperty.call(newMap, key)) continue;
|
||||
const mapping = this._storedMap[key];
|
||||
const buffer = this._storedBlob.slice(mapping[1], mapping[2]);
|
||||
push(key, mapping[0], buffer);
|
||||
}
|
||||
|
||||
return [buffers, newMap];
|
||||
}
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------------
|
||||
// NativeCompileCache
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
class NativeCompileCache {
|
||||
constructor() {
|
||||
this._cacheStore = null;
|
||||
this._previousModuleCompile = null;
|
||||
}
|
||||
|
||||
setCacheStore(cacheStore) {
|
||||
this._cacheStore = cacheStore;
|
||||
}
|
||||
|
||||
install() {
|
||||
const self = this;
|
||||
const hasRequireResolvePaths = typeof require.resolve.paths === 'function';
|
||||
this._previousModuleCompile = Module.prototype._compile;
|
||||
Module.prototype._compile = function(content, filename) {
|
||||
const mod = this;
|
||||
|
||||
function require(id) {
|
||||
return mod.require(id);
|
||||
}
|
||||
|
||||
// https://github.com/nodejs/node/blob/v10.15.3/lib/internal/modules/cjs/helpers.js#L28
|
||||
function resolve(request, options) {
|
||||
return Module._resolveFilename(request, mod, false, options);
|
||||
}
|
||||
require.resolve = resolve;
|
||||
|
||||
// https://github.com/nodejs/node/blob/v10.15.3/lib/internal/modules/cjs/helpers.js#L37
|
||||
// resolve.resolve.paths was added in v8.9.0
|
||||
if (hasRequireResolvePaths) {
|
||||
resolve.paths = function paths(request) {
|
||||
return Module._resolveLookupPaths(request, mod, true);
|
||||
};
|
||||
}
|
||||
|
||||
require.main = process.mainModule;
|
||||
|
||||
// Enable support to add extra extension types
|
||||
require.extensions = Module._extensions;
|
||||
require.cache = Module._cache;
|
||||
|
||||
const dirname = path.dirname(filename);
|
||||
|
||||
const compiledWrapper = self._moduleCompile(filename, content);
|
||||
|
||||
// We skip the debugger setup because by the time we run, node has already
|
||||
// done that itself.
|
||||
|
||||
// `Buffer` is included for Electron.
|
||||
// See https://github.com/zertosh/v8-compile-cache/pull/10#issuecomment-518042543
|
||||
const args = [mod.exports, require, mod, filename, dirname, process, global, Buffer];
|
||||
return compiledWrapper.apply(mod.exports, args);
|
||||
};
|
||||
}
|
||||
|
||||
uninstall() {
|
||||
Module.prototype._compile = this._previousModuleCompile;
|
||||
}
|
||||
|
||||
_moduleCompile(filename, content) {
|
||||
// https://github.com/nodejs/node/blob/v7.5.0/lib/module.js#L511
|
||||
|
||||
// Remove shebang
|
||||
var contLen = content.length;
|
||||
if (contLen >= 2) {
|
||||
if (content.charCodeAt(0) === 35/*#*/ &&
|
||||
content.charCodeAt(1) === 33/*!*/) {
|
||||
if (contLen === 2) {
|
||||
// Exact match
|
||||
content = '';
|
||||
} else {
|
||||
// Find end of shebang line and slice it off
|
||||
var i = 2;
|
||||
for (; i < contLen; ++i) {
|
||||
var code = content.charCodeAt(i);
|
||||
if (code === 10/*\n*/ || code === 13/*\r*/) break;
|
||||
}
|
||||
if (i === contLen) {
|
||||
content = '';
|
||||
} else {
|
||||
// Note that this actually includes the newline character(s) in the
|
||||
// new output. This duplicates the behavior of the regular
|
||||
// expression that was previously used to replace the shebang line
|
||||
content = content.slice(i);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// create wrapper function
|
||||
var wrapper = Module.wrap(content);
|
||||
|
||||
var invalidationKey = crypto
|
||||
.createHash('sha1')
|
||||
.update(content, 'utf8')
|
||||
.digest('hex');
|
||||
|
||||
var buffer = this._cacheStore.get(filename, invalidationKey);
|
||||
|
||||
var script = new vm.Script(wrapper, {
|
||||
filename: filename,
|
||||
lineOffset: 0,
|
||||
displayErrors: true,
|
||||
cachedData: buffer,
|
||||
produceCachedData: true,
|
||||
});
|
||||
|
||||
if (script.cachedDataProduced) {
|
||||
this._cacheStore.set(filename, invalidationKey, script.cachedData);
|
||||
} else if (script.cachedDataRejected) {
|
||||
this._cacheStore.delete(filename);
|
||||
}
|
||||
|
||||
var compiledWrapper = script.runInThisContext({
|
||||
filename: filename,
|
||||
lineOffset: 0,
|
||||
columnOffset: 0,
|
||||
displayErrors: true,
|
||||
});
|
||||
|
||||
return compiledWrapper;
|
||||
}
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------------
|
||||
// utilities
|
||||
//
|
||||
// https://github.com/substack/node-mkdirp/blob/f2003bb/index.js#L55-L98
|
||||
// https://github.com/zertosh/slash-escape/blob/e7ebb99/slash-escape.js
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
function mkdirpSync(p_) {
|
||||
_mkdirpSync(path.resolve(p_), 0o777);
|
||||
}
|
||||
|
||||
function _mkdirpSync(p, mode) {
|
||||
try {
|
||||
fs.mkdirSync(p, mode);
|
||||
} catch (err0) {
|
||||
if (err0.code === 'ENOENT') {
|
||||
_mkdirpSync(path.dirname(p));
|
||||
_mkdirpSync(p);
|
||||
} else {
|
||||
try {
|
||||
const stat = fs.statSync(p);
|
||||
if (!stat.isDirectory()) { throw err0; }
|
||||
} catch (err1) {
|
||||
throw err0;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function slashEscape(str) {
|
||||
const ESCAPE_LOOKUP = {
|
||||
'\\': 'zB',
|
||||
':': 'zC',
|
||||
'/': 'zS',
|
||||
'\x00': 'z0',
|
||||
'z': 'zZ',
|
||||
};
|
||||
const ESCAPE_REGEX = /[\\:/\x00z]/g; // eslint-disable-line no-control-regex
|
||||
return str.replace(ESCAPE_REGEX, match => ESCAPE_LOOKUP[match]);
|
||||
}
|
||||
|
||||
function supportsCachedData() {
|
||||
const script = new vm.Script('""', {produceCachedData: true});
|
||||
// chakracore, as of v1.7.1.0, returns `false`.
|
||||
return script.cachedDataProduced === true;
|
||||
}
|
||||
|
||||
function getCacheDir() {
|
||||
const v8_compile_cache_cache_dir = process.env.V8_COMPILE_CACHE_CACHE_DIR;
|
||||
if (v8_compile_cache_cache_dir) {
|
||||
return v8_compile_cache_cache_dir;
|
||||
}
|
||||
|
||||
// Avoid cache ownership issues on POSIX systems.
|
||||
const dirname = typeof process.getuid === 'function'
|
||||
? 'v8-compile-cache-' + process.getuid()
|
||||
: 'v8-compile-cache';
|
||||
const version = typeof process.versions.v8 === 'string'
|
||||
? process.versions.v8
|
||||
: typeof process.versions.chakracore === 'string'
|
||||
? 'chakracore-' + process.versions.chakracore
|
||||
: 'node-' + process.version;
|
||||
const cacheDir = path.join(os.tmpdir(), dirname, version);
|
||||
return cacheDir;
|
||||
}
|
||||
|
||||
function getMainName() {
|
||||
// `require.main.filename` is undefined or null when:
|
||||
// * node -e 'require("v8-compile-cache")'
|
||||
// * node -r 'v8-compile-cache'
|
||||
// * Or, requiring from the REPL.
|
||||
const mainName = require.main && typeof require.main.filename === 'string'
|
||||
? require.main.filename
|
||||
: process.cwd();
|
||||
return mainName;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------------
|
||||
// main
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
if (!process.env.DISABLE_V8_COMPILE_CACHE && supportsCachedData()) {
|
||||
const cacheDir = getCacheDir();
|
||||
const prefix = getMainName();
|
||||
const blobStore = new FileSystemBlobStore(cacheDir, prefix);
|
||||
|
||||
const nativeCompileCache = new NativeCompileCache();
|
||||
nativeCompileCache.setCacheStore(blobStore);
|
||||
nativeCompileCache.install();
|
||||
|
||||
process.once('exit', () => {
|
||||
if (blobStore.isDirty()) {
|
||||
blobStore.save();
|
||||
}
|
||||
nativeCompileCache.uninstall();
|
||||
});
|
||||
}
|
||||
|
||||
module.exports.__TEST__ = {
|
||||
FileSystemBlobStore,
|
||||
NativeCompileCache,
|
||||
mkdirpSync,
|
||||
slashEscape,
|
||||
supportsCachedData,
|
||||
getCacheDir,
|
||||
getMainName,
|
||||
};
|
||||
|
||||
|
||||
/***/ })
|
||||
|
||||
/******/ });
|
||||
/************************************************************************/
|
||||
/******/ // The module cache
|
||||
/******/ var __webpack_module_cache__ = {};
|
||||
/******/
|
||||
/******/ // The require function
|
||||
/******/ function __webpack_require__(moduleId) {
|
||||
/******/ // Check if module is in cache
|
||||
/******/ var cachedModule = __webpack_module_cache__[moduleId];
|
||||
/******/ if (cachedModule !== undefined) {
|
||||
/******/ return cachedModule.exports;
|
||||
/******/ }
|
||||
/******/ // Create a new module (and put it into the cache)
|
||||
/******/ var module = __webpack_module_cache__[moduleId] = {
|
||||
/******/ // no module.id needed
|
||||
/******/ // no module.loaded needed
|
||||
/******/ exports: {}
|
||||
/******/ };
|
||||
/******/
|
||||
/******/ // Execute the module function
|
||||
/******/ __webpack_modules__[moduleId].call(module.exports, module, module.exports, __webpack_require__);
|
||||
/******/
|
||||
/******/ // Return the exports of the module
|
||||
/******/ return module.exports;
|
||||
/******/ }
|
||||
/******/
|
||||
/************************************************************************/
|
||||
/******/
|
||||
/******/ // startup
|
||||
/******/ // Load entry module and return exports
|
||||
/******/ // This entry module doesn't tell about it's top-level declarations so it can't be inlined
|
||||
/******/ var __webpack_exports__ = __webpack_require__("./.yarn/cache/v8-compile-cache-npm-2.3.0-961375f150-adb0a271ea.zip/node_modules/v8-compile-cache/v8-compile-cache.js");
|
||||
/******/ var __webpack_export_target__ = exports;
|
||||
/******/ for(var i in __webpack_exports__) __webpack_export_target__[i] = __webpack_exports__[i];
|
||||
/******/ if(__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, "__esModule", { value: true });
|
||||
/******/
|
||||
/******/ })()
|
||||
;
|
2
node/lib/node_modules/corepack/dist/yarn.js
generated
vendored
Executable file
2
node/lib/node_modules/corepack/dist/yarn.js
generated
vendored
Executable file
|
@ -0,0 +1,2 @@
|
|||
#!/usr/bin/env node
|
||||
require('./corepack').runMain(['yarn', ...process.argv.slice(2)]);
|
2
node/lib/node_modules/corepack/dist/yarnpkg.js
generated
vendored
Executable file
2
node/lib/node_modules/corepack/dist/yarnpkg.js
generated
vendored
Executable file
|
@ -0,0 +1,2 @@
|
|||
#!/usr/bin/env node
|
||||
require('./corepack').runMain(['yarnpkg', ...process.argv.slice(2)]);
|
93
node/lib/node_modules/corepack/package.json
generated
vendored
Normal file
93
node/lib/node_modules/corepack/package.json
generated
vendored
Normal file
|
@ -0,0 +1,93 @@
|
|||
{
|
||||
"name": "corepack",
|
||||
"version": "0.10.0",
|
||||
"homepage": "https://github.com/nodejs/corepack#readme",
|
||||
"bugs": {
|
||||
"url": "https://github.com/nodejs/corepack/issues"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/nodejs/corepack.git"
|
||||
},
|
||||
"license": "MIT",
|
||||
"bin": {
|
||||
"corepack": "./dist/corepack.js",
|
||||
"pnpm": "./dist/pnpm.js",
|
||||
"pnpx": "./dist/pnpx.js",
|
||||
"yarn": "./dist/yarn.js",
|
||||
"yarnpkg": "./dist/yarnpkg.js"
|
||||
},
|
||||
"packageManager": "yarn@3.0.0",
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.14.3",
|
||||
"@babel/plugin-proposal-class-properties": "^7.13.0",
|
||||
"@babel/plugin-proposal-decorators": "^7.14.2",
|
||||
"@babel/plugin-proposal-nullish-coalescing-operator": "^7.10.4",
|
||||
"@babel/plugin-transform-modules-commonjs": "^7.14.0",
|
||||
"@babel/preset-typescript": "^7.13.0",
|
||||
"@types/debug": "^4.1.5",
|
||||
"@types/jest": "^26.0.23",
|
||||
"@types/node": "^13.9.2",
|
||||
"@types/semver": "^7.1.0",
|
||||
"@types/tar": "^4.0.3",
|
||||
"@types/which": "^1.3.2",
|
||||
"@typescript-eslint/eslint-plugin": "^2.0.0",
|
||||
"@typescript-eslint/parser": "^4.2.0",
|
||||
"@yarnpkg/eslint-config": "^0.1.0",
|
||||
"@yarnpkg/fslib": "^2.1.0",
|
||||
"@zkochan/cmd-shim": "^5.0.0",
|
||||
"babel-plugin-dynamic-import-node": "^2.3.3",
|
||||
"clipanion": "^3.0.1",
|
||||
"debug": "^4.1.1",
|
||||
"eslint": "^7.10.0",
|
||||
"eslint-plugin-arca": "^0.9.5",
|
||||
"jest": "^26.0.0",
|
||||
"nock": "^13.0.4",
|
||||
"semver": "^7.1.3",
|
||||
"supports-color": "^7.1.0",
|
||||
"tar": "^6.0.1",
|
||||
"terser-webpack-plugin": "^5.1.2",
|
||||
"ts-loader": "^8.0.2",
|
||||
"ts-node": "^8.10.2",
|
||||
"typescript": "^4.3.2",
|
||||
"v8-compile-cache": "^2.3.0",
|
||||
"webpack": "^5.38.1",
|
||||
"webpack-cli": "^3.3.11",
|
||||
"which": "^2.0.2"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "rm -rf dist && webpack && ts-node ./mkshims.ts",
|
||||
"corepack": "ts-node ./sources/main.ts",
|
||||
"prepack": "node ./.yarn/releases/*.*js build",
|
||||
"postpack": "rm -rf dist shims",
|
||||
"test": "yarn jest"
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"shims",
|
||||
"LICENSE.md"
|
||||
],
|
||||
"publishConfig": {
|
||||
"executableFiles": [
|
||||
"./dist/npm.js",
|
||||
"./dist/npx.js",
|
||||
"./dist/pnpm.js",
|
||||
"./dist/pnpx.js",
|
||||
"./dist/yarn.js",
|
||||
"./dist/yarnpkg.js",
|
||||
"./dist/corepack.js",
|
||||
"./shims/npm",
|
||||
"./shims/npm.ps1",
|
||||
"./shims/npx",
|
||||
"./shims/npx.ps1",
|
||||
"./shims/pnpm",
|
||||
"./shims/pnpm.ps1",
|
||||
"./shims/pnpx",
|
||||
"./shims/pnpx.ps1",
|
||||
"./shims/yarn",
|
||||
"./shims/yarn.ps1",
|
||||
"./shims/yarnpkg",
|
||||
"./shims/yarnpkg.ps1"
|
||||
]
|
||||
}
|
||||
}
|
12
node/lib/node_modules/corepack/shims/corepack
generated
vendored
Executable file
12
node/lib/node_modules/corepack/shims/corepack
generated
vendored
Executable file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/../dist/corepack.js" "$@"
|
||||
else
|
||||
exec node "$basedir/../dist/corepack.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/corepack.cmd
generated
vendored
Executable file
7
node/lib/node_modules/corepack/shims/corepack.cmd
generated
vendored
Executable file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\..\dist\corepack.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\..\dist\corepack.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/corepack.ps1
generated
vendored
Executable file
28
node/lib/node_modules/corepack/shims/corepack.ps1
generated
vendored
Executable file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/../dist/corepack.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/../dist/corepack.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/../dist/corepack.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/../dist/corepack.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/nodewin/corepack
generated
vendored
Normal file
12
node/lib/node_modules/corepack/shims/nodewin/corepack
generated
vendored
Normal file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/node_modules/corepack/dist/corepack.js" "$@"
|
||||
else
|
||||
exec node "$basedir/node_modules/corepack/dist/corepack.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/nodewin/corepack.cmd
generated
vendored
Normal file
7
node/lib/node_modules/corepack/shims/nodewin/corepack.cmd
generated
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\node_modules\corepack\dist\corepack.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\node_modules\corepack\dist\corepack.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/nodewin/corepack.ps1
generated
vendored
Normal file
28
node/lib/node_modules/corepack/shims/nodewin/corepack.ps1
generated
vendored
Normal file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/node_modules/corepack/dist/corepack.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/node_modules/corepack/dist/corepack.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/node_modules/corepack/dist/corepack.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/node_modules/corepack/dist/corepack.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/nodewin/npm
generated
vendored
Normal file
12
node/lib/node_modules/corepack/shims/nodewin/npm
generated
vendored
Normal file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/node_modules/corepack/dist/npm.js" "$@"
|
||||
else
|
||||
exec node "$basedir/node_modules/corepack/dist/npm.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/nodewin/npm.cmd
generated
vendored
Normal file
7
node/lib/node_modules/corepack/shims/nodewin/npm.cmd
generated
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\node_modules\corepack\dist\npm.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\node_modules\corepack\dist\npm.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/nodewin/npm.ps1
generated
vendored
Normal file
28
node/lib/node_modules/corepack/shims/nodewin/npm.ps1
generated
vendored
Normal file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/node_modules/corepack/dist/npm.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/node_modules/corepack/dist/npm.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/node_modules/corepack/dist/npm.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/node_modules/corepack/dist/npm.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/nodewin/npx
generated
vendored
Normal file
12
node/lib/node_modules/corepack/shims/nodewin/npx
generated
vendored
Normal file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/node_modules/corepack/dist/npx.js" "$@"
|
||||
else
|
||||
exec node "$basedir/node_modules/corepack/dist/npx.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/nodewin/npx.cmd
generated
vendored
Normal file
7
node/lib/node_modules/corepack/shims/nodewin/npx.cmd
generated
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\node_modules\corepack\dist\npx.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\node_modules\corepack\dist\npx.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/nodewin/npx.ps1
generated
vendored
Normal file
28
node/lib/node_modules/corepack/shims/nodewin/npx.ps1
generated
vendored
Normal file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/node_modules/corepack/dist/npx.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/node_modules/corepack/dist/npx.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/node_modules/corepack/dist/npx.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/node_modules/corepack/dist/npx.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/nodewin/pnpm
generated
vendored
Normal file
12
node/lib/node_modules/corepack/shims/nodewin/pnpm
generated
vendored
Normal file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/node_modules/corepack/dist/pnpm.js" "$@"
|
||||
else
|
||||
exec node "$basedir/node_modules/corepack/dist/pnpm.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/nodewin/pnpm.cmd
generated
vendored
Normal file
7
node/lib/node_modules/corepack/shims/nodewin/pnpm.cmd
generated
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\node_modules\corepack\dist\pnpm.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\node_modules\corepack\dist\pnpm.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/nodewin/pnpm.ps1
generated
vendored
Normal file
28
node/lib/node_modules/corepack/shims/nodewin/pnpm.ps1
generated
vendored
Normal file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/node_modules/corepack/dist/pnpm.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/node_modules/corepack/dist/pnpm.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/node_modules/corepack/dist/pnpm.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/node_modules/corepack/dist/pnpm.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/nodewin/pnpx
generated
vendored
Normal file
12
node/lib/node_modules/corepack/shims/nodewin/pnpx
generated
vendored
Normal file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/node_modules/corepack/dist/pnpx.js" "$@"
|
||||
else
|
||||
exec node "$basedir/node_modules/corepack/dist/pnpx.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/nodewin/pnpx.cmd
generated
vendored
Normal file
7
node/lib/node_modules/corepack/shims/nodewin/pnpx.cmd
generated
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\node_modules\corepack\dist\pnpx.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\node_modules\corepack\dist\pnpx.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/nodewin/pnpx.ps1
generated
vendored
Normal file
28
node/lib/node_modules/corepack/shims/nodewin/pnpx.ps1
generated
vendored
Normal file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/node_modules/corepack/dist/pnpx.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/node_modules/corepack/dist/pnpx.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/node_modules/corepack/dist/pnpx.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/node_modules/corepack/dist/pnpx.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/nodewin/vcc
generated
vendored
Normal file
12
node/lib/node_modules/corepack/shims/nodewin/vcc
generated
vendored
Normal file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/node_modules/corepack/dist/vcc.js" "$@"
|
||||
else
|
||||
exec node "$basedir/node_modules/corepack/dist/vcc.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/nodewin/vcc.cmd
generated
vendored
Normal file
7
node/lib/node_modules/corepack/shims/nodewin/vcc.cmd
generated
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\node_modules\corepack\dist\vcc.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\node_modules\corepack\dist\vcc.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/nodewin/vcc.ps1
generated
vendored
Normal file
28
node/lib/node_modules/corepack/shims/nodewin/vcc.ps1
generated
vendored
Normal file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/node_modules/corepack/dist/vcc.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/node_modules/corepack/dist/vcc.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/node_modules/corepack/dist/vcc.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/node_modules/corepack/dist/vcc.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/nodewin/yarn
generated
vendored
Normal file
12
node/lib/node_modules/corepack/shims/nodewin/yarn
generated
vendored
Normal file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/node_modules/corepack/dist/yarn.js" "$@"
|
||||
else
|
||||
exec node "$basedir/node_modules/corepack/dist/yarn.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/nodewin/yarn.cmd
generated
vendored
Normal file
7
node/lib/node_modules/corepack/shims/nodewin/yarn.cmd
generated
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\node_modules\corepack\dist\yarn.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\node_modules\corepack\dist\yarn.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/nodewin/yarn.ps1
generated
vendored
Normal file
28
node/lib/node_modules/corepack/shims/nodewin/yarn.ps1
generated
vendored
Normal file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/node_modules/corepack/dist/yarn.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/node_modules/corepack/dist/yarn.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/node_modules/corepack/dist/yarn.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/node_modules/corepack/dist/yarn.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/nodewin/yarnpkg
generated
vendored
Normal file
12
node/lib/node_modules/corepack/shims/nodewin/yarnpkg
generated
vendored
Normal file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/node_modules/corepack/dist/yarnpkg.js" "$@"
|
||||
else
|
||||
exec node "$basedir/node_modules/corepack/dist/yarnpkg.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/nodewin/yarnpkg.cmd
generated
vendored
Normal file
7
node/lib/node_modules/corepack/shims/nodewin/yarnpkg.cmd
generated
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\node_modules\corepack\dist\yarnpkg.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\node_modules\corepack\dist\yarnpkg.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/nodewin/yarnpkg.ps1
generated
vendored
Normal file
28
node/lib/node_modules/corepack/shims/nodewin/yarnpkg.ps1
generated
vendored
Normal file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/node_modules/corepack/dist/yarnpkg.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/node_modules/corepack/dist/yarnpkg.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/node_modules/corepack/dist/yarnpkg.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/node_modules/corepack/dist/yarnpkg.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/npm
generated
vendored
Executable file
12
node/lib/node_modules/corepack/shims/npm
generated
vendored
Executable file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/../dist/npm.js" "$@"
|
||||
else
|
||||
exec node "$basedir/../dist/npm.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/npm.cmd
generated
vendored
Executable file
7
node/lib/node_modules/corepack/shims/npm.cmd
generated
vendored
Executable file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\..\dist\npm.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\..\dist\npm.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/npm.ps1
generated
vendored
Executable file
28
node/lib/node_modules/corepack/shims/npm.ps1
generated
vendored
Executable file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/../dist/npm.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/../dist/npm.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/../dist/npm.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/../dist/npm.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/npx
generated
vendored
Executable file
12
node/lib/node_modules/corepack/shims/npx
generated
vendored
Executable file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/../dist/npx.js" "$@"
|
||||
else
|
||||
exec node "$basedir/../dist/npx.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/npx.cmd
generated
vendored
Executable file
7
node/lib/node_modules/corepack/shims/npx.cmd
generated
vendored
Executable file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\..\dist\npx.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\..\dist\npx.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/npx.ps1
generated
vendored
Executable file
28
node/lib/node_modules/corepack/shims/npx.ps1
generated
vendored
Executable file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/../dist/npx.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/../dist/npx.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/../dist/npx.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/../dist/npx.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/pnpm
generated
vendored
Executable file
12
node/lib/node_modules/corepack/shims/pnpm
generated
vendored
Executable file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/../dist/pnpm.js" "$@"
|
||||
else
|
||||
exec node "$basedir/../dist/pnpm.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/pnpm.cmd
generated
vendored
Executable file
7
node/lib/node_modules/corepack/shims/pnpm.cmd
generated
vendored
Executable file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\..\dist\pnpm.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\..\dist\pnpm.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/pnpm.ps1
generated
vendored
Executable file
28
node/lib/node_modules/corepack/shims/pnpm.ps1
generated
vendored
Executable file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/../dist/pnpm.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/../dist/pnpm.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/../dist/pnpm.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/../dist/pnpm.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/pnpx
generated
vendored
Executable file
12
node/lib/node_modules/corepack/shims/pnpx
generated
vendored
Executable file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/../dist/pnpx.js" "$@"
|
||||
else
|
||||
exec node "$basedir/../dist/pnpx.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/pnpx.cmd
generated
vendored
Executable file
7
node/lib/node_modules/corepack/shims/pnpx.cmd
generated
vendored
Executable file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\..\dist\pnpx.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\..\dist\pnpx.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/pnpx.ps1
generated
vendored
Executable file
28
node/lib/node_modules/corepack/shims/pnpx.ps1
generated
vendored
Executable file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/../dist/pnpx.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/../dist/pnpx.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/../dist/pnpx.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/../dist/pnpx.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/yarn
generated
vendored
Executable file
12
node/lib/node_modules/corepack/shims/yarn
generated
vendored
Executable file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/../dist/yarn.js" "$@"
|
||||
else
|
||||
exec node "$basedir/../dist/yarn.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/yarn.cmd
generated
vendored
Executable file
7
node/lib/node_modules/corepack/shims/yarn.cmd
generated
vendored
Executable file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\..\dist\yarn.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\..\dist\yarn.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/yarn.ps1
generated
vendored
Executable file
28
node/lib/node_modules/corepack/shims/yarn.ps1
generated
vendored
Executable file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/../dist/yarn.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/../dist/yarn.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/../dist/yarn.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/../dist/yarn.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
12
node/lib/node_modules/corepack/shims/yarnpkg
generated
vendored
Executable file
12
node/lib/node_modules/corepack/shims/yarnpkg
generated
vendored
Executable file
|
@ -0,0 +1,12 @@
|
|||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
exec "$basedir/node" "$basedir/../dist/yarnpkg.js" "$@"
|
||||
else
|
||||
exec node "$basedir/../dist/yarnpkg.js" "$@"
|
||||
fi
|
7
node/lib/node_modules/corepack/shims/yarnpkg.cmd
generated
vendored
Executable file
7
node/lib/node_modules/corepack/shims/yarnpkg.cmd
generated
vendored
Executable file
|
@ -0,0 +1,7 @@
|
|||
@IF EXIST "%~dp0\node.exe" (
|
||||
"%~dp0\node.exe" "%~dp0\..\dist\yarnpkg.js" %*
|
||||
) ELSE (
|
||||
@SETLOCAL
|
||||
@SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
node "%~dp0\..\dist\yarnpkg.js" %*
|
||||
)
|
28
node/lib/node_modules/corepack/shims/yarnpkg.ps1
generated
vendored
Executable file
28
node/lib/node_modules/corepack/shims/yarnpkg.ps1
generated
vendored
Executable file
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "$basedir/node$exe" "$basedir/../dist/yarnpkg.js" $args
|
||||
} else {
|
||||
& "$basedir/node$exe" "$basedir/../dist/yarnpkg.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
# Support pipeline input
|
||||
if ($MyInvocation.ExpectingInput) {
|
||||
$input | & "node$exe" "$basedir/../dist/yarnpkg.js" $args
|
||||
} else {
|
||||
& "node$exe" "$basedir/../dist/yarnpkg.js" $args
|
||||
}
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
0
node/lib/node_modules/npm/.npmrc
generated
vendored
Normal file
0
node/lib/node_modules/npm/.npmrc
generated
vendored
Normal file
235
node/lib/node_modules/npm/LICENSE
generated
vendored
Normal file
235
node/lib/node_modules/npm/LICENSE
generated
vendored
Normal file
|
@ -0,0 +1,235 @@
|
|||
The npm application
|
||||
Copyright (c) npm, Inc. and Contributors
|
||||
Licensed on the terms of The Artistic License 2.0
|
||||
|
||||
Node package dependencies of the npm application
|
||||
Copyright (c) their respective copyright owners
|
||||
Licensed on their respective license terms
|
||||
|
||||
The npm public registry at https://registry.npmjs.org
|
||||
and the npm website at https://www.npmjs.com
|
||||
Operated by npm, Inc.
|
||||
Use governed by terms published on https://www.npmjs.com
|
||||
|
||||
"Node.js"
|
||||
Trademark Joyent, Inc., https://joyent.com
|
||||
Neither npm nor npm, Inc. are affiliated with Joyent, Inc.
|
||||
|
||||
The Node.js application
|
||||
Project of Node Foundation, https://nodejs.org
|
||||
|
||||
The npm Logo
|
||||
Copyright (c) Mathias Pettersson and Brian Hammond
|
||||
|
||||
"Gubblebum Blocky" typeface
|
||||
Copyright (c) Tjarda Koster, https://jelloween.deviantart.com
|
||||
Used with permission
|
||||
|
||||
|
||||
--------
|
||||
|
||||
|
||||
The Artistic License 2.0
|
||||
|
||||
Copyright (c) 2000-2006, The Perl Foundation.
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
This license establishes the terms under which a given free software
|
||||
Package may be copied, modified, distributed, and/or redistributed.
|
||||
The intent is that the Copyright Holder maintains some artistic
|
||||
control over the development of that Package while still keeping the
|
||||
Package available as open source and free software.
|
||||
|
||||
You are always permitted to make arrangements wholly outside of this
|
||||
license directly with the Copyright Holder of a given Package. If the
|
||||
terms of this license do not permit the full use that you propose to
|
||||
make of the Package, you should contact the Copyright Holder and seek
|
||||
a different licensing arrangement.
|
||||
|
||||
Definitions
|
||||
|
||||
"Copyright Holder" means the individual(s) or organization(s)
|
||||
named in the copyright notice for the entire Package.
|
||||
|
||||
"Contributor" means any party that has contributed code or other
|
||||
material to the Package, in accordance with the Copyright Holder's
|
||||
procedures.
|
||||
|
||||
"You" and "your" means any person who would like to copy,
|
||||
distribute, or modify the Package.
|
||||
|
||||
"Package" means the collection of files distributed by the
|
||||
Copyright Holder, and derivatives of that collection and/or of
|
||||
those files. A given Package may consist of either the Standard
|
||||
Version, or a Modified Version.
|
||||
|
||||
"Distribute" means providing a copy of the Package or making it
|
||||
accessible to anyone else, or in the case of a company or
|
||||
organization, to others outside of your company or organization.
|
||||
|
||||
"Distributor Fee" means any fee that you charge for Distributing
|
||||
this Package or providing support for this Package to another
|
||||
party. It does not mean licensing fees.
|
||||
|
||||
"Standard Version" refers to the Package if it has not been
|
||||
modified, or has been modified only in ways explicitly requested
|
||||
by the Copyright Holder.
|
||||
|
||||
"Modified Version" means the Package, if it has been changed, and
|
||||
such changes were not explicitly requested by the Copyright
|
||||
Holder.
|
||||
|
||||
"Original License" means this Artistic License as Distributed with
|
||||
the Standard Version of the Package, in its current version or as
|
||||
it may be modified by The Perl Foundation in the future.
|
||||
|
||||
"Source" form means the source code, documentation source, and
|
||||
configuration files for the Package.
|
||||
|
||||
"Compiled" form means the compiled bytecode, object code, binary,
|
||||
or any other form resulting from mechanical transformation or
|
||||
translation of the Source form.
|
||||
|
||||
|
||||
Permission for Use and Modification Without Distribution
|
||||
|
||||
(1) You are permitted to use the Standard Version and create and use
|
||||
Modified Versions for any purpose without restriction, provided that
|
||||
you do not Distribute the Modified Version.
|
||||
|
||||
|
||||
Permissions for Redistribution of the Standard Version
|
||||
|
||||
(2) You may Distribute verbatim copies of the Source form of the
|
||||
Standard Version of this Package in any medium without restriction,
|
||||
either gratis or for a Distributor Fee, provided that you duplicate
|
||||
all of the original copyright notices and associated disclaimers. At
|
||||
your discretion, such verbatim copies may or may not include a
|
||||
Compiled form of the Package.
|
||||
|
||||
(3) You may apply any bug fixes, portability changes, and other
|
||||
modifications made available from the Copyright Holder. The resulting
|
||||
Package will still be considered the Standard Version, and as such
|
||||
will be subject to the Original License.
|
||||
|
||||
|
||||
Distribution of Modified Versions of the Package as Source
|
||||
|
||||
(4) You may Distribute your Modified Version as Source (either gratis
|
||||
or for a Distributor Fee, and with or without a Compiled form of the
|
||||
Modified Version) provided that you clearly document how it differs
|
||||
from the Standard Version, including, but not limited to, documenting
|
||||
any non-standard features, executables, or modules, and provided that
|
||||
you do at least ONE of the following:
|
||||
|
||||
(a) make the Modified Version available to the Copyright Holder
|
||||
of the Standard Version, under the Original License, so that the
|
||||
Copyright Holder may include your modifications in the Standard
|
||||
Version.
|
||||
|
||||
(b) ensure that installation of your Modified Version does not
|
||||
prevent the user installing or running the Standard Version. In
|
||||
addition, the Modified Version must bear a name that is different
|
||||
from the name of the Standard Version.
|
||||
|
||||
(c) allow anyone who receives a copy of the Modified Version to
|
||||
make the Source form of the Modified Version available to others
|
||||
under
|
||||
|
||||
(i) the Original License or
|
||||
|
||||
(ii) a license that permits the licensee to freely copy,
|
||||
modify and redistribute the Modified Version using the same
|
||||
licensing terms that apply to the copy that the licensee
|
||||
received, and requires that the Source form of the Modified
|
||||
Version, and of any works derived from it, be made freely
|
||||
available in that license fees are prohibited but Distributor
|
||||
Fees are allowed.
|
||||
|
||||
|
||||
Distribution of Compiled Forms of the Standard Version
|
||||
or Modified Versions without the Source
|
||||
|
||||
(5) You may Distribute Compiled forms of the Standard Version without
|
||||
the Source, provided that you include complete instructions on how to
|
||||
get the Source of the Standard Version. Such instructions must be
|
||||
valid at the time of your distribution. If these instructions, at any
|
||||
time while you are carrying out such distribution, become invalid, you
|
||||
must provide new instructions on demand or cease further distribution.
|
||||
If you provide valid instructions or cease distribution within thirty
|
||||
days after you become aware that the instructions are invalid, then
|
||||
you do not forfeit any of your rights under this license.
|
||||
|
||||
(6) You may Distribute a Modified Version in Compiled form without
|
||||
the Source, provided that you comply with Section 4 with respect to
|
||||
the Source of the Modified Version.
|
||||
|
||||
|
||||
Aggregating or Linking the Package
|
||||
|
||||
(7) You may aggregate the Package (either the Standard Version or
|
||||
Modified Version) with other packages and Distribute the resulting
|
||||
aggregation provided that you do not charge a licensing fee for the
|
||||
Package. Distributor Fees are permitted, and licensing fees for other
|
||||
components in the aggregation are permitted. The terms of this license
|
||||
apply to the use and Distribution of the Standard or Modified Versions
|
||||
as included in the aggregation.
|
||||
|
||||
(8) You are permitted to link Modified and Standard Versions with
|
||||
other works, to embed the Package in a larger work of your own, or to
|
||||
build stand-alone binary or bytecode versions of applications that
|
||||
include the Package, and Distribute the result without restriction,
|
||||
provided the result does not expose a direct interface to the Package.
|
||||
|
||||
|
||||
Items That are Not Considered Part of a Modified Version
|
||||
|
||||
(9) Works (including, but not limited to, modules and scripts) that
|
||||
merely extend or make use of the Package, do not, by themselves, cause
|
||||
the Package to be a Modified Version. In addition, such works are not
|
||||
considered parts of the Package itself, and are not subject to the
|
||||
terms of this license.
|
||||
|
||||
|
||||
General Provisions
|
||||
|
||||
(10) Any use, modification, and distribution of the Standard or
|
||||
Modified Versions is governed by this Artistic License. By using,
|
||||
modifying or distributing the Package, you accept this license. Do not
|
||||
use, modify, or distribute the Package, if you do not accept this
|
||||
license.
|
||||
|
||||
(11) If your Modified Version has been derived from a Modified
|
||||
Version made by someone other than you, you are nevertheless required
|
||||
to ensure that your Modified Version complies with the requirements of
|
||||
this license.
|
||||
|
||||
(12) This license does not grant you the right to use any trademark,
|
||||
service mark, tradename, or logo of the Copyright Holder.
|
||||
|
||||
(13) This license includes the non-exclusive, worldwide,
|
||||
free-of-charge patent license to make, have made, use, offer to sell,
|
||||
sell, import and otherwise transfer the Package with respect to any
|
||||
patent claims licensable by the Copyright Holder that are necessarily
|
||||
infringed by the Package. If you institute patent litigation
|
||||
(including a cross-claim or counterclaim) against any party alleging
|
||||
that the Package constitutes direct or contributory patent
|
||||
infringement, then this Artistic License to you shall terminate on the
|
||||
date that such litigation is filed.
|
||||
|
||||
(14) Disclaimer of Warranty:
|
||||
THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS
|
||||
IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
|
||||
NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL
|
||||
LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL
|
||||
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF
|
||||
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
--------
|
70
node/lib/node_modules/npm/README.md
generated
vendored
Normal file
70
node/lib/node_modules/npm/README.md
generated
vendored
Normal file
|
@ -0,0 +1,70 @@
|
|||
[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/npm/cli/Node%20CI/latest)](https://github.com/npm/cli/actions?query=workflow%3A%22Node+CI%22+branch%3Alatest) [![Coveralls github branch](https://img.shields.io/coveralls/github/npm/cli/latest)](https://coveralls.io/github/npm/cli?branch=latest)
|
||||
|
||||
# npm - a JavaScript package manager
|
||||
|
||||
### Requirements
|
||||
|
||||
One of the following versions of [Node.js](https://nodejs.org/en/download/) must be installed to run **`npm`**:
|
||||
|
||||
* `12.x.x` >= `12.13.0`
|
||||
* `14.x.x` >= `14.15.0`
|
||||
* `16.0.0` or higher
|
||||
|
||||
### Installation
|
||||
|
||||
**`npm`** comes bundled with [**`node`**](https://nodejs.org/), & most third-party distributions, by default. Officially supported downloads/distributions can be found at: [nodejs.org/en/download](https://nodejs.org/en/download)
|
||||
|
||||
#### Direct Download
|
||||
|
||||
You can download & install **`npm`** directly from [**npmjs**.com](https://npmjs.com/) using our custom `install.sh` script:
|
||||
|
||||
```bash
|
||||
curl -qL https://www.npmjs.com/install.sh | sh
|
||||
```
|
||||
|
||||
#### Node Version Managers
|
||||
|
||||
If you're looking to manage multiple versions of **`node`** &/or **`npm`**, consider using a "Node Version Manager" such as:
|
||||
|
||||
* [**`nvm`**](https://github.com/nvm-sh/nvm)
|
||||
* [**`nvs`**](https://github.com/jasongin/nvs)
|
||||
* [**`nave`**](https://github.com/isaacs/nave)
|
||||
* [**`n`**](https://github.com/tj/n)
|
||||
* [**`volta`**](https://github.com/volta-cli/volta)
|
||||
* [**`nodenv`**](https://github.com/nodenv/nodenv)
|
||||
* [**`asdf-nodejs`**](https://github.com/asdf-vm/asdf-nodejs)
|
||||
* [**`nvm-windows`**](https://github.com/coreybutler/nvm-windows)
|
||||
|
||||
### Usage
|
||||
|
||||
```bash
|
||||
npm <command>
|
||||
```
|
||||
|
||||
### Links & Resources
|
||||
|
||||
* [**Documentation**](https://docs.npmjs.com/) - Official docs & how-tos for all things **npm**
|
||||
* Note: you can also search docs locally with `npm help-search <query>`
|
||||
* [**Bug Tracker**](https://github.com/npm/cli/issues) - Search or submit bugs against the CLI
|
||||
* [**Roadmap**](https://github.com/npm/roadmap) - Track & follow along with our public roadmap
|
||||
* [**Feedback**](https://github.com/npm/feedback) - Contribute ideas & discussion around the npm registry, website & CLI
|
||||
* [**RFCs**](https://github.com/npm/rfcs) - Contribute ideas & specifications for the API/design of the npm CLI
|
||||
* [**Service Status**](https://status.npmjs.org/) - Monitor the current status & see incident reports for the website & registry
|
||||
* [**Project Status**](https://npm.github.io/statusboard/) - See the health of all our maintained OSS projects in one view
|
||||
* [**Events Calendar**](https://calendar.google.com/calendar/u/0/embed?src=npmjs.com_oonluqt8oftrt0vmgrfbg6q6go@group.calendar.google.com) - Keep track of our Open RFC calls, releases, meetups, conferences & more
|
||||
* [**Support**](https://www.npmjs.com/support) - Experiencing problems with the **npm** [website](https://npmjs.com) or [registry](https://registry.npmjs.org)? File a ticket [here](https://www.npmjs.com/support)
|
||||
|
||||
### Acknowledgments
|
||||
|
||||
* `npm` is configured to use the **npm Public Registry** at [https://registry.npmjs.org](https://registry.npmjs.org) by default; Usage of this registry is subject to **Terms of Use** available at [https://npmjs.com/policies/terms](https://npmjs.com/policies/terms)
|
||||
* You can configure `npm` to use any other compatible registry you prefer. You can read more about configuring third-party registries [here](https://docs.npmjs.com/cli/v7/using-npm/registry)
|
||||
|
||||
### FAQ on Branding
|
||||
|
||||
#### Is it "npm" or "NPM" or "Npm"?
|
||||
|
||||
**`npm`** should never be capitalized unless it is being displayed in a location that is customarily all-capitals (ex. titles on `man` pages).
|
||||
|
||||
#### Is "npm" an acronym for "Node Package Manager"?
|
||||
|
||||
Contrary to popular belief, **`npm`** **is not** in fact an acronym for "Node Package Manager"; It is a recursive bacronymic abbreviation for **"npm is not an acronym"** (if the project was named "ninaa", then it would be an acronym). The precursor to **`npm`** was actually a bash utility named **"pm"**, which was the shortform name of **"pkgmakeinst"** - a bash function that installed various things on various platforms. If **`npm`** were to ever have been considered an acronym, it would be as "node pm" or, potentially "new pm".
|
6
node/lib/node_modules/npm/bin/node-gyp-bin/node-gyp
generated
vendored
Executable file
6
node/lib/node_modules/npm/bin/node-gyp-bin/node-gyp
generated
vendored
Executable file
|
@ -0,0 +1,6 @@
|
|||
#!/usr/bin/env sh
|
||||
if [ "x$npm_config_node_gyp" = "x" ]; then
|
||||
node "`dirname "$0"`/../../node_modules/node-gyp/bin/node-gyp.js" "$@"
|
||||
else
|
||||
"$npm_config_node_gyp" "$@"
|
||||
fi
|
5
node/lib/node_modules/npm/bin/node-gyp-bin/node-gyp.cmd
generated
vendored
Executable file
5
node/lib/node_modules/npm/bin/node-gyp-bin/node-gyp.cmd
generated
vendored
Executable file
|
@ -0,0 +1,5 @@
|
|||
if not defined npm_config_node_gyp (
|
||||
node "%~dp0\..\..\node_modules\node-gyp\bin\node-gyp.js" %*
|
||||
) else (
|
||||
node "%npm_config_node_gyp%" %*
|
||||
)
|
44
node/lib/node_modules/npm/bin/npm
generated
vendored
Executable file
44
node/lib/node_modules/npm/bin/npm
generated
vendored
Executable file
|
@ -0,0 +1,44 @@
|
|||
#!/usr/bin/env bash
|
||||
(set -o igncr) 2>/dev/null && set -o igncr; # cygwin encoding fix
|
||||
|
||||
basedir=`dirname "$0"`
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
NODE_EXE="$basedir/node.exe"
|
||||
if ! [ -x "$NODE_EXE" ]; then
|
||||
NODE_EXE="$basedir/node"
|
||||
fi
|
||||
if ! [ -x "$NODE_EXE" ]; then
|
||||
NODE_EXE=node
|
||||
fi
|
||||
|
||||
# this path is passed to node.exe, so it needs to match whatever
|
||||
# kind of paths Node.js thinks it's using, typically win32 paths.
|
||||
CLI_BASEDIR="$("$NODE_EXE" -p 'require("path").dirname(process.execPath)')"
|
||||
NPM_CLI_JS="$CLI_BASEDIR/node_modules/npm/bin/npm-cli.js"
|
||||
|
||||
NPM_PREFIX=`"$NODE_EXE" "$NPM_CLI_JS" prefix -g`
|
||||
if [ $? -ne 0 ]; then
|
||||
# if this didn't work, then everything else below will fail
|
||||
echo "Could not determine Node.js install directory" >&2
|
||||
exit 1
|
||||
fi
|
||||
NPM_PREFIX_NPM_CLI_JS="$NPM_PREFIX/node_modules/npm/bin/npm-cli.js"
|
||||
|
||||
# a path that will fail -f test on any posix bash
|
||||
NPM_WSL_PATH="/.."
|
||||
|
||||
# WSL can run Windows binaries, so we have to give it the win32 path
|
||||
# however, WSL bash tests against posix paths, so we need to construct that
|
||||
# to know if npm is installed globally.
|
||||
if [ `uname` = 'Linux' ] && type wslpath &>/dev/null ; then
|
||||
NPM_WSL_PATH=`wslpath "$NPM_PREFIX_NPM_CLI_JS"`
|
||||
fi
|
||||
if [ -f "$NPM_PREFIX_NPM_CLI_JS" ] || [ -f "$NPM_WSL_PATH" ]; then
|
||||
NPM_CLI_JS="$NPM_PREFIX_NPM_CLI_JS"
|
||||
fi
|
||||
|
||||
"$NODE_EXE" "$NPM_CLI_JS" "$@"
|
2
node/lib/node_modules/npm/bin/npm-cli.js
generated
vendored
Executable file
2
node/lib/node_modules/npm/bin/npm-cli.js
generated
vendored
Executable file
|
@ -0,0 +1,2 @@
|
|||
#!/usr/bin/env node
|
||||
require('../lib/cli.js')(process)
|
19
node/lib/node_modules/npm/bin/npm.cmd
generated
vendored
Executable file
19
node/lib/node_modules/npm/bin/npm.cmd
generated
vendored
Executable file
|
@ -0,0 +1,19 @@
|
|||
:: Created by npm, please don't edit manually.
|
||||
@ECHO OFF
|
||||
|
||||
SETLOCAL
|
||||
|
||||
SET "NODE_EXE=%~dp0\node.exe"
|
||||
IF NOT EXIST "%NODE_EXE%" (
|
||||
SET "NODE_EXE=node"
|
||||
)
|
||||
|
||||
SET "NPM_CLI_JS=%~dp0\node_modules\npm\bin\npm-cli.js"
|
||||
FOR /F "delims=" %%F IN ('CALL "%NODE_EXE%" "%NPM_CLI_JS%" prefix -g') DO (
|
||||
SET "NPM_PREFIX_NPM_CLI_JS=%%F\node_modules\npm\bin\npm-cli.js"
|
||||
)
|
||||
IF EXIST "%NPM_PREFIX_NPM_CLI_JS%" (
|
||||
SET "NPM_CLI_JS=%NPM_PREFIX_NPM_CLI_JS%"
|
||||
)
|
||||
|
||||
"%NODE_EXE%" "%NPM_CLI_JS%" %*
|
45
node/lib/node_modules/npm/bin/npx
generated
vendored
Executable file
45
node/lib/node_modules/npm/bin/npx
generated
vendored
Executable file
|
@ -0,0 +1,45 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# This is used by the Node.js installer, which expects the cygwin/mingw
|
||||
# shell script to already be present in the npm dependency folder.
|
||||
|
||||
(set -o igncr) 2>/dev/null && set -o igncr; # cygwin encoding fix
|
||||
|
||||
basedir=`dirname "$0"`
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
NODE_EXE="$basedir/node.exe"
|
||||
if ! [ -x "$NODE_EXE" ]; then
|
||||
NODE_EXE=node
|
||||
fi
|
||||
|
||||
# these paths are passed to node.exe, so they need to match whatever
|
||||
# kind of paths Node.js thinks it's using, typically win32 paths.
|
||||
CLI_BASEDIR="$("$NODE_EXE" -p 'require("path").dirname(process.execPath)')"
|
||||
if [ $? -ne 0 ]; then
|
||||
# if this didn't work, then everything else below will fail
|
||||
echo "Could not determine Node.js install directory" >&2
|
||||
exit 1
|
||||
fi
|
||||
NPM_CLI_JS="$CLI_BASEDIR/node_modules/npm/bin/npm-cli.js"
|
||||
NPX_CLI_JS="$CLI_BASEDIR/node_modules/npm/bin/npx-cli.js"
|
||||
NPM_PREFIX=`"$NODE_EXE" "$NPM_CLI_JS" prefix -g`
|
||||
NPM_PREFIX_NPX_CLI_JS="$NPM_PREFIX/node_modules/npm/bin/npx-cli.js"
|
||||
|
||||
# a path that will fail -f test on any posix bash
|
||||
NPX_WSL_PATH="/.."
|
||||
|
||||
# WSL can run Windows binaries, so we have to give it the win32 path
|
||||
# however, WSL bash tests against posix paths, so we need to construct that
|
||||
# to know if npm is installed globally.
|
||||
if [ `uname` = 'Linux' ] && type wslpath &>/dev/null ; then
|
||||
NPX_WSL_PATH=`wslpath "$NPM_PREFIX_NPX_CLI_JS"`
|
||||
fi
|
||||
if [ -f "$NPM_PREFIX_NPX_CLI_JS" ] || [ -f "$NPX_WSL_PATH" ]; then
|
||||
NPX_CLI_JS="$NPM_PREFIX_NPX_CLI_JS"
|
||||
fi
|
||||
|
||||
"$NODE_EXE" "$NPX_CLI_JS" "$@"
|
125
node/lib/node_modules/npm/bin/npx-cli.js
generated
vendored
Executable file
125
node/lib/node_modules/npm/bin/npx-cli.js
generated
vendored
Executable file
|
@ -0,0 +1,125 @@
|
|||
#!/usr/bin/env node
|
||||
|
||||
const cli = require('../lib/cli.js')
|
||||
|
||||
// run the resulting command as `npm exec ...args`
|
||||
process.argv[1] = require.resolve('./npm-cli.js')
|
||||
process.argv.splice(2, 0, 'exec')
|
||||
|
||||
// TODO: remove the affordances for removed items in npm v9
|
||||
const removedSwitches = new Set([
|
||||
'always-spawn',
|
||||
'ignore-existing',
|
||||
'shell-auto-fallback',
|
||||
])
|
||||
|
||||
const removedOpts = new Set([
|
||||
'npm',
|
||||
'node-arg',
|
||||
'n',
|
||||
])
|
||||
|
||||
const removed = new Set([
|
||||
...removedSwitches,
|
||||
...removedOpts,
|
||||
])
|
||||
|
||||
const { definitions, shorthands } = require('../lib/utils/config/index.js')
|
||||
const npmSwitches = Object.entries(definitions)
|
||||
.filter(([key, {type}]) => type === Boolean ||
|
||||
(Array.isArray(type) && type.includes(Boolean)))
|
||||
.map(([key]) => key)
|
||||
|
||||
// things that don't take a value
|
||||
const switches = new Set([
|
||||
...removedSwitches,
|
||||
...npmSwitches,
|
||||
'no-install',
|
||||
'quiet',
|
||||
'q',
|
||||
'version',
|
||||
'v',
|
||||
'help',
|
||||
'h',
|
||||
])
|
||||
|
||||
// things that do take a value
|
||||
const opts = new Set([
|
||||
...removedOpts,
|
||||
'package',
|
||||
'p',
|
||||
'cache',
|
||||
'userconfig',
|
||||
'call',
|
||||
'c',
|
||||
'shell',
|
||||
'npm',
|
||||
'node-arg',
|
||||
'n',
|
||||
])
|
||||
|
||||
// break out of loop when we find a positional argument or --
|
||||
// If we find a positional arg, we shove -- in front of it, and
|
||||
// let the normal npm cli handle the rest.
|
||||
let i
|
||||
let sawRemovedFlags = false
|
||||
for (i = 3; i < process.argv.length; i++) {
|
||||
const arg = process.argv[i]
|
||||
if (arg === '--')
|
||||
break
|
||||
else if (/^-/.test(arg)) {
|
||||
const [key, ...v] = arg.replace(/^-+/, '').split('=')
|
||||
|
||||
switch (key) {
|
||||
case 'p':
|
||||
process.argv[i] = ['--package', ...v].join('=')
|
||||
break
|
||||
|
||||
case 'shell':
|
||||
process.argv[i] = ['--script-shell', ...v].join('=')
|
||||
break
|
||||
|
||||
case 'no-install':
|
||||
process.argv[i] = '--yes=false'
|
||||
break
|
||||
|
||||
default:
|
||||
// resolve shorthands and run again
|
||||
if (shorthands[key] && !removed.has(key)) {
|
||||
const a = [...shorthands[key]]
|
||||
if (v.length)
|
||||
a.push(v.join('='))
|
||||
process.argv.splice(i, 1, ...a)
|
||||
i--
|
||||
continue
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
if (removed.has(key)) {
|
||||
console.error(`npx: the --${key} argument has been removed.`)
|
||||
sawRemovedFlags = true
|
||||
process.argv.splice(i, 1)
|
||||
i--
|
||||
}
|
||||
|
||||
if (v.length === 0 && !switches.has(key) &&
|
||||
(opts.has(key) || !/^-/.test(process.argv[i + 1]))) {
|
||||
// value will be next argument, skip over it.
|
||||
if (removed.has(key)) {
|
||||
// also remove the value for the cut key.
|
||||
process.argv.splice(i + 1, 1)
|
||||
} else
|
||||
i++
|
||||
}
|
||||
} else {
|
||||
// found a positional arg, put -- in front of it, and we're done
|
||||
process.argv.splice(i, 0, '--')
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if (sawRemovedFlags)
|
||||
console.error('See `npm help exec` for more information')
|
||||
|
||||
cli(process)
|
20
node/lib/node_modules/npm/bin/npx.cmd
generated
vendored
Executable file
20
node/lib/node_modules/npm/bin/npx.cmd
generated
vendored
Executable file
|
@ -0,0 +1,20 @@
|
|||
:: Created by npm, please don't edit manually.
|
||||
@ECHO OFF
|
||||
|
||||
SETLOCAL
|
||||
|
||||
SET "NODE_EXE=%~dp0\node.exe"
|
||||
IF NOT EXIST "%NODE_EXE%" (
|
||||
SET "NODE_EXE=node"
|
||||
)
|
||||
|
||||
SET "NPM_CLI_JS=%~dp0\node_modules\npm\bin\npm-cli.js"
|
||||
SET "NPX_CLI_JS=%~dp0\node_modules\npm\bin\npx-cli.js"
|
||||
FOR /F "delims=" %%F IN ('CALL "%NODE_EXE%" "%NPM_CLI_JS%" prefix -g') DO (
|
||||
SET "NPM_PREFIX_NPX_CLI_JS=%%F\node_modules\npm\bin\npx-cli.js"
|
||||
)
|
||||
IF EXIST "%NPM_PREFIX_NPX_CLI_JS%" (
|
||||
SET "NPX_CLI_JS=%NPM_PREFIX_NPX_CLI_JS%"
|
||||
)
|
||||
|
||||
"%NODE_EXE%" "%NPX_CLI_JS%" %*
|
121
node/lib/node_modules/npm/docs/content/commands/npm-access.md
generated
vendored
Normal file
121
node/lib/node_modules/npm/docs/content/commands/npm-access.md
generated
vendored
Normal file
|
@ -0,0 +1,121 @@
|
|||
---
|
||||
title: npm-access
|
||||
section: 1
|
||||
description: Set access level on published packages
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm access public [<package>]
|
||||
npm access restricted [<package>]
|
||||
|
||||
npm access grant <read-only|read-write> <scope:team> [<package>]
|
||||
npm access revoke <scope:team> [<package>]
|
||||
|
||||
npm access 2fa-required [<package>]
|
||||
npm access 2fa-not-required [<package>]
|
||||
|
||||
npm access ls-packages [<user>|<scope>|<scope:team>]
|
||||
npm access ls-collaborators [<package> [<user>]]
|
||||
npm access edit [<package>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Used to set access controls on private packages.
|
||||
|
||||
For all of the subcommands, `npm access` will perform actions on the packages
|
||||
in the current working directory if no package name is passed to the
|
||||
subcommand.
|
||||
|
||||
* public / restricted:
|
||||
Set a package to be either publicly accessible or restricted.
|
||||
|
||||
* grant / revoke:
|
||||
Add or remove the ability of users and teams to have read-only or read-write
|
||||
access to a package.
|
||||
|
||||
* 2fa-required / 2fa-not-required:
|
||||
Configure whether a package requires that anyone publishing it have two-factor
|
||||
authentication enabled on their account.
|
||||
|
||||
* ls-packages:
|
||||
Show all of the packages a user or a team is able to access, along with the
|
||||
access level, except for read-only public packages (it won't print the whole
|
||||
registry listing)
|
||||
|
||||
* ls-collaborators:
|
||||
Show all of the access privileges for a package. Will only show permissions
|
||||
for packages to which you have at least read access. If `<user>` is passed in,
|
||||
the list is filtered only to teams _that_ user happens to belong to.
|
||||
|
||||
* edit:
|
||||
Set the access privileges for a package at once using `$EDITOR`.
|
||||
|
||||
### Details
|
||||
|
||||
`npm access` always operates directly on the current registry, configurable
|
||||
from the command line using `--registry=<registry url>`.
|
||||
|
||||
Unscoped packages are *always public*.
|
||||
|
||||
Scoped packages *default to restricted*, but you can either publish them as
|
||||
public using `npm publish --access=public`, or set their access as public using
|
||||
`npm access public` after the initial publish.
|
||||
|
||||
You must have privileges to set the access of a package:
|
||||
|
||||
* You are an owner of an unscoped or scoped package.
|
||||
* You are a member of the team that owns a scope.
|
||||
* You have been given read-write privileges for a package, either as a member
|
||||
of a team or directly as an owner.
|
||||
|
||||
If you have two-factor authentication enabled then you'll be prompted to
|
||||
provide an otp token, or may use the `--otp=...` option to specify it on
|
||||
the command line.
|
||||
|
||||
If your account is not paid, then attempts to publish scoped packages will
|
||||
fail with an HTTP 402 status code (logically enough), unless you use
|
||||
`--access=public`.
|
||||
|
||||
Management of teams and team memberships is done with the `npm team` command.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
* Type: URL
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
* Type: null or String
|
||||
|
||||
This is a one-time password from a two-factor authenticator. It's needed
|
||||
when publishing or changing package permissions with `npm access`.
|
||||
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [`libnpmaccess`](https://npm.im/libnpmaccess)
|
||||
* [npm team](/commands/npm-team)
|
||||
* [npm publish](/commands/npm-publish)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npm registry](/using-npm/registry)
|
94
node/lib/node_modules/npm/docs/content/commands/npm-adduser.md
generated
vendored
Normal file
94
node/lib/node_modules/npm/docs/content/commands/npm-adduser.md
generated
vendored
Normal file
|
@ -0,0 +1,94 @@
|
|||
---
|
||||
title: npm-adduser
|
||||
section: 1
|
||||
description: Add a registry user account
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm adduser [--registry=url] [--scope=@orgname] [--auth-type=legacy]
|
||||
|
||||
aliases: login, add-user
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
Create or verify a user named `<username>` in the specified registry, and
|
||||
save the credentials to the `.npmrc` file. If no registry is specified,
|
||||
the default registry will be used (see [`config`](/using-npm/config)).
|
||||
|
||||
The username, password, and email are read in from prompts.
|
||||
|
||||
To reset your password, go to <https://www.npmjs.com/forgot>
|
||||
|
||||
To change your email address, go to <https://www.npmjs.com/email-edit>
|
||||
|
||||
You may use this command multiple times with the same user account to
|
||||
authorize on a new machine. When authenticating on a new machine,
|
||||
the username, password and email address must all match with
|
||||
your existing record.
|
||||
|
||||
`npm login` is an alias to `adduser` and behaves exactly the same way.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
* Type: URL
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `scope`
|
||||
|
||||
* Default: the scope of the current project, if any, or ""
|
||||
* Type: String
|
||||
|
||||
Associate an operation with a scope for a scoped registry.
|
||||
|
||||
Useful when logging in to or out of a private registry:
|
||||
|
||||
```
|
||||
# log in, linking the scope to the custom registry
|
||||
npm login --scope=@mycorp --registry=https://registry.mycorp.com
|
||||
|
||||
# log out, removing the link and the auth token
|
||||
npm logout --scope=@mycorp
|
||||
```
|
||||
|
||||
This will cause `@mycorp` to be mapped to the registry for future
|
||||
installation of packages specified according to the pattern
|
||||
`@mycorp/package`.
|
||||
|
||||
This will also cause `npm init` to create a scoped package.
|
||||
|
||||
```
|
||||
# accept all defaults, and create a package named "@foo/whatever",
|
||||
# instead of just named "whatever"
|
||||
npm init --scope=@foo --yes
|
||||
```
|
||||
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm owner](/commands/npm-owner)
|
||||
* [npm whoami](/commands/npm-whoami)
|
||||
* [npm token](/commands/npm-token)
|
||||
* [npm profile](/commands/npm-profile)
|
368
node/lib/node_modules/npm/docs/content/commands/npm-audit.md
generated
vendored
Normal file
368
node/lib/node_modules/npm/docs/content/commands/npm-audit.md
generated
vendored
Normal file
|
@ -0,0 +1,368 @@
|
|||
---
|
||||
title: npm-audit
|
||||
section: 1
|
||||
description: Run a security audit
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm audit [--json] [--production] [--audit-level=(low|moderate|high|critical)]
|
||||
npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=(dev|prod)]
|
||||
|
||||
common options: [--production] [--only=(dev|prod)]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
The audit command submits a description of the dependencies configured in
|
||||
your project to your default registry and asks for a report of known
|
||||
vulnerabilities. If any vulnerabilities are found, then the impact and
|
||||
appropriate remediation will be calculated. If the `fix` argument is
|
||||
provided, then remediations will be applied to the package tree.
|
||||
|
||||
The command will exit with a 0 exit code if no vulnerabilities were found.
|
||||
|
||||
Note that some vulnerabilities cannot be fixed automatically and will
|
||||
require manual intervention or review. Also note that since `npm audit
|
||||
fix` runs a full-fledged `npm install` under the hood, all configs that
|
||||
apply to the installer will also apply to `npm install` -- so things like
|
||||
`npm audit fix --package-lock-only` will work as expected.
|
||||
|
||||
By default, the audit command will exit with a non-zero code if any
|
||||
vulnerability is found. It may be useful in CI environments to include the
|
||||
`--audit-level` parameter to specify the minimum vulnerability level that
|
||||
will cause the command to fail. This option does not filter the report
|
||||
output, it simply changes the command's failure threshold.
|
||||
|
||||
### Audit Endpoints
|
||||
|
||||
There are two audit endpoints that npm may use to fetch vulnerability
|
||||
information: the `Bulk Advisory` endpoint and the `Quick Audit` endpoint.
|
||||
|
||||
#### Bulk Advisory Endpoint
|
||||
|
||||
As of version 7, npm uses the much faster `Bulk Advisory` endpoint to
|
||||
optimize the speed of calculating audit results.
|
||||
|
||||
npm will generate a JSON payload with the name and list of versions of each
|
||||
package in the tree, and POST it to the default configured registry at
|
||||
the path `/-/npm/v1/security/advisories/bulk`.
|
||||
|
||||
Any packages in the tree that do not have a `version` field in their
|
||||
package.json file will be ignored. If any `--omit` options are specified
|
||||
(either via the `--omit` config, or one of the shorthands such as
|
||||
`--production`, `--only=dev`, and so on), then packages will be omitted
|
||||
from the submitted payload as appropriate.
|
||||
|
||||
If the registry responds with an error, or with an invalid response, then
|
||||
npm will attempt to load advisory data from the `Quick Audit` endpoint.
|
||||
|
||||
The expected result will contain a set of advisory objects for each
|
||||
dependency that matches the advisory range. Each advisory object contains
|
||||
a `name`, `url`, `id`, `severity`, `vulnerable_versions`, and `title`.
|
||||
|
||||
npm then uses these advisory objects to calculate vulnerabilities and
|
||||
meta-vulnerabilities of the dependencies within the tree.
|
||||
|
||||
#### Quick Audit Endpoint
|
||||
|
||||
If the `Bulk Advisory` endpoint returns an error, or invalid data, npm will
|
||||
attempt to load advisory data from the `Quick Audit` endpoint, which is
|
||||
considerably slower in most cases.
|
||||
|
||||
The full package tree as found in `package-lock.json` is submitted, along
|
||||
with the following pieces of additional metadata:
|
||||
|
||||
* `npm_version`
|
||||
* `node_version`
|
||||
* `platform`
|
||||
* `arch`
|
||||
* `node_env`
|
||||
|
||||
All packages in the tree are submitted to the Quick Audit endpoint.
|
||||
Omitted dependency types are skipped when generating the report.
|
||||
|
||||
#### Scrubbing
|
||||
|
||||
Out of an abundance of caution, npm versions 5 and 6 would "scrub" any
|
||||
packages from the submitted report if their name contained a `/` character,
|
||||
so as to avoid leaking the names of potentially private packages or git
|
||||
URLs.
|
||||
|
||||
However, in practice, this resulted in audits often failing to properly
|
||||
detect meta-vulnerabilities, because the tree would appear to be invalid
|
||||
due to missing dependencies, and prevented the detection of vulnerabilities
|
||||
in package trees that used git dependencies or private modules.
|
||||
|
||||
This scrubbing has been removed from npm as of version 7.
|
||||
|
||||
#### Calculating Meta-Vulnerabilities and Remediations
|
||||
|
||||
npm uses the
|
||||
[`@npmcli/metavuln-calculator`](http://npm.im/@npmcli/metavuln-calculator)
|
||||
module to turn a set of security advisories into a set of "vulnerability"
|
||||
objects. A "meta-vulnerability" is a dependency that is vulnerable by
|
||||
virtue of dependence on vulnerable versions of a vulnerable package.
|
||||
|
||||
For example, if the package `foo` is vulnerable in the range `>=1.0.2
|
||||
<2.0.0`, and the package `bar` depends on `foo@^1.1.0`, then that version
|
||||
of `bar` can only be installed by installing a vulnerable version of `foo`.
|
||||
In this case, `bar` is a "metavulnerability".
|
||||
|
||||
Once metavulnerabilities for a given package are calculated, they are
|
||||
cached in the `~/.npm` folder and only re-evaluated if the advisory range
|
||||
changes, or a new version of the package is published (in which case, the
|
||||
new version is checked for metavulnerable status as well).
|
||||
|
||||
If the chain of metavulnerabilities extends all the way to the root
|
||||
project, and it cannot be updated without changing its dependency ranges,
|
||||
then `npm audit fix` will require the `--force` option to apply the
|
||||
remediation. If remediations do not require changes to the dependency
|
||||
ranges, then all vulnerable packages will be updated to a version that does
|
||||
not have an advisory or metavulnerability posted against it.
|
||||
|
||||
### Exit Code
|
||||
|
||||
The `npm audit` command will exit with a 0 exit code if no vulnerabilities
|
||||
were found. The `npm audit fix` command will exit with 0 exit code if no
|
||||
vulnerabilities are found _or_ if the remediation is able to successfully
|
||||
fix all vulnerabilities.
|
||||
|
||||
If vulnerabilities were found the exit code will depend on the
|
||||
`audit-level` configuration setting.
|
||||
|
||||
### Examples
|
||||
|
||||
Scan your project for vulnerabilities and automatically install any compatible
|
||||
updates to vulnerable dependencies:
|
||||
|
||||
```bash
|
||||
$ npm audit fix
|
||||
```
|
||||
|
||||
Run `audit fix` without modifying `node_modules`, but still updating the
|
||||
pkglock:
|
||||
|
||||
```bash
|
||||
$ npm audit fix --package-lock-only
|
||||
```
|
||||
|
||||
Skip updating `devDependencies`:
|
||||
|
||||
```bash
|
||||
$ npm audit fix --only=prod
|
||||
```
|
||||
|
||||
Have `audit fix` install SemVer-major updates to toplevel dependencies, not
|
||||
just SemVer-compatible ones:
|
||||
|
||||
```bash
|
||||
$ npm audit fix --force
|
||||
```
|
||||
|
||||
Do a dry run to get an idea of what `audit fix` will do, and _also_ output
|
||||
install information in JSON format:
|
||||
|
||||
```bash
|
||||
$ npm audit fix --dry-run --json
|
||||
```
|
||||
|
||||
Scan your project for vulnerabilities and just show the details, without
|
||||
fixing anything:
|
||||
|
||||
```bash
|
||||
$ npm audit
|
||||
```
|
||||
|
||||
Get the detailed audit report in JSON format:
|
||||
|
||||
```bash
|
||||
$ npm audit --json
|
||||
```
|
||||
|
||||
Fail an audit only if the results include a vulnerability with a level of moderate or higher:
|
||||
|
||||
```bash
|
||||
$ npm audit --audit-level=moderate
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `audit-level`
|
||||
|
||||
* Default: null
|
||||
* Type: null, "info", "low", "moderate", "high", "critical", or "none"
|
||||
|
||||
The minimum level of vulnerability for `npm audit` to exit with a non-zero
|
||||
exit code.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
* 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`, as well as `pack` and `publish`.
|
||||
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `force`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Removes various protections against unfortunate side effects, common
|
||||
mistakes, unnecessary performance degradation, and malicious input.
|
||||
|
||||
* Allow clobbering non-npm files in global installs.
|
||||
* Allow the `npm version` command to work on an unclean git repository.
|
||||
* Allow deleting the cache folder with `npm cache clean`.
|
||||
* Allow installing packages that have an `engines` declaration requiring a
|
||||
different version of npm.
|
||||
* Allow installing packages that have an `engines` declaration requiring a
|
||||
different version of `node`, even if `--engine-strict` is enabled.
|
||||
* Allow `npm audit fix` to install modules outside your stated dependency
|
||||
range (including SemVer-major changes).
|
||||
* Allow unpublishing all versions of a published package.
|
||||
* Allow conflicting peerDependencies to be installed in the root project.
|
||||
* Implicitly set `--yes` during `npm init`.
|
||||
* Allow clobbering existing values in `npm pkg`
|
||||
|
||||
If you don't have a clear idea of what you want to do, it is strongly
|
||||
recommended that you do not use this option!
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
* In `npm pkg set` it enables parsing set values with JSON.parse() before
|
||||
saving them to your `package.json`.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock-only`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If set to true, the current operation will only use the `package-lock.json`,
|
||||
ignoring `node_modules`.
|
||||
|
||||
For `update` this means only the `package-lock.json` will be updated,
|
||||
instead of checking `node_modules` and downloading dependencies.
|
||||
|
||||
For `list` this means the output will be based on the tree described by the
|
||||
`package-lock.json`, rather than the contents of `node_modules`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
'production', otherwise empty.
|
||||
* Type: "dev", "optional", or "peer" (can be set multiple times)
|
||||
|
||||
Dependency types to omit from the installation tree on disk.
|
||||
|
||||
Note that these dependencies _are_ still resolved and added to the
|
||||
`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
|
||||
physically installed on disk.
|
||||
|
||||
If a package type appears in both the `--include` and `--omit` lists, then
|
||||
it will be included.
|
||||
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/commands/npm-install)
|
||||
* [config](/using-npm/config)
|
49
node/lib/node_modules/npm/docs/content/commands/npm-bin.md
generated
vendored
Normal file
49
node/lib/node_modules/npm/docs/content/commands/npm-bin.md
generated
vendored
Normal file
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
title: npm-bin
|
||||
section: 1
|
||||
description: Display npm bin folder
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm bin [-g|--global]
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
Print the folder where npm will install executables.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Operates in "global" mode, so that packages are installed into the `prefix`
|
||||
folder instead of the current working directory. See
|
||||
[folders](/configuring-npm/folders) for more on the differences in behavior.
|
||||
|
||||
* packages are installed into the `{prefix}/lib/node_modules` folder, instead
|
||||
of the current working directory.
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm prefix](/commands/npm-prefix)
|
||||
* [npm root](/commands/npm-root)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
62
node/lib/node_modules/npm/docs/content/commands/npm-bugs.md
generated
vendored
Normal file
62
node/lib/node_modules/npm/docs/content/commands/npm-bugs.md
generated
vendored
Normal file
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
title: npm-bugs
|
||||
section: 1
|
||||
description: Report bugs for a package in a web browser
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm bugs [<pkgname> [<pkgname> ...]]
|
||||
|
||||
aliases: issues
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command tries to guess at the likely location of a package's bug
|
||||
tracker URL or the `mailto` URL of the support email, and then tries to
|
||||
open it using the `--browser` config param. If no package name is provided, it
|
||||
will search for a `package.json` in the current folder and use the `name` property.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `browser`
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
* Type: null, Boolean, or String
|
||||
|
||||
The browser that is called by npm commands to open websites.
|
||||
|
||||
Set to `false` to suppress browser behavior and instead print urls to
|
||||
terminal.
|
||||
|
||||
Set to `true` to use default system URL opener.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
* Type: URL
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm docs](/commands/npm-docs)
|
||||
* [npm view](/commands/npm-view)
|
||||
* [npm publish](/commands/npm-publish)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [package.json](/configuring-npm/package-json)
|
105
node/lib/node_modules/npm/docs/content/commands/npm-cache.md
generated
vendored
Normal file
105
node/lib/node_modules/npm/docs/content/commands/npm-cache.md
generated
vendored
Normal file
|
@ -0,0 +1,105 @@
|
|||
---
|
||||
title: npm-cache
|
||||
section: 1
|
||||
description: Manipulates packages cache
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm cache add <tarball file>...
|
||||
npm cache add <folder>...
|
||||
npm cache add <tarball url>...
|
||||
npm cache add <name>@<version>...
|
||||
|
||||
npm cache clean
|
||||
aliases: npm cache clear, npm cache rm
|
||||
|
||||
npm cache verify
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
Used to add, list, or clean the npm cache folder.
|
||||
|
||||
* add:
|
||||
Add the specified packages to the local cache. This command is primarily
|
||||
intended to be used internally by npm, but it can provide a way to
|
||||
add data to the local installation cache explicitly.
|
||||
|
||||
* clean:
|
||||
Delete all data out of the cache folder. Note that this is typically
|
||||
unnecessary, as npm's cache is self-healing and resistant to data
|
||||
corruption issues.
|
||||
|
||||
* verify:
|
||||
Verify the contents of the cache folder, garbage collecting any unneeded
|
||||
data, and verifying the integrity of the cache index and all cached data.
|
||||
|
||||
### Details
|
||||
|
||||
npm stores cache data in an opaque directory within the configured `cache`,
|
||||
named `_cacache`. This directory is a
|
||||
[`cacache`](http://npm.im/cacache)-based content-addressable cache that
|
||||
stores all http request data as well as other package-related data. This
|
||||
directory is primarily accessed through `pacote`, the library responsible
|
||||
for all package fetching as of npm@5.
|
||||
|
||||
All data that passes through the cache is fully verified for integrity on
|
||||
both insertion and extraction. Cache corruption will either trigger an
|
||||
error, or signal to `pacote` that the data must be refetched, which it will
|
||||
do automatically. For this reason, it should never be necessary to clear
|
||||
the cache for any reason other than reclaiming disk space, thus why `clean`
|
||||
now requires `--force` to run.
|
||||
|
||||
There is currently no method exposed through npm to inspect or directly
|
||||
manage the contents of this cache. In order to access it, `cacache` must be
|
||||
used directly.
|
||||
|
||||
npm will not remove data by itself: the cache will grow as new packages are
|
||||
installed.
|
||||
|
||||
### A note about the cache's design
|
||||
|
||||
The npm cache is strictly a cache: it should not be relied upon as a
|
||||
persistent and reliable data store for package data. npm makes no guarantee
|
||||
that a previously-cached piece of data will be available later, and will
|
||||
automatically delete corrupted contents. The primary guarantee that the
|
||||
cache makes is that, if it does return data, that data will be exactly the
|
||||
data that was inserted.
|
||||
|
||||
To run an offline verification of existing cache contents, use `npm cache
|
||||
verify`.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `cache`
|
||||
|
||||
* Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm`
|
||||
* Type: Path
|
||||
|
||||
The location of npm's cache directory. See [`npm
|
||||
cache`](/commands/npm-cache)
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm install](/commands/npm-install)
|
||||
* [npm publish](/commands/npm-publish)
|
||||
* [npm pack](/commands/npm-pack)
|
||||
* https://npm.im/cacache
|
||||
* https://npm.im/pacote
|
||||
* https://npm.im/@npmcli/arborist
|
||||
* https://npm.im/make-fetch-happen
|
117
node/lib/node_modules/npm/docs/content/commands/npm-ci.md
generated
vendored
Normal file
117
node/lib/node_modules/npm/docs/content/commands/npm-ci.md
generated
vendored
Normal file
|
@ -0,0 +1,117 @@
|
|||
---
|
||||
title: npm-ci
|
||||
section: 1
|
||||
description: Install a project with a clean slate
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command is similar to [`npm install`](/commands/npm-install), except
|
||||
it's meant to be used in automated environments such as test platforms,
|
||||
continuous integration, and deployment -- or any situation where you want
|
||||
to make sure you're doing a clean install of your dependencies.
|
||||
|
||||
`npm ci` will be significantly faster when:
|
||||
|
||||
- There is a `package-lock.json` or `npm-shrinkwrap.json` file.
|
||||
- The `node_modules` folder is missing or empty.
|
||||
|
||||
In short, the main differences between using `npm install` and `npm ci` are:
|
||||
|
||||
* The project **must** have an existing `package-lock.json` or
|
||||
`npm-shrinkwrap.json`.
|
||||
* If dependencies in the package lock do not match those in `package.json`,
|
||||
`npm ci` will exit with an error, instead of updating the package lock.
|
||||
* `npm ci` can only install entire projects at a time: individual
|
||||
dependencies cannot be added with this command.
|
||||
* If a `node_modules` is already present, it will be automatically removed
|
||||
before `npm ci` begins its install.
|
||||
* It will never write to `package.json` or any of the package-locks:
|
||||
installs are essentially frozen.
|
||||
|
||||
### Example
|
||||
|
||||
Make sure you have a package-lock and an up-to-date install:
|
||||
|
||||
```bash
|
||||
$ cd ./my/npm/project
|
||||
$ npm install
|
||||
added 154 packages in 10s
|
||||
$ ls | grep package-lock
|
||||
```
|
||||
|
||||
Run `npm ci` in that project
|
||||
|
||||
```bash
|
||||
$ npm ci
|
||||
added 154 packages in 5s
|
||||
```
|
||||
|
||||
Configure Travis to build using `npm ci` instead of `npm install`:
|
||||
|
||||
```bash
|
||||
# .travis.yml
|
||||
install:
|
||||
- npm ci
|
||||
# keep the npm cache around to speed up installs
|
||||
cache:
|
||||
directories:
|
||||
- "$HOME/.npm"
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" submit audit reports alongside the current npm command to the
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If true, npm does not run scripts specified in package.json files.
|
||||
|
||||
Note that commands explicitly intended to run a particular script, such as
|
||||
`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `script-shell`
|
||||
|
||||
* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
|
||||
* Type: null or String
|
||||
|
||||
The shell to use for scripts run with the `npm exec`, `npm run` and `npm
|
||||
init <pkg>` commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/commands/npm-install)
|
||||
* [package-lock.json](/configuring-npm/package-lock-json)
|
41
node/lib/node_modules/npm/docs/content/commands/npm-completion.md
generated
vendored
Normal file
41
node/lib/node_modules/npm/docs/content/commands/npm-completion.md
generated
vendored
Normal file
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: npm-completion
|
||||
section: 1
|
||||
description: Tab Completion for npm
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
source <(npm completion)
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
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:
|
||||
|
||||
```bash
|
||||
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` or
|
||||
`/etc/bash_completion.d/npm` if you have a system that will read
|
||||
that file for you.
|
||||
|
||||
When `COMP_CWORD`, `COMP_LINE`, and `COMP_POINT` are defined in the
|
||||
environment, `npm completion` acts in "plumbing mode", and outputs
|
||||
completions based on the arguments.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm developers](/using-npm/developers)
|
||||
* [npm](/commands/npm)
|
173
node/lib/node_modules/npm/docs/content/commands/npm-config.md
generated
vendored
Normal file
173
node/lib/node_modules/npm/docs/content/commands/npm-config.md
generated
vendored
Normal file
|
@ -0,0 +1,173 @@
|
|||
---
|
||||
title: npm-config
|
||||
section: 1
|
||||
description: Manage the npm configuration files
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm config set <key>=<value> [<key>=<value> ...]
|
||||
npm config get [<key> [<key> ...]]
|
||||
npm config delete <key> [<key> ...]
|
||||
npm config list [--json]
|
||||
npm config edit
|
||||
npm set <key>=<value> [<key>=<value> ...]
|
||||
npm get [<key> [<key> ...]]
|
||||
|
||||
alias: c
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
npm gets its config settings from the command line, environment
|
||||
variables, `npmrc` files, and in some cases, the `package.json` file.
|
||||
|
||||
See [npmrc](/configuring-npm/npmrc) for more information about the npmrc
|
||||
files.
|
||||
|
||||
See [config(7)](/using-npm/config) for a more thorough explanation of the
|
||||
mechanisms involved, and a full list of config options available.
|
||||
|
||||
The `npm config` command can be used to update and edit the contents
|
||||
of the user and global npmrc files.
|
||||
|
||||
### Sub-commands
|
||||
|
||||
Config supports the following sub-commands:
|
||||
|
||||
#### set
|
||||
|
||||
```bash
|
||||
npm config set key=value [key=value...]
|
||||
npm set key=value [key=value...]
|
||||
```
|
||||
|
||||
Sets each of the config keys to the value provided.
|
||||
|
||||
If value is omitted, then it sets it to an empty string.
|
||||
|
||||
Note: for backwards compatibility, `npm config set key value` is supported
|
||||
as an alias for `npm config set key=value`.
|
||||
|
||||
#### get
|
||||
|
||||
```bash
|
||||
npm config get [key ...]
|
||||
npm get [key ...]
|
||||
```
|
||||
|
||||
Echo the config value(s) to stdout.
|
||||
|
||||
If multiple keys are provided, then the values will be prefixed with the
|
||||
key names.
|
||||
|
||||
If no keys are provided, then this command behaves the same as `npm config
|
||||
list`.
|
||||
|
||||
#### list
|
||||
|
||||
```bash
|
||||
npm config list
|
||||
```
|
||||
|
||||
Show all the config settings. Use `-l` to also show defaults. Use `--json`
|
||||
to show the settings in json format.
|
||||
|
||||
#### delete
|
||||
|
||||
```bash
|
||||
npm config delete key [key ...]
|
||||
```
|
||||
|
||||
Deletes the specified keys from all configuration files.
|
||||
|
||||
#### edit
|
||||
|
||||
```bash
|
||||
npm config edit
|
||||
```
|
||||
|
||||
Opens the config file in an editor. Use the `--global` flag to edit the
|
||||
global config.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
* In `npm pkg set` it enables parsing set values with JSON.parse() before
|
||||
saving them to your `package.json`.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Operates in "global" mode, so that packages are installed into the `prefix`
|
||||
folder instead of the current working directory. See
|
||||
[folders](/configuring-npm/folders) for more on the differences in behavior.
|
||||
|
||||
* packages are installed into the `{prefix}/lib/node_modules` folder, instead
|
||||
of the current working directory.
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `editor`
|
||||
|
||||
* Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on
|
||||
Windows, or 'vim' on Unix systems
|
||||
* Type: String
|
||||
|
||||
The command to run for `npm edit` and `npm config edit`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `location`
|
||||
|
||||
* Default: "user" unless `--global` is passed, which will also set this value
|
||||
to "global"
|
||||
* Type: "global", "user", or "project"
|
||||
|
||||
When passed to `npm config` this refers to which config file to use.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `long`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show extended information in `ls`, `search`, and `help-search`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm](/commands/npm)
|
304
node/lib/node_modules/npm/docs/content/commands/npm-dedupe.md
generated
vendored
Normal file
304
node/lib/node_modules/npm/docs/content/commands/npm-dedupe.md
generated
vendored
Normal file
|
@ -0,0 +1,304 @@
|
|||
---
|
||||
title: npm-dedupe
|
||||
section: 1
|
||||
description: Reduce duplication in the package tree
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm dedupe
|
||||
npm ddp
|
||||
|
||||
aliases: ddp
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Searches the local package tree and attempts to simplify the overall
|
||||
structure by moving dependencies further up the tree, where they can
|
||||
be more effectively shared by multiple dependent packages.
|
||||
|
||||
For example, consider this dependency graph:
|
||||
|
||||
```
|
||||
a
|
||||
+-- b <-- depends on c@1.0.x
|
||||
| `-- c@1.0.3
|
||||
`-- d <-- depends on c@~1.0.9
|
||||
`-- c@1.0.10
|
||||
```
|
||||
|
||||
In this case, `npm dedupe` will transform the tree to:
|
||||
|
||||
```bash
|
||||
a
|
||||
+-- b
|
||||
+-- d
|
||||
`-- c@1.0.10
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
In some cases, you may have a dependency graph like this:
|
||||
|
||||
```
|
||||
a
|
||||
+-- b <-- depends on c@1.0.x
|
||||
+-- c@1.0.3
|
||||
`-- d <-- depends on c@1.x
|
||||
`-- c@1.9.9
|
||||
```
|
||||
|
||||
During the installation process, the `c@1.0.3` dependency for `b` was
|
||||
placed in the root of the tree. Though `d`'s dependency on `c@1.x` could
|
||||
have been satisfied by `c@1.0.3`, the newer `c@1.9.0` dependency was used,
|
||||
because npm favors updates by default, even when doing so causes
|
||||
duplication.
|
||||
|
||||
Running `npm dedupe` will cause npm to note the duplication and
|
||||
re-evaluate, deleting the nested `c` module, because the one in the root is
|
||||
sufficient.
|
||||
|
||||
To prefer deduplication over novelty during the installation process, run
|
||||
`npm install --prefer-dedupe` or `npm config set prefer-dedupe true`.
|
||||
|
||||
Arguments are ignored. Dedupe always acts on the entire tree.
|
||||
|
||||
Note that this operation transforms the dependency tree, but will never
|
||||
result in new modules being installed.
|
||||
|
||||
Using `npm find-dupes` will run the command in `--dry-run` mode.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Causes npm to install the package into your local `node_modules` folder with
|
||||
the same layout it uses with the global `node_modules` folder. Only your
|
||||
direct dependencies will show in `node_modules` and everything they depend
|
||||
on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Causes npm to install the package such that versions of npm prior to 1.4,
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If set to `true`, and `--legacy-peer-deps` is not set, then _any_
|
||||
conflicting `peerDependencies` will be treated as an install failure, even
|
||||
if npm could reasonably guess the appropriate resolution based on non-peer
|
||||
dependency relationships.
|
||||
|
||||
By default, conflicting `peerDependencies` deep in the dependency graph will
|
||||
be resolved using the nearest non-peer dependency specification, even if
|
||||
doing so will result in some packages receiving a peer dependency outside
|
||||
the range set in their package's `peerDependencies` object.
|
||||
|
||||
When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
If set to false, then ignore `package-lock.json` files when installing. This
|
||||
will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
When package package-locks are disabled, automatic pruning of extraneous
|
||||
modules will also be disabled. To remove extraneous modules with
|
||||
package-locks disabled use `npm prune`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
'production', otherwise empty.
|
||||
* Type: "dev", "optional", or "peer" (can be set multiple times)
|
||||
|
||||
Dependency types to omit from the installation tree on disk.
|
||||
|
||||
Note that these dependencies _are_ still resolved and added to the
|
||||
`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
|
||||
physically installed on disk.
|
||||
|
||||
If a package type appears in both the `--include` and `--omit` lists, then
|
||||
it will be included.
|
||||
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If true, npm does not run scripts specified in package.json files.
|
||||
|
||||
Note that commands explicitly intended to run a particular script, such as
|
||||
`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" submit audit reports alongside the current npm command to the
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
Tells npm to create symlinks (or `.cmd` shims on Windows) for package
|
||||
executables.
|
||||
|
||||
Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
* 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`, as well as `pack` and `publish`.
|
||||
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm find-dupes](/commands/npm-find-dupes)
|
||||
* [npm ls](/commands/npm-ls)
|
||||
* [npm update](/commands/npm-update)
|
||||
* [npm install](/commands/npm-install)
|
79
node/lib/node_modules/npm/docs/content/commands/npm-deprecate.md
generated
vendored
Normal file
79
node/lib/node_modules/npm/docs/content/commands/npm-deprecate.md
generated
vendored
Normal file
|
@ -0,0 +1,79 @@
|
|||
---
|
||||
title: npm-deprecate
|
||||
section: 1
|
||||
description: Deprecate a version of a package
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm deprecate <pkg>[@<version range>] <message>
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
This command will update the npm registry entry for a package, providing a
|
||||
deprecation warning to all who attempt to install it.
|
||||
|
||||
It works on [version ranges](https://semver.npmjs.com/) as well as specific
|
||||
versions, so you can do something like this:
|
||||
|
||||
```bash
|
||||
npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
|
||||
```
|
||||
|
||||
SemVer ranges passed to this command are interpreted such that they *do*
|
||||
include prerelease versions. For example:
|
||||
|
||||
```bash
|
||||
npm deprecate my-thing@1.x "1.x is no longer supported"
|
||||
```
|
||||
|
||||
In this case, a version `my-thing@1.0.0-beta.0` will also be deprecated.
|
||||
|
||||
You must be the package owner to deprecate something. See the `owner` and
|
||||
`adduser` help topics.
|
||||
|
||||
To un-deprecate a package, specify an empty string (`""`) for the `message`
|
||||
argument. Note that you must use double quotes with no space between them to
|
||||
format an empty string.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
* Type: URL
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
* Type: null or String
|
||||
|
||||
This is a one-time password from a two-factor authenticator. It's needed
|
||||
when publishing or changing package permissions with `npm access`.
|
||||
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm publish](/commands/npm-publish)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm owner](/commands/npm-owner)
|
||||
* [npm adduser](/commands/npm-adduser)
|
342
node/lib/node_modules/npm/docs/content/commands/npm-diff.md
generated
vendored
Normal file
342
node/lib/node_modules/npm/docs/content/commands/npm-diff.md
generated
vendored
Normal file
|
@ -0,0 +1,342 @@
|
|||
---
|
||||
title: npm-diff
|
||||
section: 1
|
||||
description: The registry diff command
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm diff [...<paths>]
|
||||
npm diff --diff=<pkg-name> [...<paths>]
|
||||
npm diff --diff=<version-a> [--diff=<version-b>] [...<paths>]
|
||||
npm diff --diff=<spec-a> [--diff=<spec-b>] [...<paths>]
|
||||
npm diff [--diff-ignore-all-space] [--diff-name-only] [...<paths>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Similar to its `git diff` counterpart, this command will print diff patches
|
||||
of files for packages published to the npm registry.
|
||||
|
||||
* `npm diff --diff=<spec-a> --diff=<spec-b>`
|
||||
|
||||
Compares two package versions using their registry specifiers, e.g:
|
||||
`npm diff --diff=pkg@1.0.0 --diff=pkg@^2.0.0`. It's also possible to
|
||||
compare across forks of any package,
|
||||
e.g: `npm diff --diff=pkg@1.0.0 --diff=pkg-fork@1.0.0`.
|
||||
|
||||
Any valid spec can be used, so that it's also possible to compare
|
||||
directories or git repositories,
|
||||
e.g: `npm diff --diff=pkg@latest --diff=./packages/pkg`
|
||||
|
||||
Here's an example comparing two different versions of a package named
|
||||
`abbrev` from the registry:
|
||||
|
||||
```bash
|
||||
npm diff --diff=abbrev@1.1.0 --diff=abbrev@1.1.1
|
||||
```
|
||||
|
||||
On success, output looks like:
|
||||
|
||||
```bash
|
||||
diff --git a/package.json b/package.json
|
||||
index v1.1.0..v1.1.1 100644
|
||||
--- a/package.json
|
||||
+++ b/package.json
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "abbrev",
|
||||
- "version": "1.1.0",
|
||||
+ "version": "1.1.1",
|
||||
"description": "Like ruby's abbrev module, but in js",
|
||||
"author": "Isaac Z. Schlueter <i@izs.me>",
|
||||
"main": "abbrev.js",
|
||||
```
|
||||
|
||||
Given the flexible nature of npm specs, you can also target local
|
||||
directories or git repos just like when using `npm install`:
|
||||
|
||||
```bash
|
||||
npm diff --diff=https://github.com/npm/libnpmdiff --diff=./local-path
|
||||
```
|
||||
|
||||
In the example above we can compare the contents from the package installed
|
||||
from the git repo at `github.com/npm/libnpmdiff` with the contents of the
|
||||
`./local-path` that contains a valid package, such as a modified copy of
|
||||
the original.
|
||||
|
||||
* `npm diff` (in a package directory, no arguments):
|
||||
|
||||
If the package is published to the registry, `npm diff` will fetch the
|
||||
tarball version tagged as `latest` (this value can be configured using the
|
||||
`tag` option) and proceed to compare the contents of files present in that
|
||||
tarball, with the current files in your local file system.
|
||||
|
||||
This workflow provides a handy way for package authors to see what
|
||||
package-tracked files have been changed in comparison with the latest
|
||||
published version of that package.
|
||||
|
||||
* `npm diff --diff=<pkg-name>` (in a package directory):
|
||||
|
||||
When using a single package name (with no version or tag specifier) as an
|
||||
argument, `npm diff` will work in a similar way to
|
||||
[`npm-outdated`](npm-outdated) and reach for the registry to figure out
|
||||
what current published version of the package named `<pkg-name>`
|
||||
will satisfy its dependent declared semver-range. Once that specific
|
||||
version is known `npm diff` will print diff patches comparing the
|
||||
current version of `<pkg-name>` found in the local file system with
|
||||
that specific version returned by the registry.
|
||||
|
||||
Given a package named `abbrev` that is currently installed:
|
||||
|
||||
```bash
|
||||
npm diff --diff=abbrev
|
||||
```
|
||||
|
||||
That will request from the registry its most up to date version and
|
||||
will print a diff output comparing the currently installed version to this
|
||||
newer one if the version numbers are not the same.
|
||||
|
||||
* `npm diff --diff=<spec-a>` (in a package directory):
|
||||
|
||||
Similar to using only a single package name, it's also possible to declare
|
||||
a full registry specifier version if you wish to compare the local version
|
||||
of an installed package with the specific version/tag/semver-range provided
|
||||
in `<spec-a>`.
|
||||
|
||||
An example: assuming `pkg@1.0.0` is installed in the current `node_modules`
|
||||
folder, running:
|
||||
|
||||
```bash
|
||||
npm diff --diff=pkg@2.0.0
|
||||
```
|
||||
|
||||
It will effectively be an alias to
|
||||
`npm diff --diff=pkg@1.0.0 --diff=pkg@2.0.0`.
|
||||
|
||||
* `npm diff --diff=<semver-a> [--diff=<semver-b>]` (in a package directory):
|
||||
|
||||
Using `npm diff` along with semver-valid version numbers is a shorthand
|
||||
to compare different versions of the current package.
|
||||
|
||||
It needs to be run from a package directory, such that for a package named
|
||||
`pkg` running `npm diff --diff=1.0.0 --diff=1.0.1` is the same as running
|
||||
`npm diff --diff=pkg@1.0.0 --diff=pkg@1.0.1`.
|
||||
|
||||
If only a single argument `<version-a>` is provided, then the current local
|
||||
file system is going to be compared against that version.
|
||||
|
||||
Here's an example comparing two specific versions (published to the
|
||||
configured registry) of the current project directory:
|
||||
|
||||
```bash
|
||||
npm diff --diff=1.0.0 --diff=1.1.0
|
||||
```
|
||||
|
||||
Note that tag names are not valid `--diff` argument values, if you wish to
|
||||
compare to a published tag, you must use the `pkg@tagname` syntax.
|
||||
|
||||
#### Filtering files
|
||||
|
||||
It's possible to also specify positional arguments using file names or globs
|
||||
pattern matching in order to limit the result of diff patches to only a subset
|
||||
of files for a given package, e.g:
|
||||
|
||||
```bash
|
||||
npm diff --diff=pkg@2 ./lib/ CHANGELOG.md
|
||||
```
|
||||
|
||||
In the example above the diff output is only going to print contents of files
|
||||
located within the folder `./lib/` and changed lines of code within the
|
||||
`CHANGELOG.md` file.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `diff`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Define arguments to compare in `npm diff`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-name-only`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Prints only filenames when using `npm diff`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-unified`
|
||||
|
||||
* Default: 3
|
||||
* Type: Number
|
||||
|
||||
The number of lines of context to print in `npm diff`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-ignore-all-space`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Ignore whitespace when comparing lines in `npm diff`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-no-prefix`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Do not show any source or destination prefix in `npm diff` output.
|
||||
|
||||
Note: this causes `npm diff` to ignore the `--diff-src-prefix` and
|
||||
`--diff-dst-prefix` configs.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-src-prefix`
|
||||
|
||||
* Default: "a/"
|
||||
* Type: String
|
||||
|
||||
Source prefix to be used in `npm diff` output.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-dst-prefix`
|
||||
|
||||
* Default: "b/"
|
||||
* Type: String
|
||||
|
||||
Destination prefix to be used in `npm diff` output.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `diff-text`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Treat all files as text in `npm diff`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Operates in "global" mode, so that packages are installed into the `prefix`
|
||||
folder instead of the current working directory. See
|
||||
[folders](/configuring-npm/folders) for more on the differences in behavior.
|
||||
|
||||
* packages are installed into the `{prefix}/lib/node_modules` folder, instead
|
||||
of the current working directory.
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `tag`
|
||||
|
||||
* Default: "latest"
|
||||
* Type: String
|
||||
|
||||
If you ask npm to install a package and don't tell it a specific version,
|
||||
then it will install the specified tag.
|
||||
|
||||
Also the tag that is added to the package@version specified by the `npm tag`
|
||||
command, if no explicit tag is given.
|
||||
|
||||
When used by the `npm diff` command, this is the tag used to fetch the
|
||||
tarball that will be compared with the local files by default.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
## See Also
|
||||
|
||||
* [npm outdated](/commands/npm-outdated)
|
||||
* [npm install](/commands/npm-install)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npm registry](/using-npm/registry)
|
165
node/lib/node_modules/npm/docs/content/commands/npm-dist-tag.md
generated
vendored
Normal file
165
node/lib/node_modules/npm/docs/content/commands/npm-dist-tag.md
generated
vendored
Normal file
|
@ -0,0 +1,165 @@
|
|||
---
|
||||
title: npm-dist-tag
|
||||
section: 1
|
||||
description: Modify package distribution tags
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm dist-tag add <pkg>@<version> [<tag>]
|
||||
npm dist-tag rm <pkg> <tag>
|
||||
npm dist-tag ls [<pkg>]
|
||||
|
||||
aliases: dist-tags
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Add, remove, and enumerate distribution tags on a package:
|
||||
|
||||
* add: Tags the specified version of the package with the specified tag, or
|
||||
the `--tag` config if not specified. If you have two-factor
|
||||
authentication on auth-and-writes then you’ll need to include a one-time
|
||||
password on the command line with `--otp <one-time password>`, or at the
|
||||
OTP prompt.
|
||||
|
||||
* rm: Clear a tag that is no longer in use from the package. If you have
|
||||
two-factor authentication on auth-and-writes then you’ll need to include
|
||||
a one-time password on the command line with `--otp <one-time password>`,
|
||||
or at the OTP prompt.
|
||||
|
||||
* ls: Show all of the dist-tags for a package, defaulting to the package in
|
||||
the current prefix. This is the default action if none is specified.
|
||||
|
||||
A tag can be used when installing packages as a reference to a version instead
|
||||
of using a specific version number:
|
||||
|
||||
```bash
|
||||
npm install <name>@<tag>
|
||||
```
|
||||
|
||||
When installing dependencies, a preferred tagged version may be specified:
|
||||
|
||||
```bash
|
||||
npm install --tag <tag>
|
||||
```
|
||||
|
||||
(This also applies to any other commands that resolve and install
|
||||
dependencies, such as `npm dedupe`, `npm update`, and `npm audit fix`.)
|
||||
|
||||
Publishing a package sets the `latest` tag to the published version unless the
|
||||
`--tag` option is used. For example, `npm publish --tag=beta`.
|
||||
|
||||
By default, `npm install <pkg>` (without any `@<version>` or `@<tag>`
|
||||
specifier) installs the `latest` tag.
|
||||
|
||||
### Purpose
|
||||
|
||||
Tags can be used to provide an alias instead of version numbers.
|
||||
|
||||
For example, a project might choose to have multiple streams of development
|
||||
and use a different tag for each stream, e.g., `stable`, `beta`, `dev`,
|
||||
`canary`.
|
||||
|
||||
By default, the `latest` tag is used by npm to identify the current version
|
||||
of a package, and `npm install <pkg>` (without any `@<version>` or `@<tag>`
|
||||
specifier) installs the `latest` tag. Typically, projects only use the
|
||||
`latest` tag for stable release versions, and use other tags for unstable
|
||||
versions such as prereleases.
|
||||
|
||||
The `next` tag is used by some projects to identify the upcoming version.
|
||||
|
||||
Other than `latest`, no tag has any special significance to npm itself.
|
||||
|
||||
### Caveats
|
||||
|
||||
This command used to be known as `npm tag`, which only created new tags,
|
||||
and so had a different syntax.
|
||||
|
||||
Tags must share a namespace with version numbers, because they are
|
||||
specified in the same slot: `npm install <pkg>@<version>` vs
|
||||
`npm install <pkg>@<tag>`.
|
||||
|
||||
Tags that can be interpreted as valid semver ranges will be rejected. For
|
||||
example, `v1.4` cannot be used as a tag, because it is interpreted by
|
||||
semver as `>=1.4.0 <1.5.0`. See <https://github.com/npm/npm/issues/6082>.
|
||||
|
||||
The simplest way to avoid semver problems with tags is to use tags that do
|
||||
not begin with a number or the letter `v`.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm publish](/commands/npm-publish)
|
||||
* [npm install](/commands/npm-install)
|
||||
* [npm dedupe](/commands/npm-dedupe)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
122
node/lib/node_modules/npm/docs/content/commands/npm-docs.md
generated
vendored
Normal file
122
node/lib/node_modules/npm/docs/content/commands/npm-docs.md
generated
vendored
Normal file
|
@ -0,0 +1,122 @@
|
|||
---
|
||||
title: npm-docs
|
||||
section: 1
|
||||
description: Open documentation for a package in a web browser
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm docs [<pkgname> [<pkgname> ...]]
|
||||
|
||||
aliases: home
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command tries to guess at the likely location of a package's
|
||||
documentation URL, and then tries to open it using the `--browser` config
|
||||
param. You can pass multiple package names at once. If no package name is
|
||||
provided, it will search for a `package.json` in the current folder and use
|
||||
the `name` property.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `browser`
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
* Type: null, Boolean, or String
|
||||
|
||||
The browser that is called by npm commands to open websites.
|
||||
|
||||
Set to `false` to suppress browser behavior and instead print urls to
|
||||
terminal.
|
||||
|
||||
Set to `true` to use default system URL opener.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
* Type: URL
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm view](/commands/npm-view)
|
||||
* [npm publish](/commands/npm-publish)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [package.json](/configuring-npm/package-json)
|
126
node/lib/node_modules/npm/docs/content/commands/npm-doctor.md
generated
vendored
Normal file
126
node/lib/node_modules/npm/docs/content/commands/npm-doctor.md
generated
vendored
Normal file
|
@ -0,0 +1,126 @@
|
|||
---
|
||||
title: npm-doctor
|
||||
section: 1
|
||||
description: Check your npm environment
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm doctor
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
`npm doctor` runs a set of checks to ensure that your npm installation has
|
||||
what it needs to manage your JavaScript packages. npm is mostly a
|
||||
standalone tool, but it does have some basic requirements that must be met:
|
||||
|
||||
+ Node.js and git must be executable by npm.
|
||||
+ The primary npm registry, `registry.npmjs.com`, or another service that
|
||||
uses the registry API, is available.
|
||||
+ The directories that npm uses, `node_modules` (both locally and
|
||||
globally), exist and can be written by the current user.
|
||||
+ The npm cache exists, and the package tarballs within it aren't corrupt.
|
||||
|
||||
Without all of these working properly, npm may not work properly. Many
|
||||
issues are often attributable to things that are outside npm's code base,
|
||||
so `npm doctor` confirms that the npm installation is in a good state.
|
||||
|
||||
Also, in addition to this, there are also very many issue reports due to
|
||||
using old versions of npm. Since npm is constantly improving, running
|
||||
`npm@latest` is better than an old version.
|
||||
|
||||
`npm doctor` verifies the following items in your environment, and if there
|
||||
are any recommended changes, it will display them.
|
||||
|
||||
#### `npm ping`
|
||||
|
||||
By default, npm installs from the primary npm registry,
|
||||
`registry.npmjs.org`. `npm doctor` hits a special ping endpoint within the
|
||||
registry. This can also be checked with `npm ping`. If this check fails,
|
||||
you may be using a proxy that needs to be configured, or may need to talk
|
||||
to your IT staff to get access over HTTPS to `registry.npmjs.org`.
|
||||
|
||||
This check is done against whichever registry you've configured (you can
|
||||
see what that is by running `npm config get registry`), and if you're using
|
||||
a private registry that doesn't support the `/whoami` endpoint supported by
|
||||
the primary registry, this check may fail.
|
||||
|
||||
#### `npm -v`
|
||||
|
||||
While Node.js may come bundled with a particular version of npm, it's the
|
||||
policy of the CLI team that we recommend all users run `npm@latest` if they
|
||||
can. As the CLI is maintained by a small team of contributors, there are
|
||||
only resources for a single line of development, so npm's own long-term
|
||||
support releases typically only receive critical security and regression
|
||||
fixes. The team believes that the latest tested version of npm is almost
|
||||
always likely to be the most functional and defect-free version of npm.
|
||||
|
||||
#### `node -v`
|
||||
|
||||
For most users, in most circumstances, the best version of Node will be the
|
||||
latest long-term support (LTS) release. Those of you who want access to new
|
||||
ECMAscript features or bleeding-edge changes to Node's standard library may
|
||||
be running a newer version, and some may be required to run an older
|
||||
version of Node because of enterprise change control policies. That's OK!
|
||||
But in general, the npm team recommends that most users run Node.js LTS.
|
||||
|
||||
#### `npm config get registry`
|
||||
|
||||
You may be installing from private package registries for your project or
|
||||
company. That's great! Others may be following tutorials or StackOverflow
|
||||
questions in an effort to troubleshoot problems you may be having.
|
||||
Sometimes, this may entail changing the registry you're pointing at. This
|
||||
part of `npm doctor` just lets you, and maybe whoever's helping you with
|
||||
support, know that you're not using the default registry.
|
||||
|
||||
#### `which git`
|
||||
|
||||
While it's documented in the README, it may not be obvious that npm needs
|
||||
Git installed to do many of the things that it does. Also, in some cases
|
||||
– especially on Windows – you may have Git set up in such a way that it's
|
||||
not accessible via your `PATH` so that npm can find it. This check ensures
|
||||
that Git is available.
|
||||
|
||||
#### Permissions checks
|
||||
|
||||
* Your cache must be readable and writable by the user running npm.
|
||||
* Global package binaries must be writable by the user running npm.
|
||||
* Your local `node_modules` path, if you're running `npm doctor` with a
|
||||
project directory, must be readable and writable by the user running npm.
|
||||
|
||||
#### Validate the checksums of cached packages
|
||||
|
||||
When an npm package is published, the publishing process generates a
|
||||
checksum that npm uses at install time to verify that the package didn't
|
||||
get corrupted in transit. `npm doctor` uses these checksums to validate the
|
||||
package tarballs in your local cache (you can see where that cache is
|
||||
located with `npm config get cache`). In the event that there are corrupt
|
||||
packages in your cache, you should probably run `npm cache clean -f` and
|
||||
reset the cache.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
* Type: URL
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm bugs](/commands/npm-bugs)
|
||||
* [npm help](/commands/npm-help)
|
||||
* [npm ping](/commands/npm-ping)
|
52
node/lib/node_modules/npm/docs/content/commands/npm-edit.md
generated
vendored
Normal file
52
node/lib/node_modules/npm/docs/content/commands/npm-edit.md
generated
vendored
Normal file
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
title: npm-edit
|
||||
section: 1
|
||||
description: Edit an installed package
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm edit <pkg>
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
Selects a dependency in the current project and opens the package folder in
|
||||
the default editor (or whatever you've configured as the npm `editor`
|
||||
config -- see [`npm-config`](npm-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 edit connect` to make a few
|
||||
changes to your locally installed copy.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `editor`
|
||||
|
||||
* Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on
|
||||
Windows, or 'vim' on Unix systems
|
||||
* Type: String
|
||||
|
||||
The command to run for `npm edit` and `npm config edit`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm explore](/commands/npm-explore)
|
||||
* [npm install](/commands/npm-install)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
390
node/lib/node_modules/npm/docs/content/commands/npm-exec.md
generated
vendored
Normal file
390
node/lib/node_modules/npm/docs/content/commands/npm-exec.md
generated
vendored
Normal file
|
@ -0,0 +1,390 @@
|
|||
---
|
||||
title: npm-exec
|
||||
section: 1
|
||||
description: Run a command from a local or remote npm package
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm exec -- <pkg>[@<version>] [args...]
|
||||
npm exec --package=<pkg>[@<version>] -- <cmd> [args...]
|
||||
npm exec -c '<cmd> [args...]'
|
||||
npm exec --package=foo -c '<cmd> [args...]'
|
||||
npm exec [--ws] [-w <workspace-name] [args...]
|
||||
|
||||
npx <pkg>[@<specifier>] [args...]
|
||||
npx -p <pkg>[@<specifier>] <cmd> [args...]
|
||||
npx -c '<cmd> [args...]'
|
||||
npx -p <pkg>[@<specifier>] -c '<cmd> [args...]'
|
||||
Run without --call or positional args to open interactive subshell
|
||||
|
||||
alias: npm x, npx
|
||||
|
||||
common options:
|
||||
--package=<pkg> (may be specified multiple times)
|
||||
-p is a shorthand for --package only when using npx executable
|
||||
-c <cmd> --call=<cmd> (may not be mixed with positional arguments)
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command allows you to run an arbitrary command from an npm package
|
||||
(either one installed locally, or fetched remotely), in a similar context
|
||||
as running it via `npm run`.
|
||||
|
||||
Run without positional arguments or `--call`, this allows you to
|
||||
interactively run commands in the same sort of shell environment that
|
||||
`package.json` scripts are run. Interactive mode is not supported in CI
|
||||
environments when standard input is a TTY, to prevent hangs.
|
||||
|
||||
Whatever packages are specified by the `--package` option will be
|
||||
provided in the `PATH` of the executed command, along with any locally
|
||||
installed package executables. The `--package` option may be
|
||||
specified multiple times, to execute the supplied command in an environment
|
||||
where all specified packages are available.
|
||||
|
||||
If any requested packages are not present in the local project
|
||||
dependencies, then they are installed to a folder in the npm cache, which
|
||||
is added to the `PATH` environment variable in the executed process. A
|
||||
prompt is printed (which can be suppressed by providing either `--yes` or
|
||||
`--no`).
|
||||
|
||||
Package names provided without a specifier will be matched with whatever
|
||||
version exists in the local project. Package names with a specifier will
|
||||
only be considered a match if they have the exact same name and version as
|
||||
the local dependency.
|
||||
|
||||
If no `-c` or `--call` option is provided, then the positional arguments
|
||||
are used to generate the command string. If no `--package` options
|
||||
are provided, then npm will attempt to determine the executable name from
|
||||
the package specifier provided as the first positional argument according
|
||||
to the following heuristic:
|
||||
|
||||
- If the package has a single entry in its `bin` field in `package.json`,
|
||||
or if all entries are aliases of the same command, then that command
|
||||
will be used.
|
||||
- If the package has multiple `bin` entries, and one of them matches the
|
||||
unscoped portion of the `name` field, then that command will be used.
|
||||
- If this does not result in exactly one option (either because there are
|
||||
no bin entries, or none of them match the `name` of the package), then
|
||||
`npm exec` exits with an error.
|
||||
|
||||
To run a binary _other than_ the named binary, specify one or more
|
||||
`--package` options, which will prevent npm from inferring the package from
|
||||
the first command argument.
|
||||
|
||||
### `npx` vs `npm exec`
|
||||
|
||||
When run via the `npx` binary, all flags and options *must* be set prior to
|
||||
any positional arguments. When run via `npm exec`, a double-hyphen `--`
|
||||
flag can be used to suppress npm's parsing of switches and options that
|
||||
should be sent to the executed command.
|
||||
|
||||
For example:
|
||||
|
||||
```
|
||||
$ npx foo@latest bar --package=@npmcli/foo
|
||||
```
|
||||
|
||||
In this case, npm will resolve the `foo` package name, and run the
|
||||
following command:
|
||||
|
||||
```
|
||||
$ foo bar --package=@npmcli/foo
|
||||
```
|
||||
|
||||
Since the `--package` option comes _after_ the positional arguments, it is
|
||||
treated as an argument to the executed command.
|
||||
|
||||
In contrast, due to npm's argument parsing logic, running this command is
|
||||
different:
|
||||
|
||||
```
|
||||
$ npm exec foo@latest bar --package=@npmcli/foo
|
||||
```
|
||||
|
||||
In this case, npm will parse the `--package` option first, resolving the
|
||||
`@npmcli/foo` package. Then, it will execute the following command in that
|
||||
context:
|
||||
|
||||
```
|
||||
$ foo@latest bar
|
||||
```
|
||||
|
||||
The double-hyphen character is recommended to explicitly tell npm to stop
|
||||
parsing command line options and switches. The following command would
|
||||
thus be equivalent to the `npx` command above:
|
||||
|
||||
```
|
||||
$ npm exec -- foo@latest bar --package=@npmcli/foo
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `package`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
The package to install for [`npm exec`](/commands/npm-exec)
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `call`
|
||||
|
||||
* Default: ""
|
||||
* Type: String
|
||||
|
||||
Optional companion option for `npm exec`, `npx` that allows for specifying a
|
||||
custom command to be run along with the installed packages.
|
||||
|
||||
```bash
|
||||
npm exec --package yo --package generator-node --call "yo node"
|
||||
```
|
||||
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### Examples
|
||||
|
||||
Run the version of `tap` in the local dependencies, with the provided
|
||||
arguments:
|
||||
|
||||
```
|
||||
$ npm exec -- tap --bail test/foo.js
|
||||
$ npx tap --bail test/foo.js
|
||||
```
|
||||
|
||||
Run a command _other than_ the command whose name matches the package name
|
||||
by specifying a `--package` option:
|
||||
|
||||
```
|
||||
$ npm exec --package=foo -- bar --bar-argument
|
||||
# ~ or ~
|
||||
$ npx --package=foo bar --bar-argument
|
||||
```
|
||||
|
||||
Run an arbitrary shell script, in the context of the current project:
|
||||
|
||||
```
|
||||
$ npm x -c 'eslint && say "hooray, lint passed"'
|
||||
$ npx -c 'eslint && say "hooray, lint passed"'
|
||||
```
|
||||
|
||||
### Workspaces support
|
||||
|
||||
You may use the `workspace` or `workspaces` configs in order to run an
|
||||
arbitrary command from an npm package (either one installed locally, or fetched
|
||||
remotely) in the context of the specified workspaces.
|
||||
If no positional argument or `--call` option is provided, it will open an
|
||||
interactive subshell in the context of each of these configured workspaces one
|
||||
at a time.
|
||||
|
||||
Given a project with configured workspaces, e.g:
|
||||
|
||||
```
|
||||
.
|
||||
+-- package.json
|
||||
`-- packages
|
||||
+-- a
|
||||
| `-- package.json
|
||||
+-- b
|
||||
| `-- package.json
|
||||
`-- c
|
||||
`-- package.json
|
||||
```
|
||||
|
||||
Assuming the workspace configuration is properly set up at the root level
|
||||
`package.json` file. e.g:
|
||||
|
||||
```
|
||||
{
|
||||
"workspaces": [ "./packages/*" ]
|
||||
}
|
||||
```
|
||||
|
||||
You can execute an arbitrary command from a package in the context of each of
|
||||
the configured workspaces when using the `workspaces` configuration options,
|
||||
in this example we're using **eslint** to lint any js file found within each
|
||||
workspace folder:
|
||||
|
||||
```
|
||||
npm exec --ws -- eslint ./*.js
|
||||
```
|
||||
|
||||
#### Filtering workspaces
|
||||
|
||||
It's also possible to execute a command in a single workspace using the
|
||||
`workspace` config along with a name or directory path:
|
||||
|
||||
```
|
||||
npm exec --workspace=a -- eslint ./*.js
|
||||
```
|
||||
|
||||
The `workspace` config can also be specified multiple times in order to run a
|
||||
specific script in the context of multiple workspaces. When defining values for
|
||||
the `workspace` config in the command line, it also possible to use `-w` as a
|
||||
shorthand, e.g:
|
||||
|
||||
```
|
||||
npm exec -w a -w b -- eslint ./*.js
|
||||
```
|
||||
|
||||
This last command will run the `eslint` command in both `./packages/a` and
|
||||
`./packages/b` folders.
|
||||
|
||||
### Compatibility with Older npx Versions
|
||||
|
||||
The `npx` binary was rewritten in npm v7.0.0, and the standalone `npx`
|
||||
package deprecated at that time. `npx` uses the `npm exec`
|
||||
command instead of a separate argument parser and install process, with
|
||||
some affordances to maintain backwards compatibility with the arguments it
|
||||
accepted in previous versions.
|
||||
|
||||
This resulted in some shifts in its functionality:
|
||||
|
||||
- Any `npm` config value may be provided.
|
||||
- To prevent security and user-experience problems from mistyping package
|
||||
names, `npx` prompts before installing anything. Suppress this
|
||||
prompt with the `-y` or `--yes` option.
|
||||
- The `--no-install` option is deprecated, and will be converted to `--no`.
|
||||
- Shell fallback functionality is removed, as it is not advisable.
|
||||
- The `-p` argument is a shorthand for `--parseable` in npm, but shorthand
|
||||
for `--package` in npx. This is maintained, but only for the `npx`
|
||||
executable.
|
||||
- The `--ignore-existing` option is removed. Locally installed bins are
|
||||
always present in the executed process `PATH`.
|
||||
- The `--npm` option is removed. `npx` will always use the `npm` it ships
|
||||
with.
|
||||
- The `--node-arg` and `-n` options are removed.
|
||||
- The `--always-spawn` option is redundant, and thus removed.
|
||||
- The `--shell` option is replaced with `--script-shell`, but maintained
|
||||
in the `npx` executable for backwards compatibility.
|
||||
|
||||
### A note on caching
|
||||
|
||||
The npm cli utilizes its internal package cache when using the package
|
||||
name specified. You can use the following to change how and when the
|
||||
cli uses this cache. See [`npm cache`](/commands/npm-cache) for more on
|
||||
how the cache works.
|
||||
|
||||
#### prefer-online
|
||||
|
||||
Forces staleness checks for packages, making the cli look for updates
|
||||
immediately even if the package is already in the cache.
|
||||
|
||||
#### prefer-offline
|
||||
|
||||
Bypasses staleness checks for packages. Missing data will still be
|
||||
requested from the server. To force full offline mode, use `offline`.
|
||||
|
||||
#### offline
|
||||
|
||||
Forces full offline mode. Any packages not locally cached will result in
|
||||
an error.
|
||||
|
||||
#### workspace
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result to selecting all of the
|
||||
nested workspaces)
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
#### workspaces
|
||||
|
||||
* Alias: `--ws`
|
||||
* Type: Boolean
|
||||
* Default: `false`
|
||||
|
||||
Run scripts in the context of all configured workspaces for the current
|
||||
project.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm run-script](/commands/npm-run-script)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [npm test](/commands/npm-test)
|
||||
* [npm start](/commands/npm-start)
|
||||
* [npm restart](/commands/npm-restart)
|
||||
* [npm stop](/commands/npm-stop)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npm workspaces](/using-npm/workspaces)
|
112
node/lib/node_modules/npm/docs/content/commands/npm-explain.md
generated
vendored
Normal file
112
node/lib/node_modules/npm/docs/content/commands/npm-explain.md
generated
vendored
Normal file
|
@ -0,0 +1,112 @@
|
|||
---
|
||||
title: npm-explain
|
||||
section: 1
|
||||
description: Explain installed packages
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm explain <folder | specifier>
|
||||
|
||||
alias: why
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command will print the chain of dependencies causing a given package
|
||||
to be installed in the current project.
|
||||
|
||||
Positional arguments can be either folders within `node_modules`, or
|
||||
`name@version-range` specifiers, which will select the dependency
|
||||
relationships to explain.
|
||||
|
||||
For example, running `npm explain glob` within npm's source tree will show:
|
||||
|
||||
```bash
|
||||
glob@7.1.6
|
||||
node_modules/glob
|
||||
glob@"^7.1.4" from the root project
|
||||
|
||||
glob@7.1.1 dev
|
||||
node_modules/tacks/node_modules/glob
|
||||
glob@"^7.0.5" from rimraf@2.6.2
|
||||
node_modules/tacks/node_modules/rimraf
|
||||
rimraf@"^2.6.2" from tacks@1.3.0
|
||||
node_modules/tacks
|
||||
dev tacks@"^1.3.0" from the root project
|
||||
```
|
||||
|
||||
To explain just the package residing at a specific folder, pass that as the
|
||||
argument to the command. This can be useful when trying to figure out
|
||||
exactly why a given dependency is being duplicated to satisfy conflicting
|
||||
version requirements within the project.
|
||||
|
||||
```bash
|
||||
$ npm explain node_modules/nyc/node_modules/find-up
|
||||
find-up@3.0.0 dev
|
||||
node_modules/nyc/node_modules/find-up
|
||||
find-up@"^3.0.0" from nyc@14.1.1
|
||||
node_modules/nyc
|
||||
nyc@"^14.1.1" from tap@14.10.8
|
||||
node_modules/tap
|
||||
dev tap@"^14.10.8" from the root project
|
||||
```
|
||||
|
||||
### Configuration
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
* In `npm pkg set` it enables parsing set values with JSON.parse() before
|
||||
saving them to your `package.json`.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm ls](/commands/npm-ls)
|
||||
* [npm install](/commands/npm-install)
|
||||
* [npm link](/commands/npm-link)
|
||||
* [npm prune](/commands/npm-prune)
|
||||
* [npm outdated](/commands/npm-outdated)
|
||||
* [npm update](/commands/npm-update)
|
55
node/lib/node_modules/npm/docs/content/commands/npm-explore.md
generated
vendored
Normal file
55
node/lib/node_modules/npm/docs/content/commands/npm-explore.md
generated
vendored
Normal file
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
title: npm-explore
|
||||
section: 1
|
||||
description: Browse an installed package
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm explore <pkg> [ -- <command>]
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### 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.
|
||||
|
||||
This is particularly handy in the case of git submodules in the
|
||||
`node_modules` folder:
|
||||
|
||||
```bash
|
||||
npm explore some-dependency -- git pull origin master
|
||||
```
|
||||
|
||||
Note that the package is *not* automatically rebuilt afterwards, so be
|
||||
sure to use `npm rebuild <pkg>` if you make any changes.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `shell`
|
||||
|
||||
* Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on
|
||||
Windows
|
||||
* Type: String
|
||||
|
||||
The shell to run for the `npm explore` command.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm edit](/commands/npm-edit)
|
||||
* [npm rebuild](/commands/npm-rebuild)
|
||||
* [npm install](/commands/npm-install)
|
232
node/lib/node_modules/npm/docs/content/commands/npm-find-dupes.md
generated
vendored
Normal file
232
node/lib/node_modules/npm/docs/content/commands/npm-find-dupes.md
generated
vendored
Normal file
|
@ -0,0 +1,232 @@
|
|||
---
|
||||
title: npm-find-dupes
|
||||
section: 1
|
||||
description: Find duplication in the package tree
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm find-dupes
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Runs `npm dedupe` in `--dry-run` mode, making npm only output the
|
||||
duplications, without actually changing the package tree.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Causes npm to install the package into your local `node_modules` folder with
|
||||
the same layout it uses with the global `node_modules` folder. Only your
|
||||
direct dependencies will show in `node_modules` and everything they depend
|
||||
on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Causes npm to install the package such that versions of npm prior to 1.4,
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If set to `true`, and `--legacy-peer-deps` is not set, then _any_
|
||||
conflicting `peerDependencies` will be treated as an install failure, even
|
||||
if npm could reasonably guess the appropriate resolution based on non-peer
|
||||
dependency relationships.
|
||||
|
||||
By default, conflicting `peerDependencies` deep in the dependency graph will
|
||||
be resolved using the nearest non-peer dependency specification, even if
|
||||
doing so will result in some packages receiving a peer dependency outside
|
||||
the range set in their package's `peerDependencies` object.
|
||||
|
||||
When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
If set to false, then ignore `package-lock.json` files when installing. This
|
||||
will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
When package package-locks are disabled, automatic pruning of extraneous
|
||||
modules will also be disabled. To remove extraneous modules with
|
||||
package-locks disabled use `npm prune`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
'production', otherwise empty.
|
||||
* Type: "dev", "optional", or "peer" (can be set multiple times)
|
||||
|
||||
Dependency types to omit from the installation tree on disk.
|
||||
|
||||
Note that these dependencies _are_ still resolved and added to the
|
||||
`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
|
||||
physically installed on disk.
|
||||
|
||||
If a package type appears in both the `--include` and `--omit` lists, then
|
||||
it will be included.
|
||||
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If true, npm does not run scripts specified in package.json files.
|
||||
|
||||
Note that commands explicitly intended to run a particular script, such as
|
||||
`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" submit audit reports alongside the current npm command to the
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
Tells npm to create symlinks (or `.cmd` shims on Windows) for package
|
||||
executables.
|
||||
|
||||
Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm dedupe](/commands/npm-dedupe)
|
||||
* [npm ls](/commands/npm-ls)
|
||||
* [npm update](/commands/npm-update)
|
||||
* [npm install](/commands/npm-install)
|
||||
|
155
node/lib/node_modules/npm/docs/content/commands/npm-fund.md
generated
vendored
Normal file
155
node/lib/node_modules/npm/docs/content/commands/npm-fund.md
generated
vendored
Normal file
|
@ -0,0 +1,155 @@
|
|||
---
|
||||
title: npm-fund
|
||||
section: 1
|
||||
description: Retrieve funding information
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm fund [<pkg>]
|
||||
npm fund [-w <workspace-name>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command retrieves information on how to fund the dependencies of a
|
||||
given project. If no package name is provided, it will list all
|
||||
dependencies that are looking for funding in a tree structure, listing the
|
||||
type of funding and the url to visit. If a package name is provided then it
|
||||
tries to open its funding url using the `--browser` config param; if there
|
||||
are multiple funding sources for the package, the user will be instructed
|
||||
to pass the `--which` option to disambiguate.
|
||||
|
||||
The list will avoid duplicated entries and will stack all packages that
|
||||
share the same url as a single entry. Thus, the list does not have the same
|
||||
shape of the output from `npm ls`.
|
||||
|
||||
#### Example
|
||||
|
||||
### Workspaces support
|
||||
|
||||
It's possible to filter the results to only include a single workspace and its
|
||||
dependencies using the `workspace` config option.
|
||||
|
||||
#### Example:
|
||||
|
||||
Here's an example running `npm fund` in a project with a configured
|
||||
workspace `a`:
|
||||
|
||||
```bash
|
||||
$ npm fund
|
||||
test-workspaces-fund@1.0.0
|
||||
+-- https://example.com/a
|
||||
| | `-- a@1.0.0
|
||||
| `-- https://example.com/maintainer
|
||||
| `-- foo@1.0.0
|
||||
+-- https://example.com/npmcli-funding
|
||||
| `-- @npmcli/test-funding
|
||||
`-- https://example.com/org
|
||||
`-- bar@2.0.0
|
||||
```
|
||||
|
||||
And here is an example of the expected result when filtering only by
|
||||
a specific workspace `a` in the same project:
|
||||
|
||||
```bash
|
||||
$ npm fund -w a
|
||||
test-workspaces-fund@1.0.0
|
||||
`-- https://example.com/a
|
||||
| `-- a@1.0.0
|
||||
`-- https://example.com/maintainer
|
||||
`-- foo@2.0.0
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
* In `npm pkg set` it enables parsing set values with JSON.parse() before
|
||||
saving them to your `package.json`.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `browser`
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
* Type: null, Boolean, or String
|
||||
|
||||
The browser that is called by npm commands to open websites.
|
||||
|
||||
Set to `false` to suppress browser behavior and instead print urls to
|
||||
terminal.
|
||||
|
||||
Set to `true` to use default system URL opener.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `unicode`
|
||||
|
||||
* Default: false on windows, true on mac/unix systems with a unicode locale,
|
||||
as defined by the `LC_ALL`, `LC_CTYPE`, or `LANG` environment variables.
|
||||
* Type: Boolean
|
||||
|
||||
When set to true, npm uses unicode characters in the tree output. When
|
||||
false, it uses ascii characters instead of unicode glyphs.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `which`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Number
|
||||
|
||||
If there are multiple funding sources, which 1-indexed source URL to open.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
## See Also
|
||||
|
||||
* [npm install](/commands/npm-install)
|
||||
* [npm docs](/commands/npm-docs)
|
||||
* [npm ls](/commands/npm-ls)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npm workspaces](/using-npm/workspaces)
|
46
node/lib/node_modules/npm/docs/content/commands/npm-help-search.md
generated
vendored
Normal file
46
node/lib/node_modules/npm/docs/content/commands/npm-help-search.md
generated
vendored
Normal file
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: npm-help-search
|
||||
section: 1
|
||||
description: Search npm help documentation
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm help-search <text>
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
This command will search the npm markdown documentation files for the terms
|
||||
provided, and then list the results, sorted by relevance.
|
||||
|
||||
If only one result is found, then it will show that help topic.
|
||||
|
||||
If the argument to `npm help` is not a known help topic, then it will call
|
||||
`help-search`. It is rarely if ever necessary to call this command
|
||||
directly.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `long`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show extended information in `ls`, `search`, and `help-search`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm](/commands/npm)
|
||||
* [npm help](/commands/npm-help)
|
50
node/lib/node_modules/npm/docs/content/commands/npm-help.md
generated
vendored
Normal file
50
node/lib/node_modules/npm/docs/content/commands/npm-help.md
generated
vendored
Normal file
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: npm-help
|
||||
section: 1
|
||||
description: Get help on npm
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm help <term> [<terms..>]
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
If supplied a topic, then show the appropriate documentation page.
|
||||
|
||||
If the topic does not exist, or if multiple terms are provided, then npm
|
||||
will run the `help-search` command to find a match. Note that, if
|
||||
`help-search` finds a single subject, then it will run `help` on that
|
||||
topic, so unique matches are equivalent to specifying a topic name.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `viewer`
|
||||
|
||||
* Default: "man" on Posix, "browser" on Windows
|
||||
* Type: String
|
||||
|
||||
The program to use to view help content.
|
||||
|
||||
Set to `"browser"` to view html help content in the default web browser.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm](/commands/npm)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
* [npm help-search](/commands/npm-help-search)
|
119
node/lib/node_modules/npm/docs/content/commands/npm-hook.md
generated
vendored
Normal file
119
node/lib/node_modules/npm/docs/content/commands/npm-hook.md
generated
vendored
Normal file
|
@ -0,0 +1,119 @@
|
|||
---
|
||||
title: npm-hook
|
||||
section: 1
|
||||
description: Manage registry hooks
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm hook ls [pkg]
|
||||
npm hook add <entity> <url> <secret>
|
||||
npm hook update <id> <url> [secret]
|
||||
npm hook rm <id>
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
Allows you to manage [npm
|
||||
hooks](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm),
|
||||
including adding, removing, listing, and updating.
|
||||
|
||||
Hooks allow you to configure URL endpoints that will be notified whenever a
|
||||
change happens to any of the supported entity types. Three different types
|
||||
of entities can be watched by hooks: packages, owners, and scopes.
|
||||
|
||||
To create a package hook, simply reference the package name.
|
||||
|
||||
To create an owner hook, prefix the owner name with `~` (as in,
|
||||
`~youruser`).
|
||||
|
||||
To create a scope hook, prefix the scope name with `@` (as in,
|
||||
`@yourscope`).
|
||||
|
||||
The hook `id` used by `update` and `rm` are the IDs listed in `npm hook ls`
|
||||
for that particular hook.
|
||||
|
||||
The shared secret will be sent along to the URL endpoint so you can verify
|
||||
the request came from your own configured hook.
|
||||
|
||||
### Example
|
||||
|
||||
Add a hook to watch a package for changes:
|
||||
|
||||
```bash
|
||||
$ npm hook add lodash https://example.com/ my-shared-secret
|
||||
```
|
||||
|
||||
Add a hook to watch packages belonging to the user `substack`:
|
||||
|
||||
```bash
|
||||
$ npm hook add ~substack https://example.com/ my-shared-secret
|
||||
```
|
||||
|
||||
Add a hook to watch packages in the scope `@npm`
|
||||
|
||||
```bash
|
||||
$ npm hook add @npm https://example.com/ my-shared-secret
|
||||
```
|
||||
|
||||
List all your active hooks:
|
||||
|
||||
```bash
|
||||
$ npm hook ls
|
||||
```
|
||||
|
||||
List your active hooks for the `lodash` package:
|
||||
|
||||
```bash
|
||||
$ npm hook ls lodash
|
||||
```
|
||||
|
||||
Update an existing hook's url:
|
||||
|
||||
```bash
|
||||
$ npm hook update id-deadbeef https://my-new-website.here/
|
||||
```
|
||||
|
||||
Remove a hook:
|
||||
|
||||
```bash
|
||||
$ npm hook rm id-deadbeef
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
* Type: URL
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
* Type: null or String
|
||||
|
||||
This is a one-time password from a two-factor authenticator. It's needed
|
||||
when publishing or changing package permissions with `npm access`.
|
||||
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* ["Introducing Hooks" blog post](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm)
|
259
node/lib/node_modules/npm/docs/content/commands/npm-init.md
generated
vendored
Normal file
259
node/lib/node_modules/npm/docs/content/commands/npm-init.md
generated
vendored
Normal file
|
@ -0,0 +1,259 @@
|
|||
---
|
||||
title: npm-init
|
||||
section: 1
|
||||
description: Create a package.json file
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm init [--yes|-y|--scope]
|
||||
npm init <@scope> (same as `npm exec <@scope>/create`)
|
||||
npm init [<@scope>/]<name> (same as `npm exec [<@scope>/]create-<name>`)
|
||||
npm init [-w <dir>] [args...]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
`npm init <initializer>` can be used to set up a new or existing npm
|
||||
package.
|
||||
|
||||
`initializer` in this case is an npm package named `create-<initializer>`,
|
||||
which will be installed by [`npm-exec`](/commands/npm-exec), and then have its
|
||||
main bin executed -- presumably creating or updating `package.json` and
|
||||
running any other initialization-related operations.
|
||||
|
||||
The init command is transformed to a corresponding `npm exec` operation as
|
||||
follows:
|
||||
|
||||
* `npm init foo` -> `npm exec create-foo`
|
||||
* `npm init @usr/foo` -> `npm exec @usr/create-foo`
|
||||
* `npm init @usr` -> `npm exec @usr/create`
|
||||
|
||||
If the initializer is omitted (by just calling `npm init`), init will fall
|
||||
back to legacy init behavior. It will ask you a bunch of questions, and
|
||||
then write a package.json for you. It will attempt to make reasonable
|
||||
guesses based on existing fields, dependencies, and options selected. It is
|
||||
strictly additive, so it will keep any fields and values that were already
|
||||
set. You can also use `-y`/`--yes` to skip the questionnaire altogether. If
|
||||
you pass `--scope`, it will create a scoped package.
|
||||
|
||||
#### Forwarding additional options
|
||||
|
||||
Any additional options will be passed directly to the command, so `npm init
|
||||
foo -- --hello` will map to `npm exec -- create-foo --hello`.
|
||||
|
||||
To better illustrate how options are forwarded, here's a more evolved
|
||||
example showing options passed to both the **npm cli** and a create package,
|
||||
both following commands are equivalent:
|
||||
|
||||
- `npm init foo -y --registry=<url> -- --hello -a`
|
||||
- `npm exec -y --registry=<url> -- create-foo --hello -a`
|
||||
|
||||
### Examples
|
||||
|
||||
Create a new React-based project using
|
||||
[`create-react-app`](https://npm.im/create-react-app):
|
||||
|
||||
```bash
|
||||
$ npm init react-app ./my-react-app
|
||||
```
|
||||
|
||||
Create a new `esm`-compatible package using
|
||||
[`create-esm`](https://npm.im/create-esm):
|
||||
|
||||
```bash
|
||||
$ mkdir my-esm-lib && cd my-esm-lib
|
||||
$ npm init esm --yes
|
||||
```
|
||||
|
||||
Generate a plain old package.json using legacy init:
|
||||
|
||||
```bash
|
||||
$ mkdir my-npm-pkg && cd my-npm-pkg
|
||||
$ git init
|
||||
$ npm init
|
||||
```
|
||||
|
||||
Generate it without having it ask any questions:
|
||||
|
||||
```bash
|
||||
$ npm init -y
|
||||
```
|
||||
|
||||
### Workspaces support
|
||||
|
||||
It's possible to create a new workspace within your project by using the
|
||||
`workspace` config option. When using `npm init -w <dir>` the cli will
|
||||
create the folders and boilerplate expected while also adding a reference
|
||||
to your project `package.json` `"workspaces": []` property in order to make
|
||||
sure that new generated **workspace** is properly set up as such.
|
||||
|
||||
Given a project with no workspaces, e.g:
|
||||
|
||||
```
|
||||
.
|
||||
+-- package.json
|
||||
```
|
||||
|
||||
You may generate a new workspace using the legacy init:
|
||||
|
||||
```bash
|
||||
$ npm init -w packages/a
|
||||
```
|
||||
|
||||
That will generate a new folder and `package.json` file, while also updating
|
||||
your top-level `package.json` to add the reference to this new workspace:
|
||||
|
||||
```
|
||||
.
|
||||
+-- package.json
|
||||
`-- packages
|
||||
`-- a
|
||||
`-- package.json
|
||||
```
|
||||
|
||||
The workspaces init also supports the `npm init <initializer> -w <dir>`
|
||||
syntax, following the same set of rules explained earlier in the initial
|
||||
**Description** section of this page. Similar to the previous example of
|
||||
creating a new React-based project using
|
||||
[`create-react-app`](https://npm.im/create-react-app), the following syntax
|
||||
will make sure to create the new react app as a nested **workspace** within your
|
||||
project and configure your `package.json` to recognize it as such:
|
||||
|
||||
```bash
|
||||
npm init -w packages/my-react-app react-app .
|
||||
```
|
||||
|
||||
This will make sure to generate your react app as expected, one important
|
||||
consideration to have in mind is that `npm exec` is going to be run in the
|
||||
context of the newly created folder for that workspace, and that's the reason
|
||||
why in this example the initializer uses the initializer name followed with a
|
||||
dot to represent the current directory in that context, e.g: `react-app .`:
|
||||
|
||||
```
|
||||
.
|
||||
+-- package.json
|
||||
`-- packages
|
||||
+-- a
|
||||
| `-- package.json
|
||||
`-- my-react-app
|
||||
+-- README
|
||||
+-- package.json
|
||||
`-- ...
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `yes`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Automatically answer "yes" to any prompts that npm might print on the
|
||||
command line.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `force`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Removes various protections against unfortunate side effects, common
|
||||
mistakes, unnecessary performance degradation, and malicious input.
|
||||
|
||||
* Allow clobbering non-npm files in global installs.
|
||||
* Allow the `npm version` command to work on an unclean git repository.
|
||||
* Allow deleting the cache folder with `npm cache clean`.
|
||||
* Allow installing packages that have an `engines` declaration requiring a
|
||||
different version of npm.
|
||||
* Allow installing packages that have an `engines` declaration requiring a
|
||||
different version of `node`, even if `--engine-strict` is enabled.
|
||||
* Allow `npm audit fix` to install modules outside your stated dependency
|
||||
range (including SemVer-major changes).
|
||||
* Allow unpublishing all versions of a published package.
|
||||
* Allow conflicting peerDependencies to be installed in the root project.
|
||||
* Implicitly set `--yes` during `npm init`.
|
||||
* Allow clobbering existing values in `npm pkg`
|
||||
|
||||
If you don't have a clear idea of what you want to do, it is strongly
|
||||
recommended that you do not use this option!
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [init-package-json module](http://npm.im/init-package-json)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
* [npm version](/commands/npm-version)
|
||||
* [npm scope](/using-npm/scope)
|
||||
* [npm exec](/commands/npm-exec)
|
||||
* [npm workspaces](/using-npm/workspaces)
|
69
node/lib/node_modules/npm/docs/content/commands/npm-install-ci-test.md
generated
vendored
Normal file
69
node/lib/node_modules/npm/docs/content/commands/npm-install-ci-test.md
generated
vendored
Normal file
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
title: npm-install-ci-test
|
||||
section: 1
|
||||
description: Install a project with a clean slate and run tests
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm install-ci-test
|
||||
|
||||
alias: npm cit
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command runs `npm ci` followed immediately by `npm test`.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" submit audit reports alongside the current npm command to the
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If true, npm does not run scripts specified in package.json files.
|
||||
|
||||
Note that commands explicitly intended to run a particular script, such as
|
||||
`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `script-shell`
|
||||
|
||||
* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
|
||||
* Type: null or String
|
||||
|
||||
The shell to use for scripts run with the `npm exec`, `npm run` and `npm
|
||||
init <pkg>` commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install-test](/commands/npm-install-test)
|
||||
* [npm ci](/commands/npm-ci)
|
||||
* [npm test](/commands/npm-test)
|
297
node/lib/node_modules/npm/docs/content/commands/npm-install-test.md
generated
vendored
Normal file
297
node/lib/node_modules/npm/docs/content/commands/npm-install-test.md
generated
vendored
Normal file
|
@ -0,0 +1,297 @@
|
|||
---
|
||||
title: npm-install-test
|
||||
section: 1
|
||||
description: Install package(s) and run tests
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm install-test (with no args, in package dir)
|
||||
npm install-test [<@scope>/]<name>
|
||||
npm install-test [<@scope>/]<name>@<tag>
|
||||
npm install-test [<@scope>/]<name>@<version>
|
||||
npm install-test [<@scope>/]<name>@<version range>
|
||||
npm install-test <tarball file>
|
||||
npm install-test <tarball url>
|
||||
npm install-test <folder>
|
||||
|
||||
alias: npm it
|
||||
common options: [--save|--save-dev|--save-optional] [--save-exact] [--dry-run]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command runs an `npm install` followed immediately by an `npm test`. It
|
||||
takes exactly the same arguments as `npm install`.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `save`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
Save installed packages to a package.json file as dependencies.
|
||||
|
||||
When used with the `npm rm` command, removes the dependency from
|
||||
package.json.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `save-exact`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Operates in "global" mode, so that packages are installed into the `prefix`
|
||||
folder instead of the current working directory. See
|
||||
[folders](/configuring-npm/folders) for more on the differences in behavior.
|
||||
|
||||
* packages are installed into the `{prefix}/lib/node_modules` folder, instead
|
||||
of the current working directory.
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Causes npm to install the package into your local `node_modules` folder with
|
||||
the same layout it uses with the global `node_modules` folder. Only your
|
||||
direct dependencies will show in `node_modules` and everything they depend
|
||||
on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Causes npm to install the package such that versions of npm prior to 1.4,
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If set to `true`, and `--legacy-peer-deps` is not set, then _any_
|
||||
conflicting `peerDependencies` will be treated as an install failure, even
|
||||
if npm could reasonably guess the appropriate resolution based on non-peer
|
||||
dependency relationships.
|
||||
|
||||
By default, conflicting `peerDependencies` deep in the dependency graph will
|
||||
be resolved using the nearest non-peer dependency specification, even if
|
||||
doing so will result in some packages receiving a peer dependency outside
|
||||
the range set in their package's `peerDependencies` object.
|
||||
|
||||
When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
If set to false, then ignore `package-lock.json` files when installing. This
|
||||
will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
When package package-locks are disabled, automatic pruning of extraneous
|
||||
modules will also be disabled. To remove extraneous modules with
|
||||
package-locks disabled use `npm prune`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
'production', otherwise empty.
|
||||
* Type: "dev", "optional", or "peer" (can be set multiple times)
|
||||
|
||||
Dependency types to omit from the installation tree on disk.
|
||||
|
||||
Note that these dependencies _are_ still resolved and added to the
|
||||
`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
|
||||
physically installed on disk.
|
||||
|
||||
If a package type appears in both the `--include` and `--omit` lists, then
|
||||
it will be included.
|
||||
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If true, npm does not run scripts specified in package.json files.
|
||||
|
||||
Note that commands explicitly intended to run a particular script, such as
|
||||
`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" submit audit reports alongside the current npm command to the
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
Tells npm to create symlinks (or `.cmd` shims on Windows) for package
|
||||
executables.
|
||||
|
||||
Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
* 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`, as well as `pack` and `publish`.
|
||||
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/commands/npm-install)
|
||||
* [npm install-ci-test](/commands/npm-install-ci-test)
|
||||
* [npm test](/commands/npm-test)
|
727
node/lib/node_modules/npm/docs/content/commands/npm-install.md
generated
vendored
Normal file
727
node/lib/node_modules/npm/docs/content/commands/npm-install.md
generated
vendored
Normal file
|
@ -0,0 +1,727 @@
|
|||
---
|
||||
title: npm-install
|
||||
section: 1
|
||||
description: Install a package
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
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 <alias>@npm:<name>
|
||||
npm install <git-host>:<git-user>/<repo-name>
|
||||
npm install <git repo url>
|
||||
npm install <tarball file>
|
||||
npm install <tarball url>
|
||||
npm install <folder>
|
||||
|
||||
aliases: npm i, npm add
|
||||
common options: [-P|--save-prod|-D|--save-dev|-O|--save-optional|--save-peer] [-E|--save-exact] [-B|--save-bundle] [--no-save] [--dry-run]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command installs a package and any packages that it depends on. If the
|
||||
package has a package-lock, or an npm shrinkwrap file, or a yarn lock file,
|
||||
the installation of dependencies will be driven by that, respecting the
|
||||
following order of precedence:
|
||||
|
||||
* `npm-shrinkwrap.json`
|
||||
* `package-lock.json`
|
||||
* `yarn.lock`
|
||||
|
||||
See [package-lock.json](/configuring-npm/package-lock-json) and
|
||||
[`npm shrinkwrap`](/commands/npm-shrinkwrap).
|
||||
|
||||
A `package` is:
|
||||
|
||||
* a) a folder containing a program described by a
|
||||
[`package.json`](/configuring-npm/package-json) file
|
||||
* b) a gzipped tarball containing (a)
|
||||
* c) a url that resolves to (b)
|
||||
* d) a `<name>@<version>` that is published on the registry (see
|
||||
[`registry`](/using-npm/registry)) with (c)
|
||||
* e) a `<name>@<tag>` (see [`npm dist-tag`](/commands/npm-dist-tag)) that
|
||||
points to (d)
|
||||
* f) a `<name>` that has a "latest" tag satisfying (e)
|
||||
* g) a `<git remote url>` that resolves to (a)
|
||||
|
||||
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 perhaps if
|
||||
you also want to be able to easily install it elsewhere after packing it up
|
||||
into a tarball (b).
|
||||
|
||||
|
||||
* `npm install` (in a package directory, no arguments):
|
||||
|
||||
Install the dependencies in the local `node_modules` folder.
|
||||
|
||||
In global mode (ie, with `-g` or `--global` appended to the command),
|
||||
it installs the current package context (ie, the current working
|
||||
directory) as a global package.
|
||||
|
||||
By default, `npm install` will install all modules listed as
|
||||
dependencies in [`package.json`](/configuring-npm/package-json).
|
||||
|
||||
With the `--production` flag (or when the `NODE_ENV` environment
|
||||
variable is set to `production`), npm will not install modules listed
|
||||
in `devDependencies`. To install all modules listed in both
|
||||
`dependencies` and `devDependencies` when `NODE_ENV` environment
|
||||
variable is set to `production`, you can use `--production=false`.
|
||||
|
||||
> NOTE: The `--production` flag has no particular meaning when adding a
|
||||
dependency to a project.
|
||||
|
||||
* `npm install <folder>`:
|
||||
|
||||
Install the package in the directory as a symlink in the current
|
||||
project. Its dependencies will be installed before it's linked. If
|
||||
`<folder>` sits inside the root of your project, its dependencies may
|
||||
be hoisted to the top-level `node_modules` as they would for other
|
||||
types of dependencies.
|
||||
|
||||
* `npm install <tarball file>`:
|
||||
|
||||
Install a package that is sitting on the filesystem. Note: if you just
|
||||
want to link a dev directory into your npm root, you can do this more
|
||||
easily by using [`npm link`](/commands/npm-link).
|
||||
|
||||
Tarball requirements:
|
||||
* The filename *must* use `.tar`, `.tar.gz`, or `.tgz` as the
|
||||
extension.
|
||||
* The package contents should reside in a subfolder inside the tarball
|
||||
(usually it is called `package/`). npm strips one directory layer
|
||||
when installing the package (an equivalent of `tar x
|
||||
--strip-components=1` is run).
|
||||
* The package must contain a `package.json` file with `name` and
|
||||
`version` properties.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install ./package.tgz
|
||||
```
|
||||
|
||||
* `npm install <tarball url>`:
|
||||
|
||||
Fetch the tarball url, and then install it. In order to distinguish between
|
||||
this and other options, the argument must start with "http://" or "https://"
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install https://github.com/indexzero/forever/tarball/v0.5.6
|
||||
```
|
||||
|
||||
* `npm install [<@scope>/]<name>`:
|
||||
|
||||
Do a `<name>@<tag>` install, where `<tag>` is the "tag" config. (See
|
||||
[`config`](/using-npm/config). The config's default value is `latest`.)
|
||||
|
||||
In most cases, this will install the version of the modules tagged as
|
||||
`latest` on the npm registry.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install sax
|
||||
```
|
||||
|
||||
`npm install` saves any specified packages into `dependencies` by default.
|
||||
Additionally, you can control where and how they get saved with some
|
||||
additional flags:
|
||||
|
||||
* `-P, --save-prod`: Package will appear in your `dependencies`. This
|
||||
is the default unless `-D` or `-O` are present.
|
||||
|
||||
* `-D, --save-dev`: Package will appear in your `devDependencies`.
|
||||
|
||||
* `-O, --save-optional`: Package will appear in your
|
||||
`optionalDependencies`.
|
||||
|
||||
* `--no-save`: Prevents saving to `dependencies`.
|
||||
|
||||
When using any of the above options to save dependencies to your
|
||||
package.json, there are two additional, optional flags:
|
||||
|
||||
* `-E, --save-exact`: Saved dependencies will be configured with an
|
||||
exact version rather than using npm's default semver range operator.
|
||||
|
||||
* `-B, --save-bundle`: Saved dependencies will also be added to your
|
||||
`bundleDependencies` list.
|
||||
|
||||
Further, if you have an `npm-shrinkwrap.json` or `package-lock.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
|
||||
[`scope`](/using-npm/scope).
|
||||
|
||||
Note: if you do not include the @-symbol on your scope name, npm will
|
||||
interpret this as a GitHub repository instead, see below. Scopes names
|
||||
must also be followed by a slash.
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
npm install sax
|
||||
npm install githubname/reponame
|
||||
npm install @myorg/privatepackage
|
||||
npm install node-tap --save-dev
|
||||
npm install dtrace-provider --save-optional
|
||||
npm install readable-stream --save-exact
|
||||
npm install ansi-regex --save-bundle
|
||||
```
|
||||
|
||||
**Note**: If there is a file or folder named `<name>` in the current
|
||||
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 <alias>@npm:<name>`:
|
||||
|
||||
Install a package under a custom alias. Allows multiple versions of
|
||||
a same-name package side-by-side, more convenient import names for
|
||||
packages with otherwise long ones, and using git forks replacements
|
||||
or forked npm packages as replacements. Aliasing works only on your
|
||||
project and does not rename packages in transitive dependencies.
|
||||
Aliases should follow the naming conventions stated in
|
||||
[`validate-npm-package-name`](https://www.npmjs.com/package/validate-npm-package-name#naming-rules).
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
npm install my-react@npm:react
|
||||
npm install jquery2@npm:jquery@2
|
||||
npm install jquery3@npm:jquery@3
|
||||
npm install npa@npm:npm-package-arg
|
||||
```
|
||||
|
||||
* `npm install [<@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
|
||||
will fail.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install sax@latest
|
||||
npm install @myorg/mypackage@latest
|
||||
```
|
||||
|
||||
* `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.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install sax@0.1.1
|
||||
npm install @myorg/privatepackage@1.5.0
|
||||
```
|
||||
|
||||
* `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`](/configuring-npm/package-json).
|
||||
|
||||
Note that most version ranges must be put in quotes so that your shell
|
||||
will treat it as a single argument.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install sax@">=0.1.0 <0.2.0"
|
||||
npm install @myorg/privatepackage@"16 - 17"
|
||||
```
|
||||
|
||||
* `npm install <git remote url>`:
|
||||
|
||||
Installs the package from the hosted git provider, cloning it with
|
||||
`git`. For a full git remote url, only that URL will be attempted.
|
||||
|
||||
```bash
|
||||
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
|
||||
```
|
||||
|
||||
`<protocol>` is one of `git`, `git+ssh`, `git+http`, `git+https`, or
|
||||
`git+file`.
|
||||
|
||||
If `#<commit-ish>` is provided, it will be used to clone exactly that
|
||||
commit. If the commit-ish has the format `#semver:<semver>`, `<semver>`
|
||||
can be any valid semver range or exact version, and npm will look for
|
||||
any tags or refs matching that range in the remote repository, much as
|
||||
it would for a registry dependency. If neither `#<commit-ish>` or
|
||||
`#semver:<semver>` is specified, then the default branch of the
|
||||
repository is used.
|
||||
|
||||
If the repository makes use of submodules, those submodules will be
|
||||
cloned as well.
|
||||
|
||||
If the package being installed contains a `prepare` script, its
|
||||
`dependencies` and `devDependencies` will be installed, and the prepare
|
||||
script will be run, before the package is packaged and installed.
|
||||
|
||||
The following git environment variables are recognized by npm and will
|
||||
be added to the environment when running git:
|
||||
|
||||
* `GIT_ASKPASS`
|
||||
* `GIT_EXEC_PATH`
|
||||
* `GIT_PROXY_COMMAND`
|
||||
* `GIT_SSH`
|
||||
* `GIT_SSH_COMMAND`
|
||||
* `GIT_SSL_CAINFO`
|
||||
* `GIT_SSL_NO_VERIFY`
|
||||
|
||||
See the git man page for details.
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
npm install git+ssh://git@github.com:npm/cli.git#v1.0.27
|
||||
npm install git+ssh://git@github.com:npm/cli#pull/273
|
||||
npm install git+ssh://git@github.com:npm/cli#semver:^5.0
|
||||
npm install git+https://isaacs@github.com/npm/cli.git
|
||||
npm install git://github.com/npm/cli.git#v1.0.27
|
||||
GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/cli.git
|
||||
```
|
||||
|
||||
* `npm install <githubname>/<githubrepo>[#<commit-ish>]`:
|
||||
* `npm install github:<githubname>/<githubrepo>[#<commit-ish>]`:
|
||||
|
||||
Install the package at `https://github.com/githubname/githubrepo` by
|
||||
attempting to clone it using `git`.
|
||||
|
||||
If `#<commit-ish>` is provided, it will be used to clone exactly that
|
||||
commit. If the commit-ish has the format `#semver:<semver>`, `<semver>`
|
||||
can be any valid semver range or exact version, and npm will look for
|
||||
any tags or refs matching that range in the remote repository, much as
|
||||
it would for a registry dependency. If neither `#<commit-ish>` or
|
||||
`#semver:<semver>` is specified, then `master` is used.
|
||||
|
||||
As with regular git dependencies, `dependencies` and `devDependencies`
|
||||
will be installed if the package has a `prepare` script before the
|
||||
package is done installing.
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
npm install mygithubuser/myproject
|
||||
npm install github:mygithubuser/myproject
|
||||
```
|
||||
|
||||
* `npm install gist:[<githubname>/]<gistID>[#<commit-ish>|#semver:<semver>]`:
|
||||
|
||||
Install the package at `https://gist.github.com/gistID` by attempting to
|
||||
clone it using `git`. The GitHub username associated with the gist is
|
||||
optional and will not be saved in `package.json`.
|
||||
|
||||
As with regular git dependencies, `dependencies` and `devDependencies` will
|
||||
be installed if the package has a `prepare` script before the package is
|
||||
done installing.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install gist:101a11beef
|
||||
```
|
||||
|
||||
* `npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]`:
|
||||
|
||||
Install the package at `https://bitbucket.org/bitbucketname/bitbucketrepo`
|
||||
by attempting to clone it using `git`.
|
||||
|
||||
If `#<commit-ish>` is provided, it will be used to clone exactly that
|
||||
commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` can
|
||||
be any valid semver range or exact version, and npm will look for any tags
|
||||
or refs matching that range in the remote repository, much as it would for a
|
||||
registry dependency. If neither `#<commit-ish>` or `#semver:<semver>` is
|
||||
specified, then `master` is used.
|
||||
|
||||
As with regular git dependencies, `dependencies` and `devDependencies` will
|
||||
be installed if the package has a `prepare` script before the package is
|
||||
done installing.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install bitbucket:mybitbucketuser/myproject
|
||||
```
|
||||
|
||||
* `npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]`:
|
||||
|
||||
Install the package at `https://gitlab.com/gitlabname/gitlabrepo`
|
||||
by attempting to clone it using `git`.
|
||||
|
||||
If `#<commit-ish>` is provided, it will be used to clone exactly that
|
||||
commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` can
|
||||
be any valid semver range or exact version, and npm will look for any tags
|
||||
or refs matching that range in the remote repository, much as it would for a
|
||||
registry dependency. If neither `#<commit-ish>` or `#semver:<semver>` is
|
||||
specified, then `master` is used.
|
||||
|
||||
As with regular git dependencies, `dependencies` and `devDependencies` will
|
||||
be installed if the package has a `prepare` script before the package is
|
||||
done installing.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install gitlab:mygitlabuser/myproject
|
||||
npm install gitlab:myusr/myproj#semver:^5.0
|
||||
```
|
||||
|
||||
You may combine multiple arguments and even multiple types of arguments.
|
||||
For example:
|
||||
|
||||
```bash
|
||||
npm install sax@">=0.1.0 <0.2.0" bench supervisor
|
||||
```
|
||||
|
||||
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 `--package-lock-only` argument will only update the
|
||||
`package-lock.json`, instead of checking `node_modules` and downloading
|
||||
dependencies.
|
||||
|
||||
The `-f` or `--force` argument will force npm to fetch remote resources
|
||||
even if a local copy exists on disk.
|
||||
|
||||
```bash
|
||||
npm install sax --force
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
See the [`config`](/using-npm/config) help doc. Many of the configuration
|
||||
params have some effect on installation, since that's most of what npm
|
||||
does.
|
||||
|
||||
These are some of the most common options related to installation.
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `save`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
Save installed packages to a package.json file as dependencies.
|
||||
|
||||
When used with the `npm rm` command, removes the dependency from
|
||||
package.json.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `save-exact`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Operates in "global" mode, so that packages are installed into the `prefix`
|
||||
folder instead of the current working directory. See
|
||||
[folders](/configuring-npm/folders) for more on the differences in behavior.
|
||||
|
||||
* packages are installed into the `{prefix}/lib/node_modules` folder, instead
|
||||
of the current working directory.
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Causes npm to install the package into your local `node_modules` folder with
|
||||
the same layout it uses with the global `node_modules` folder. Only your
|
||||
direct dependencies will show in `node_modules` and everything they depend
|
||||
on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Causes npm to install the package such that versions of npm prior to 1.4,
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If set to `true`, and `--legacy-peer-deps` is not set, then _any_
|
||||
conflicting `peerDependencies` will be treated as an install failure, even
|
||||
if npm could reasonably guess the appropriate resolution based on non-peer
|
||||
dependency relationships.
|
||||
|
||||
By default, conflicting `peerDependencies` deep in the dependency graph will
|
||||
be resolved using the nearest non-peer dependency specification, even if
|
||||
doing so will result in some packages receiving a peer dependency outside
|
||||
the range set in their package's `peerDependencies` object.
|
||||
|
||||
When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
If set to false, then ignore `package-lock.json` files when installing. This
|
||||
will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
When package package-locks are disabled, automatic pruning of extraneous
|
||||
modules will also be disabled. To remove extraneous modules with
|
||||
package-locks disabled use `npm prune`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
'production', otherwise empty.
|
||||
* Type: "dev", "optional", or "peer" (can be set multiple times)
|
||||
|
||||
Dependency types to omit from the installation tree on disk.
|
||||
|
||||
Note that these dependencies _are_ still resolved and added to the
|
||||
`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
|
||||
physically installed on disk.
|
||||
|
||||
If a package type appears in both the `--include` and `--omit` lists, then
|
||||
it will be included.
|
||||
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If true, npm does not run scripts specified in package.json files.
|
||||
|
||||
Note that commands explicitly intended to run a particular script, such as
|
||||
`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" submit audit reports alongside the current npm command to the
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
Tells npm to create symlinks (or `.cmd` shims on Windows) for package
|
||||
executables.
|
||||
|
||||
Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
* 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`, as well as `pack` and `publish`.
|
||||
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### Algorithm
|
||||
|
||||
Given a `package{dep}` structure: `A{B,C}, B{C}, C{D}`,
|
||||
the npm install algorithm produces:
|
||||
|
||||
```bash
|
||||
A
|
||||
+-- B
|
||||
+-- 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. 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:
|
||||
|
||||
```bash
|
||||
A
|
||||
+-- B
|
||||
+-- C
|
||||
`-- D@2
|
||||
+-- D@1
|
||||
```
|
||||
|
||||
Because B's D@1 will be installed in the top-level, C now has to install
|
||||
D@2 privately for itself. This algorithm is deterministic, but different
|
||||
trees may be produced if two dependencies are requested for installation in
|
||||
a different order.
|
||||
|
||||
See [folders](/configuring-npm/folders) for a more detailed description of
|
||||
the specific folder structures that npm creates.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm update](/commands/npm-update)
|
||||
* [npm audit](/commands/npm-audit)
|
||||
* [npm fund](/commands/npm-fund)
|
||||
* [npm link](/commands/npm-link)
|
||||
* [npm rebuild](/commands/npm-rebuild)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm dist-tag](/commands/npm-dist-tag)
|
||||
* [npm uninstall](/commands/npm-uninstall)
|
||||
* [npm shrinkwrap](/commands/npm-shrinkwrap)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
* [workspaces](/using-npm/workspaces)
|
384
node/lib/node_modules/npm/docs/content/commands/npm-link.md
generated
vendored
Normal file
384
node/lib/node_modules/npm/docs/content/commands/npm-link.md
generated
vendored
Normal file
|
@ -0,0 +1,384 @@
|
|||
---
|
||||
title: npm-link
|
||||
section: 1
|
||||
description: Symlink a package folder
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm link (in package dir)
|
||||
npm link [<@scope>/]<pkg>[@<version>]
|
||||
|
||||
alias: npm ln
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This is handy for installing your own stuff, so that you can work on it and
|
||||
test iteratively without having to continually rebuild.
|
||||
|
||||
Package linking is a two-step process.
|
||||
|
||||
First, `npm link` in a package folder will create a symlink in the global
|
||||
folder `{prefix}/lib/node_modules/<package>` that links to the package
|
||||
where the `npm link` command was executed. It will also link any bins in
|
||||
the package to `{prefix}/bin/{name}`. Note that `npm link` uses the global
|
||||
prefix (see `npm prefix -g` for its value).
|
||||
|
||||
Next, in some other location, `npm link package-name` will create a
|
||||
symbolic link from globally-installed `package-name` to `node_modules/` of
|
||||
the current folder.
|
||||
|
||||
Note that `package-name` is taken from `package.json`, _not_ from the
|
||||
directory name.
|
||||
|
||||
The package name can be optionally prefixed with a scope. See
|
||||
[`scope`](/using-npm/scope). The scope must be preceded by an @-symbol and
|
||||
followed by a slash.
|
||||
|
||||
When creating tarballs for `npm publish`, the linked packages are
|
||||
"snapshotted" to their current state by resolving the symbolic links, if
|
||||
they are included in `bundleDependencies`.
|
||||
|
||||
For example:
|
||||
|
||||
```bash
|
||||
cd ~/projects/node-redis # go into the package directory
|
||||
npm link # creates global link
|
||||
cd ~/projects/node-bloggy # go into some other package directory.
|
||||
npm link redis # link-install the package
|
||||
```
|
||||
|
||||
Now, any changes to `~/projects/node-redis` will be reflected in
|
||||
`~/projects/node-bloggy/node_modules/node-redis/`. Note that the link
|
||||
should be to the package name, not the directory name for that package.
|
||||
|
||||
You may also shortcut the two steps in one. For example, to do the
|
||||
above use-case in a shorter way:
|
||||
|
||||
```bash
|
||||
cd ~/projects/node-bloggy # go into the dir of your main project
|
||||
npm link ../node-redis # link the dir of your dependency
|
||||
```
|
||||
|
||||
The second line is the equivalent of doing:
|
||||
|
||||
```bash
|
||||
(cd ../node-redis; npm link)
|
||||
npm link redis
|
||||
```
|
||||
|
||||
That is, it first creates a global link, and then links the global
|
||||
installation target into your project's `node_modules` folder.
|
||||
|
||||
Note that in this case, you are referring to the directory name,
|
||||
`node-redis`, rather than the package name `redis`.
|
||||
|
||||
If your linked package is scoped (see [`scope`](/using-npm/scope)) your
|
||||
link command must include that scope, e.g.
|
||||
|
||||
```bash
|
||||
npm link @myorg/privatepackage
|
||||
```
|
||||
|
||||
### Caveat
|
||||
|
||||
Note that package dependencies linked in this way are _not_ saved to
|
||||
`package.json` by default, on the assumption that the intention is to have
|
||||
a link stand in for a regular non-link dependency. Otherwise, for example,
|
||||
if you depend on `redis@^3.0.1`, and ran `npm link redis`, it would replace
|
||||
the `^3.0.1` dependency with `file:../path/to/node-redis`, which you
|
||||
probably don't want! Additionally, other users or developers on your
|
||||
project would run into issues if they do not have their folders set up
|
||||
exactly the same as yours.
|
||||
|
||||
If you are adding a _new_ dependency as a link, you should add it to the
|
||||
relevant metadata by running `npm install <dep> --package-lock-only`.
|
||||
|
||||
If you _want_ to save the `file:` reference in your `package.json` and
|
||||
`package-lock.json` files, you can use `npm link <dep> --save` to do so.
|
||||
|
||||
### Workspace Usage
|
||||
|
||||
`npm link <pkg> --workspace <name>` will link the relevant package as a
|
||||
dependency of the specified workspace(s). Note that It may actually be
|
||||
linked into the parent project's `node_modules` folder, if there are no
|
||||
conflicting dependencies.
|
||||
|
||||
`npm link --workspace <name>` will create a global link to the specified
|
||||
workspace(s).
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `save`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
Save installed packages to a package.json file as dependencies.
|
||||
|
||||
When used with the `npm rm` command, removes the dependency from
|
||||
package.json.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `save-exact`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Dependencies saved to package.json will be configured with an exact version
|
||||
rather than using npm's default semver range operator.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Operates in "global" mode, so that packages are installed into the `prefix`
|
||||
folder instead of the current working directory. See
|
||||
[folders](/configuring-npm/folders) for more on the differences in behavior.
|
||||
|
||||
* packages are installed into the `{prefix}/lib/node_modules` folder, instead
|
||||
of the current working directory.
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global-style`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Causes npm to install the package into your local `node_modules` folder with
|
||||
the same layout it uses with the global `node_modules` folder. Only your
|
||||
direct dependencies will show in `node_modules` and everything they depend
|
||||
on will be flattened in their `node_modules` folders. This obviously will
|
||||
eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling`
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `legacy-bundling`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Causes npm to install the package such that versions of npm prior to 1.4,
|
||||
such as the one included with node 0.8, can install the package. This
|
||||
eliminates all automatic deduping. If used with `global-style` this option
|
||||
will be preferred.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `strict-peer-deps`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If set to `true`, and `--legacy-peer-deps` is not set, then _any_
|
||||
conflicting `peerDependencies` will be treated as an install failure, even
|
||||
if npm could reasonably guess the appropriate resolution based on non-peer
|
||||
dependency relationships.
|
||||
|
||||
By default, conflicting `peerDependencies` deep in the dependency graph will
|
||||
be resolved using the nearest non-peer dependency specification, even if
|
||||
doing so will result in some packages receiving a peer dependency outside
|
||||
the range set in their package's `peerDependencies` object.
|
||||
|
||||
When such and override is performed, a warning is printed, explaining the
|
||||
conflict and the packages involved. If `--strict-peer-deps` is set, then
|
||||
this warning is treated as a failure.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
If set to false, then ignore `package-lock.json` files when installing. This
|
||||
will also prevent _writing_ `package-lock.json` if `save` is true.
|
||||
|
||||
When package package-locks are disabled, automatic pruning of extraneous
|
||||
modules will also be disabled. To remove extraneous modules with
|
||||
package-locks disabled use `npm prune`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
'production', otherwise empty.
|
||||
* Type: "dev", "optional", or "peer" (can be set multiple times)
|
||||
|
||||
Dependency types to omit from the installation tree on disk.
|
||||
|
||||
Note that these dependencies _are_ still resolved and added to the
|
||||
`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
|
||||
physically installed on disk.
|
||||
|
||||
If a package type appears in both the `--include` and `--omit` lists, then
|
||||
it will be included.
|
||||
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `ignore-scripts`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If true, npm does not run scripts specified in package.json files.
|
||||
|
||||
Note that commands explicitly intended to run a particular script, such as
|
||||
`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
|
||||
will still run their intended script if `ignore-scripts` is set, but they
|
||||
will *not* run any pre- or post-scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `audit`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" submit audit reports alongside the current npm command to the
|
||||
default registry and all registries configured for scopes. See the
|
||||
documentation for [`npm audit`](/commands/npm-audit) for details on what is
|
||||
submitted.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `bin-links`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
Tells npm to create symlinks (or `.cmd` shims on Windows) for package
|
||||
executables.
|
||||
|
||||
Set to false to have it not do this. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `fund`
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
When "true" displays the message at the end of each `npm install`
|
||||
acknowledging the number of dependencies looking for funding. See [`npm
|
||||
fund`](/commands/npm-fund) for details.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `dry-run`
|
||||
|
||||
* Default: false
|
||||
* 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`, as well as `pack` and `publish`.
|
||||
|
||||
Note: This is NOT honored by other network related commands, eg `dist-tags`,
|
||||
`owner`, etc.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm developers](/using-npm/developers)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
* [npm install](/commands/npm-install)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
83
node/lib/node_modules/npm/docs/content/commands/npm-logout.md
generated
vendored
Normal file
83
node/lib/node_modules/npm/docs/content/commands/npm-logout.md
generated
vendored
Normal file
|
@ -0,0 +1,83 @@
|
|||
---
|
||||
title: npm-logout
|
||||
section: 1
|
||||
description: Log out of the registry
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm logout [--registry=<url>] [--scope=<@scope>]
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Description
|
||||
|
||||
When logged into a registry that supports token-based authentication, tell
|
||||
the server to end this token's session. This will invalidate the token
|
||||
everywhere you're using it, not just for the current environment.
|
||||
|
||||
When logged into a legacy registry that uses username and password
|
||||
authentication, this will clear the credentials in your user configuration.
|
||||
In this case, it will _only_ affect the current environment.
|
||||
|
||||
If `--scope` is provided, this will find the credentials for the registry
|
||||
connected to that scope, if set.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
* Type: URL
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `scope`
|
||||
|
||||
* Default: the scope of the current project, if any, or ""
|
||||
* Type: String
|
||||
|
||||
Associate an operation with a scope for a scoped registry.
|
||||
|
||||
Useful when logging in to or out of a private registry:
|
||||
|
||||
```
|
||||
# log in, linking the scope to the custom registry
|
||||
npm login --scope=@mycorp --registry=https://registry.mycorp.com
|
||||
|
||||
# log out, removing the link and the auth token
|
||||
npm logout --scope=@mycorp
|
||||
```
|
||||
|
||||
This will cause `@mycorp` to be mapped to the registry for future
|
||||
installation of packages specified according to the pattern
|
||||
`@mycorp/package`.
|
||||
|
||||
This will also cause `npm init` to create a scoped package.
|
||||
|
||||
```
|
||||
# accept all defaults, and create a package named "@foo/whatever",
|
||||
# instead of just named "whatever"
|
||||
npm init --scope=@foo --yes
|
||||
```
|
||||
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm adduser](/commands/npm-adduser)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npm whoami](/commands/npm-whoami)
|
290
node/lib/node_modules/npm/docs/content/commands/npm-ls.md
generated
vendored
Normal file
290
node/lib/node_modules/npm/docs/content/commands/npm-ls.md
generated
vendored
Normal file
|
@ -0,0 +1,290 @@
|
|||
---
|
||||
title: npm-ls
|
||||
section: 1
|
||||
description: List installed packages
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm ls [[<@scope>/]<pkg> ...]
|
||||
|
||||
aliases: list, la, ll
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command will print to stdout all the versions of packages that are
|
||||
installed, as well as their dependencies when `--all` is specified, in a
|
||||
tree structure.
|
||||
|
||||
Note: to get a "bottoms up" view of why a given package is included in the
|
||||
tree at all, use [`npm explain`](/commands/npm-explain).
|
||||
|
||||
Positional arguments are `name@version-range` identifiers, which will limit
|
||||
the results to only the paths to the packages named. Note that nested
|
||||
packages will *also* show the paths to the specified packages. For
|
||||
example, running `npm ls promzard` in npm's source tree will show:
|
||||
|
||||
```bash
|
||||
npm@@VERSION@ /path/to/npm
|
||||
└─┬ init-package-json@0.0.4
|
||||
└── promzard@0.1.5
|
||||
```
|
||||
|
||||
It will print out extraneous, missing, and invalid packages.
|
||||
|
||||
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.
|
||||
|
||||
### Note: Design Changes Pending
|
||||
|
||||
The `npm ls` command's output and behavior made a _ton_ of sense when npm
|
||||
created a `node_modules` folder that naively nested every dependency. In
|
||||
such a case, the logical dependency graph and physical tree of packages on
|
||||
disk would be roughly identical.
|
||||
|
||||
With the advent of automatic install-time deduplication of dependencies in
|
||||
npm v3, the `ls` output was modified to display the logical dependency
|
||||
graph as a tree structure, since this was more useful to most users.
|
||||
However, without using `npm ls -l`, it became impossible show _where_ a
|
||||
package was actually installed much of the time!
|
||||
|
||||
With the advent of automatic installation of `peerDependencies` in npm v7,
|
||||
this gets even more curious, as `peerDependencies` are logically
|
||||
"underneath" their dependents in the dependency graph, but are always
|
||||
physically at or above their location on disk.
|
||||
|
||||
Also, in the years since npm got an `ls` command (in version 0.0.2!),
|
||||
dependency graphs have gotten much larger as a general rule. Therefore, in
|
||||
order to avoid dumping an excessive amount of content to the terminal, `npm
|
||||
ls` now only shows the _top_ level dependencies, unless `--all` is
|
||||
provided.
|
||||
|
||||
A thorough re-examination of the use cases, intention, behavior, and output
|
||||
of this command, is currently underway. Expect significant changes to at
|
||||
least the default human-readable `npm ls` output in npm v8.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `all`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
When running `npm outdated` and `npm ls`, setting `--all` will show all
|
||||
outdated or installed packages, rather than only those directly depended
|
||||
upon by the current project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
* In `npm pkg set` it enables parsing set values with JSON.parse() before
|
||||
saving them to your `package.json`.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `long`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show extended information in `ls`, `search`, and `help-search`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `parseable`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Output parseable results from commands that write to standard output. For
|
||||
`npm search`, this will be tab-separated table format.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `global`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Operates in "global" mode, so that packages are installed into the `prefix`
|
||||
folder instead of the current working directory. See
|
||||
[folders](/configuring-npm/folders) for more on the differences in behavior.
|
||||
|
||||
* packages are installed into the `{prefix}/lib/node_modules` folder, instead
|
||||
of the current working directory.
|
||||
* bin files are linked to `{prefix}/bin`
|
||||
* man pages are linked to `{prefix}/share/man`
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `depth`
|
||||
|
||||
* Default: `Infinity` if `--all` is set, otherwise `1`
|
||||
* Type: null or Number
|
||||
|
||||
The depth to go when recursing packages for `npm ls`.
|
||||
|
||||
If not set, `npm ls` will show only the immediate dependencies of the root
|
||||
project. If `--all` is set, then npm will show all dependencies by default.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `omit`
|
||||
|
||||
* Default: 'dev' if the `NODE_ENV` environment variable is set to
|
||||
'production', otherwise empty.
|
||||
* Type: "dev", "optional", or "peer" (can be set multiple times)
|
||||
|
||||
Dependency types to omit from the installation tree on disk.
|
||||
|
||||
Note that these dependencies _are_ still resolved and added to the
|
||||
`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
|
||||
physically installed on disk.
|
||||
|
||||
If a package type appears in both the `--include` and `--omit` lists, then
|
||||
it will be included.
|
||||
|
||||
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
|
||||
variable will be set to `'production'` for all lifecycle scripts.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `link`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Used with `npm ls`, limiting output to only those packages that are linked.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `package-lock-only`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
If set to true, the current operation will only use the `package-lock.json`,
|
||||
ignoring `node_modules`.
|
||||
|
||||
For `update` this means only the `package-lock.json` will be updated,
|
||||
instead of checking `node_modules` and downloading dependencies.
|
||||
|
||||
For `list` this means the output will be based on the tree described by the
|
||||
`package-lock.json`, rather than the contents of `node_modules`.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `unicode`
|
||||
|
||||
* Default: false on windows, true on mac/unix systems with a unicode locale,
|
||||
as defined by the `LC_ALL`, `LC_CTYPE`, or `LANG` environment variables.
|
||||
* Type: Boolean
|
||||
|
||||
When set to true, npm uses unicode characters in the tree output. When
|
||||
false, it uses ascii characters instead of unicode glyphs.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspace`
|
||||
|
||||
* Default:
|
||||
* Type: String (can be set multiple times)
|
||||
|
||||
Enable running a command in the context of the configured workspaces of the
|
||||
current project while filtering by running only the workspaces defined by
|
||||
this configuration option.
|
||||
|
||||
Valid values for the `workspace` config are either:
|
||||
|
||||
* Workspace names
|
||||
* Path to a workspace directory
|
||||
* Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
When set for the `npm init` command, this may be set to the folder of a
|
||||
workspace which does not yet exist, to create the folder and set it up as a
|
||||
brand new workspace within the project.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `workspaces`
|
||||
|
||||
* Default: null
|
||||
* Type: null or Boolean
|
||||
|
||||
Set to true to run the command in the context of **all** configured
|
||||
workspaces.
|
||||
|
||||
Explicitly setting this to false will cause commands like `install` to
|
||||
ignore workspaces altogether. When not set explicitly:
|
||||
|
||||
- Commands that operate on the `node_modules` tree (install, update, etc.)
|
||||
will link workspaces into the `node_modules` folder. - Commands that do
|
||||
other things (test, exec, publish, etc.) will operate on the root project,
|
||||
_unless_ one or more workspaces are specified in the `workspace` config.
|
||||
|
||||
This value is not exported to the environment for child processes.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `include-workspace-root`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Include the workspace root when workspaces are enabled for a command.
|
||||
|
||||
When false, specifying individual workspaces via the `workspace` config, or
|
||||
all workspaces via the `workspaces` flag, will cause npm to operate only on
|
||||
the specified workspaces, and not on the root project.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm explain](/commands/npm-explain)
|
||||
* [npm config](/commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm explain](/commands/npm-explain)
|
||||
* [npm install](/commands/npm-install)
|
||||
* [npm link](/commands/npm-link)
|
||||
* [npm prune](/commands/npm-prune)
|
||||
* [npm outdated](/commands/npm-outdated)
|
||||
* [npm update](/commands/npm-update)
|
121
node/lib/node_modules/npm/docs/content/commands/npm-org.md
generated
vendored
Normal file
121
node/lib/node_modules/npm/docs/content/commands/npm-org.md
generated
vendored
Normal file
|
@ -0,0 +1,121 @@
|
|||
---
|
||||
title: npm-org
|
||||
section: 1
|
||||
description: Manage orgs
|
||||
---
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm org set <orgname> <username> [developer | admin | owner]
|
||||
npm org rm <orgname> <username>
|
||||
npm org ls <orgname> [<username>]
|
||||
```
|
||||
|
||||
Note: This command is unaware of workspaces.
|
||||
|
||||
### Example
|
||||
|
||||
Add a new developer to an org:
|
||||
|
||||
```bash
|
||||
$ npm org set my-org @mx-smith
|
||||
```
|
||||
|
||||
Add a new admin to an org (or change a developer to an admin):
|
||||
|
||||
```bash
|
||||
$ npm org set my-org @mx-santos admin
|
||||
```
|
||||
|
||||
Remove a user from an org:
|
||||
|
||||
```bash
|
||||
$ npm org rm my-org mx-santos
|
||||
```
|
||||
|
||||
List all users in an org:
|
||||
|
||||
```bash
|
||||
$ npm org ls my-org
|
||||
```
|
||||
|
||||
List all users in JSON format:
|
||||
|
||||
```bash
|
||||
$ npm org ls my-org --json
|
||||
```
|
||||
|
||||
See what role a user has in an org:
|
||||
|
||||
```bash
|
||||
$ npm org ls my-org @mx-santos
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
You can use the `npm org` commands to manage and view users of an
|
||||
organization. It supports adding and removing users, changing their roles,
|
||||
listing them, and finding specific ones and their roles.
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
#### `registry`
|
||||
|
||||
* Default: "https://registry.npmjs.org/"
|
||||
* Type: URL
|
||||
|
||||
The base URL of the npm registry.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `otp`
|
||||
|
||||
* Default: null
|
||||
* Type: null or String
|
||||
|
||||
This is a one-time password from a two-factor authenticator. It's needed
|
||||
when publishing or changing package permissions with `npm access`.
|
||||
|
||||
If not set, and a registry response fails with a challenge for a one-time
|
||||
password, npm will prompt on the command line for one.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `json`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Whether or not to output JSON data, rather than the normal output.
|
||||
|
||||
* In `npm pkg set` it enables parsing set values with JSON.parse() before
|
||||
saving them to your `package.json`.
|
||||
|
||||
Not supported by all npm commands.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
#### `parseable`
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Output parseable results from commands that write to standard output. For
|
||||
`npm search`, this will be tab-separated table format.
|
||||
|
||||
<!-- automatically generated, do not edit manually -->
|
||||
<!-- see lib/utils/config/definitions.js -->
|
||||
|
||||
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||||
|
||||
### See Also
|
||||
|
||||
* [using orgs](/using-npm/orgs)
|
||||
* [Documentation on npm Orgs](https://docs.npmjs.com/orgs/)
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue