npm-check-updates 16.4.2 → 16.5.0

package/README.md

@@ -130,6 +130,9 @@ ncu "/^(?!react-).*$/" # windows
 
 ## Options
 
+<!-- BEGIN Options -->
+<!-- Do not edit this section by hand. It is auto-generated in build-options.ts. Run "npm run build" or "npm run build:options" to build. -->
+
 ```text
 --cache                    Cache versions to the cache file
 --cacheClear               Clear the default cache, or the cache file
@@ -151,7 +154,7 @@ ncu "/^(?!react-).*$/" # windows
                            (comma-delimited). (default:
                            "prod,dev,bundle,optional")
 --deprecated               Include deprecated packages.
---doctor                   Iteratively installs upgrades and runs tests to
+-d, --doctor               Iteratively installs upgrades and runs tests to
                            identify breaking upgrades. Requires "-u" to
                            execute. Run "ncu --help --doctor" for details.
 --doctorInstall <command>  Specifies the install script to use in doctor
@@ -246,64 +249,252 @@ ncu "/^(?!react-).*$/" # windows
 -h, --help                 display help for command
 ```
 
-## Interactive Mode
+<!-- END Options -->
 
-Choose exactly which upgrades to make in interactive mode:
+## Advanced Options
 
-```sh
-ncu --interactive
-ncu -i
-```
+Some options have advanced usage, or allow per-package values by specifying a function in your ncurc.js file.
 
-Select which upgrades you want:
+Run `ncu --help [OPTION]` to view advanced help for a specific option, or see below:
 
-![ncu --interactive](https://user-images.githubusercontent.com/750276/175337598-cdbb2c46-64f8-44f5-b54e-4ad74d7b52b4.png)
+<!-- BEGIN Advanced Options -->
+<!-- Do not edit this section by hand. It is auto-generated in build-options.ts. Run "npm run build" or "npm run build:options" to build. -->
 
-Combine with `--format group` for a truly _luxe_ experience:
+## doctor
 
-![ncu --interactive --format group](https://user-images.githubusercontent.com/750276/175336533-539261e4-5cf1-458f-9fbb-a7be2b477ebb.png)
+Usage:
 
-## Doctor Mode
+    ncu --doctor
+    ncu -d
 
-Usage: `ncu --doctor [-u] [options]`
+Iteratively installs upgrades and runs tests to identify breaking upgrades. Reverts broken upgrades and updates package.json with working upgrades.
 
-Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires `-u` to execute (modifies your package file, lock file, and node_modules).
+Add "-u" to execute (modifies your package file, lock file, and node_modules)
 
 To be more precise:
 
-1. Runs `npm install` (or `yarn`) and `npm test` to ensure tests are currently passing. You can specify your own scripts with `--doctorInstall` and `--doctorTest`.
-2. Runs `ncu -u` to optimistically upgrade all dependencies.
+1. Runs "npm install" and "npm test" to ensure tests are currently passing.
+2. Runs "ncu -u" to optimistically upgrade all dependencies.
 3. If tests pass, hurray!
 4. If tests fail, restores package file and lock file.
 5. For each dependency, install upgrade and run tests.
-6. When the breaking upgrade is found, saves partially upgraded package.json (not including the breaking upgrade) and exits.
+6. Prints broken upgrades with test error.
+7. Saves working upgrades to package.json.
+
+Additional options:
+
+    --doctorInstall   specify a custom install script (default: "npm install" or "yarn")
+    --doctorTest      specify a custom test script (default: "npm test")
+
+Example:
+
+    $ ncu --doctor -u
+    Running tests before upgrading
+    npm install
+    npm run test
+    Upgrading all dependencies and re-running tests
+    ncu -u
+    npm install
+    npm run test
+    Tests failed
+    Identifying broken dependencies
+    npm install
+    npm install --no-save react@16.0.0
+    npm run test
+      ✓ react 15.0.0 → 16.0.0
+    npm install --no-save react-redux@7.0.0
+    npm run test
+      ✗ react-redux 6.0.0 → 7.0.0
+
+    /projects/myproject/test.js:13
+      throw new Error('Test failed!')
+      ^
+
+    npm install --no-save react-dnd@11.1.3
+    npm run test
+      ✓ react-dnd 10.0.0 → 11.1.3
+    Saving partially upgraded package.json
+
+## format
+
+Usage:
+
+    ncu --format [value]
+
+Modify the output formatting or show additional information. Specify one or more comma-delimited values.
+
+    ┌──────────────┬─────────────────────────────────────────────────────────────────────────┐
+    │        group │ Groups packages by major, minor, patch, and major version zero updates. │
+    ├──────────────┼─────────────────────────────────────────────────────────────────────────┤
+    │ ownerChanged │ Shows if the package owner has changed.                                 │
+    ├──────────────┼─────────────────────────────────────────────────────────────────────────┤
+    │         repo │ Infers and displays links to the package's source code repository.      │
+    ├──────────────┼─────────────────────────────────────────────────────────────────────────┤
+    │         time │ Shows the publish time of each upgrade.                                 │
+    └──────────────┴─────────────────────────────────────────────────────────────────────────┘
+
+## groupFunction
+
+Usage:
+
+    ncu --groupFunction [fn]
+
+Customize how packages are divided into groups when using '--format group'. Only available in .ncurc.js or when importing npm-check-updates as a module:
+
+    /**
+      @param name             The name of the dependency.
+      @param defaultGroup     The predefined group name which will be used by default.
+      @param currentSpec      The current version range in your package.json.
+      @param upgradedSpec     The upgraded version range that will be written to your package.json.
+      @param upgradedVersion  The upgraded version number returned by the registry.
+      @returns                A predefined group name ('major' | 'minor' | 'patch' | 'majorVersionZero' | 'none') or a custom string to create your own group.
+    */
+    groupFunction: (name, defaultGroup, currentSpec, upgradedSpec, upgradedVersion} {
+      if (name === 'typescript' && defaultGroup === 'minor') {
+        return 'major'
+      }
+      if (name.startsWith('@myorg/')) {
+        return 'My Org'
+      }
+      return defaultGroup
+    }
+
+## packageManager
+
+Usage:
+
+    ncu --packageManager [s]
+    ncu -p [s]
+
+Specifies the package manager to use when looking up version numbers.
+
+    ┌────────────────┬───────────────────────────────────────────────────────────────────────────────────────────┐
+    │            npm │ System-installed npm. Default.                                                            │
+    ├────────────────┼───────────────────────────────────────────────────────────────────────────────────────────┤
+    │           yarn │ System-installed yarn. Automatically used if yarn.lock is present.                        │
+    ├────────────────┼───────────────────────────────────────────────────────────────────────────────────────────┤
+    │ staticRegistry │ Checks versions from a static file. Must include the --registry option with the path to a │
+    │                │ JSON registry file.                                                                       │
+    │                │                                                                                           │
+    │                │ Example:                                                                                  │
+    │                │                                                                                           │
+    │                │     $ ncu --packageManager staticRegistry --registry ./my-registry.json                   │
+    │                │                                                                                           │
+    │                │ my-registry.json:                                                                         │
+    │                │                                                                                           │
+    │                │     {                                                                                     │
+    │                │       "prettier": "2.7.1",                                                                │
+    │                │       "typescript": "4.7.4"                                                               │
+    │                │     }                                                                                     │
+    └────────────────┴───────────────────────────────────────────────────────────────────────────────────────────┘
+
+## peer
+
+Usage:
+
+    ncu --peer
+
+Check peer dependencies of installed packages and filter updates to compatible versions.
 
 Example:
 
+The following example demonstrates how --peer works, and how it uses peer dependencies from upgraded modules.
+
+The package ncu-test-peer-update has two versions published:
+
+- 1.0.0 has peer dependency "ncu-test-return-version": "1.0.x"
+- 1.1.0 has peer dependency "ncu-test-return-version": "1.1.x"
+
+Our test app has the following dependencies:
+
+    "ncu-test-peer-update": "1.0.0",
+    "ncu-test-return-version": "1.0.0"
+
+The latest versions of these packages are:
+
+    "ncu-test-peer-update": "1.1.0",
+    "ncu-test-return-version": "2.0.0"
+
+With --peer:
+
+ncu upgrades packages to the highest version that still adheres to the peer dependency constraints:
+
+    ncu-test-peer-update     1.0.0  →  1.1.0
+    ncu-test-return-version  1.0.0  →  1.1.0
+
+Without --peer:
+
+As a comparison: without using the --peer option, ncu will suggest the latest versions, ignoring peer dependencies:
+
+    ncu-test-peer-update     1.0.0  →  1.1.0
+    ncu-test-return-version  1.0.0  →  2.0.0
+
+## registry
+
+Usage:
+
+    ncu --registry [uri]
+    ncu -r [uri]
+
+Specify the registry to use when looking up package version numbers.
+
+When --packageManager staticRegistry is set, --registry must specify a path to a JSON
+registry file.
+
+## target
+
+Usage:
+
+    ncu --target [value]
+    ncu -t [value]
+
+Determines the version to upgrade to. (default: "latest")
+
+    ┌──────────┬──────────────────────────────────────────────────────────────────────────────────────────────┐
+    │ greatest │ Upgrade to the highest version number published, regardless of release date or tag. Includes │
+    ├──────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
+    │   latest │ Upgrade to whatever the package's "latest" git tag points to. Excludes pre is specified.     │
+    ├──────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
+    │    minor │ Upgrade to the highest minor version without bumping the major version.                      │
+    ├──────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
+    │   newest │ Upgrade to the version with the most recent publish date, even if there are other version    │
+    │          │ numbers that are higher. Includes prereleases.                                               │
+    ├──────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
+    │    patch │ Upgrade to the highest patch version without bumping the minor or major versions.            │
+    ├──────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
+    │   @[tag] │ Upgrade to the version published to a specific tag, e.g. 'next' or 'beta'.                   │
+    └──────────┴──────────────────────────────────────────────────────────────────────────────────────────────┘
+
+You can also specify a custom function in your .ncurc.js file, or when importing npm-check-updates as a module:
+
+    /** Custom target.
+      @param dependencyName The name of the dependency.
+      @param parsedVersion A parsed Semver object from semver-utils.
+        (See https://git.coolaj86.com/coolaj86/semver-utils.js#semverutils-parse-semverstring)
+      @returns One of the valid target values (specified in the table above).
+    */
+    target: (dependencyName, [{ semver, version, operator, major, minor, patch, release, build }]) => {
+      if (major === '0') return 'minor'
+      return 'latest'
+    }
+
+<!-- END Advanced Options -->
+
+## Interactive Mode
+
+Choose which packages to update in interactive mode:
+
 ```sh
-$ ncu --doctor -u
-npm install
-npm run test
-ncu -u
-npm install
-npm run test
-Failing tests found:
-/projects/myproject/test.js:13
-  throw new Error('Test failed!')
-  ^
-Now let's identify the culprit, shall we?
-Restoring package.json
-Restoring package-lock.json
-npm install
-npm install --no-save react@16.0.0
-npm run test
-  ✓ react 15.0.0 → 16.0.0
-npm install --no-save react-redux@7.0.0
-npm run test
-  ✗ react-redux 6.0.0 → 7.0.0
-Saving partially upgraded package.json
+ncu --interactive
+ncu -i
 ```
 
+![ncu --interactive](https://user-images.githubusercontent.com/750276/175337598-cdbb2c46-64f8-44f5-b54e-4ad74d7b52b4.png)
+
+Combine with `--format group` for a truly _luxe_ experience:
+
+![ncu --interactive --format group](https://user-images.githubusercontent.com/750276/175336533-539261e4-5cf1-458f-9fbb-a7be2b477ebb.png)
+
 ## Config File
 
 Use a `.ncurc.{json,yml,js}` file to specify configuration information.

package/build/em/src/@types/IndexType.d.ts

@@ -0,0 +1,5 @@
+/** A very generic object. */
+declare type Index<T = any> = {
+    [key: string]: T;
+};
+export default Index;

package/build/em/src/@types/IndexType.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IndexType.js.map

package/build/em/src/@types/IndexType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexType.js","sourceRoot":"","sources":["../../../../../em/src/@types/IndexType.ts"],"names":[],"mappings":""}

package/build/em/src/util/keyValueBy.d.ts

@@ -0,0 +1,5 @@
+import Index from '../@types/IndexType';
+declare type KeyValueGenerator<K, V, R> = (key: K, value: V, accum: Index<R>) => Index<R> | null;
+declare function keyValueBy<T, R>(arr: T[], keyValue: KeyValueGenerator<T, number, R>, initialValue?: Index<R>): Index<R>;
+declare function keyValueBy<T, R>(obj: Index<T>, keyValue: KeyValueGenerator<string, T, R>, initialValue?: Index<R>): Index<R>;
+export default keyValueBy;

package/build/em/src/util/keyValueBy.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/** Generates an object from an array or object. Simpler than reduce or _.transform. The KeyValueGenerator passes (key, value) if the input is an object, and (value, i) if it is an array. The return object from each iteration is merged into the accumulated object. Return null to skip an item. */
+function keyValueBy(input, keyValue, accum = {}) {
+    const isArray = Array.isArray(input);
+    // considerably faster than Array.prototype.reduce
+    Object.entries(input || {}).forEach(([key, value], i) => {
+        const o = isArray
+            ? keyValue(value, i, accum)
+            : keyValue(key, value, accum);
+        Object.entries(o || {}).forEach(entry => {
+            accum[entry[0]] = entry[1];
+        });
+    });
+    return accum;
+}
+exports.default = keyValueBy;
+//# sourceMappingURL=keyValueBy.js.map

package/build/em/src/util/keyValueBy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyValueBy.js","sourceRoot":"","sources":["../../../../../em/src/util/keyValueBy.ts"],"names":[],"mappings":";;AASA,wSAAwS;AACxS,SAAS,UAAU,CACjB,KAAqB,EACrB,QAAsE,EACtE,QAAkB,EAAE;IAEpB,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IACpC,kDAAkD;IAClD,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE;QACtD,MAAM,CAAC,GAAG,OAAO;YACf,CAAC,CAAE,QAAyC,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC;YAC7D,CAAC,CAAE,QAA0C,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;QAClE,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACtC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,OAAO,KAAK,CAAA;AACd,CAAC;AAED,kBAAe,UAAU,CAAA"}

package/build/npm-check-updates/src/bin/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/build/npm-check-updates/src/index.d.ts

@@ -0,0 +1,17 @@
+import { Index } from './types/IndexType';
+import { PackageFile } from './types/PackageFile';
+import { RunOptions } from './types/RunOptions';
+import { VersionSpec } from './types/VersionSpec';
+/** Main entry point.
+ *
+ * @returns Promise<
+ * PackageFile                    Default returns upgraded package file.
+ * | Index<VersionSpec>    --jsonUpgraded returns only upgraded dependencies.
+ * | void                         --global upgrade returns void.
+ * >
+ */
+export declare function run(runOptions?: RunOptions, { cli }?: {
+    cli?: boolean;
+}): Promise<PackageFile | Index<VersionSpec> | void>;
+export default run;
+export type { RunOptions };

package/build/npm-check-updates/src/lib/doctor.d.ts

@@ -0,0 +1,8 @@
+import { Index } from '../types/IndexType';
+import { Options } from '../types/Options';
+import { PackageFile } from '../types/PackageFile';
+import { VersionSpec } from '../types/VersionSpec';
+declare type Run = (options?: Options) => Promise<PackageFile | Index<VersionSpec> | void>;
+/** Iteratively installs upgrades and runs tests to identify breaking upgrades. */
+declare const doctor: (run: Run, options: Options) => Promise<void>;
+export default doctor;

package/build/npm-check-updates/src/lib/getIgnoredUpgrades.d.ts

@@ -0,0 +1,8 @@
+import { IgnoredUpgrade } from '../types/IgnoredUpgrade';
+import { Index } from '../types/IndexType';
+import { Options } from '../types/Options';
+import { Version } from '../types/Version';
+import { VersionSpec } from '../types/VersionSpec';
+/** Get all upgrades that are ignored due to incompatible peer dependencies. */
+export declare function getIgnoredUpgrades(current: Index<VersionSpec>, upgraded: Index<VersionSpec>, upgradedPeerDependencies: Index<Index<Version>>, options?: Options): Promise<Index<IgnoredUpgrade>>;
+export default getIgnoredUpgrades;

package/build/npm-check-updates/src/lib/getInstalledPackages.d.ts

@@ -0,0 +1,12 @@
+import { Options } from '../types/Options';
+/**
+ * @param [options]
+ * @param options.cwd
+ * @param options.filter
+ * @param options.global
+ * @param options.packageManager
+ * @param options.prefix
+ * @param options.reject
+ */
+declare function getInstalledPackages(options?: Options): Promise<import("../types/IndexType").Index<string>>;
+export default getInstalledPackages;

package/build/npm-check-updates/src/lib/getPackageManager.d.ts

@@ -0,0 +1,12 @@
+import { Maybe } from '../types/Maybe';
+import { PackageManager } from '../types/PackageManager';
+/**
+ * Initialize the version manager with the given package manager.
+ *
+ * @param packageManagerNameOrObject
+ * @param packageManagerNameOrObject.global
+ * @param packageManagerNameOrObject.packageManager
+ * @returns
+ */
+declare function getPackageManager(packageManagerNameOrObject: Maybe<string | PackageManager>): PackageManager;
+export default getPackageManager;

package/build/npm-check-updates/src/lib/getPeerDependenciesFromRegistry.d.ts

@@ -0,0 +1,12 @@
+import { Index } from '../types/IndexType';
+import { Options } from '../types/Options';
+import { VersionSpec } from '../types/VersionSpec';
+/**
+ * Get the latest or greatest versions from the NPM repository based on the version target.
+ *
+ * @param packageMap   An object whose keys are package name and values are version
+ * @param [options={}] Options.
+ * @returns Promised {packageName: peer dependencies} collection
+ */
+declare function getPeerDependenciesFromRegistry(packageMap: Index<VersionSpec>, options: Options): Promise<{}>;
+export default getPeerDependenciesFromRegistry;

package/build/npm-check-updates/src/lib/queryVersions.d.ts

@@ -0,0 +1,13 @@
+import { Index } from '../types/IndexType';
+import { Options } from '../types/Options';
+import { VersionResult } from '../types/VersionResult';
+import { VersionSpec } from '../types/VersionSpec';
+/**
+ * Get the latest or greatest versions from the NPM repository based on the version target.
+ *
+ * @param packageMap   An object whose keys are package name and values are current versions. May include npm aliases, i.e. { "package": "npm:other-package@1.0.0" }
+ * @param [options={}] Options. Default: { target: 'latest' }.
+ * @returns Promised {packageName: version} collection
+ */
+declare function queryVersions(packageMap: Index<VersionSpec>, options?: Options): Promise<Index<VersionResult>>;
+export default queryVersions;

package/build/npm-check-updates/src/lib/runGlobal.d.ts

@@ -0,0 +1,5 @@
+import { Index } from '../types/IndexType';
+import { Options } from '../types/Options';
+/** Checks global dependencies for upgrades. */
+declare function runGlobal(options: Options): Promise<Index<string> | void>;
+export default runGlobal;

package/build/npm-check-updates/src/lib/runLocal.d.ts

@@ -0,0 +1,18 @@
+import { Index } from '../types/IndexType';
+import { Maybe } from '../types/Maybe';
+import { Options } from '../types/Options';
+import { PackageFile } from '../types/PackageFile';
+import { Version } from '../types/Version';
+import { VersionSpec } from '../types/VersionSpec';
+/**
+ * Return a promise which resolves to object storing package owner changed status for each dependency.
+ *
+ * @param fromVersion current packages version.
+ * @param toVersion target packages version.
+ * @param options
+ * @returns
+ */
+export declare function getOwnerPerDependency(fromVersion: Index<Version>, toVersion: Index<Version>, options: Options): Promise<Index<boolean>>;
+/** Checks local project dependencies for upgrades. */
+declare function runLocal(options: Options, pkgData?: Maybe<string>, pkgFile?: Maybe<string>): Promise<PackageFile | Index<VersionSpec>>;
+export default runLocal;

package/build/npm-check-updates/src/lib/upgradePackageDefinitions.d.ts

@@ -0,0 +1,13 @@
+import { Index } from '../types/IndexType';
+import { Options } from '../types/Options';
+import { VersionResult } from '../types/VersionResult';
+import { VersionSpec } from '../types/VersionSpec';
+/**
+ * Returns a 3-tuple of upgradedDependencies, their latest versions and the resulting peer dependencies.
+ *
+ * @param currentDependencies
+ * @param options
+ * @returns
+ */
+export declare function upgradePackageDefinitions(currentDependencies: Index<VersionSpec>, options: Options): Promise<[Index<VersionSpec>, Index<VersionResult>, Index<Index<VersionSpec>>?]>;
+export default upgradePackageDefinitions;

package/build/npm-check-updates/src/package-managers/index.d.ts

@@ -0,0 +1,4 @@
+import { Index } from '../types/IndexType';
+import { PackageManager } from '../types/PackageManager';
+declare const _default: Index<PackageManager>;
+export default _default;

package/build/npm-check-updates/src/package-managers/npm.d.ts

@@ -0,0 +1,133 @@
+import { GetVersion } from '../types/GetVersion';
+import { Index } from '../types/IndexType';
+import { NpmConfig } from '../types/NpmConfig';
+import { NpmOptions } from '../types/NpmOptions';
+import { Options } from '../types/Options';
+import { Packument } from '../types/Packument';
+import { Version } from '../types/Version';
+import { VersionSpec } from '../types/VersionSpec';
+/**
+ * Check if package author changed between current and upgraded version.
+ *
+ * @param packageName Name of the package
+ * @param currentVersion Current version declaration (may be range)
+ * @param upgradedVersion Upgraded version declaration (may be range)
+ * @param npmConfigLocal Additional npm config variables that are merged into the system npm config
+ * @returns A promise that fulfills with boolean value.
+ */
+export declare function packageAuthorChanged(packageName: string, currentVersion: VersionSpec, upgradedVersion: VersionSpec, options?: Options, npmConfigLocal?: NpmConfig): Promise<boolean>;
+/**
+ * Returns an object of specified values retrieved by npm view.
+ *
+ * @param packageName   Name of the package
+ * @param fields        Array of fields like versions, time, version
+ * @param               currentVersion
+ * @returns             Promised result
+ */
+export declare function viewMany(packageName: string, fields: string[], currentVersion: Version, options: Options, retried?: number, npmConfigLocal?: NpmConfig): Promise<Packument>;
+/** Memoize viewMany for --deep performance. */
+export declare const viewManyMemoized: typeof viewMany;
+/**
+ * Returns the value of one of the properties retrieved by npm view.
+ *
+ * @param packageName   Name of the package
+ * @param field         Field such as "versions" or "dist-tags.latest" are parsed from the pacote result (https://www.npmjs.com/package/pacote#packument)
+ * @param currentVersion
+ * @returns            Promised result
+ */
+export declare function viewOne(packageName: string, field: string, currentVersion: Version, options: Options, npmConfigLocal?: NpmConfig): Promise<string | boolean | {
+    engines: {
+        node: string;
+    };
+} | undefined | Index<string> | Packument[]>;
+/**
+ * Spawns npm. Handles different commands for Window and Linux/OSX, and automatically converts --location=global to --global on node < 8.11.0.
+ *
+ * @param args
+ * @param [npmOptions={}]
+ * @param [spawnOptions={}]
+ * @returns
+ */
+declare function spawnNpm(args: string | string[], npmOptions?: NpmOptions, spawnOptions?: Index<any>): Promise<any>;
+/**
+ * Get platform-specific default prefix to pass on to npm.
+ *
+ * @param options
+ * @param [options.global]
+ * @param [options.prefix]
+ * @returns
+ */
+export declare function defaultPrefix(options: Options): Promise<string | undefined>;
+/**
+ * Fetches the highest version number, regardless of tag or publish time.
+ *
+ * @param packageName
+ * @param currentVersion
+ * @param options
+ * @returns
+ */
+export declare const greatest: GetVersion;
+/**
+ * Fetches the list of peer dependencies for a specific package version.
+ *
+ * @param packageName
+ * @param version
+ * @returns Promised {packageName: version} collection
+ */
+export declare const getPeerDependencies: (packageName: string, version: Version) => Promise<Index<Version>>;
+/**
+ * Fetches the list of all installed packages.
+ *
+ * @param [options]
+ * @param [options.cwd]
+ * @param [options.global]
+ * @param [options.prefix]
+ * @returns
+ */
+export declare const list: (options?: Options) => Promise<Index<string | undefined>>;
+/**
+ * Fetches the version of a package published to options.distTag.
+ *
+ * @param packageName
+ * @param currentVersion
+ * @param options
+ * @returns
+ */
+export declare const distTag: GetVersion;
+/**
+ * Fetches the version published to the latest tag.
+ *
+ * @param packageName
+ * @param currentVersion
+ * @param options
+ * @returns
+ */
+export declare const latest: GetVersion;
+/**
+ * Fetches the most recently published version, regardless of version number.
+ *
+ * @param packageName
+ * @param currentVersion
+ * @param options
+ * @returns
+ */
+export declare const newest: GetVersion;
+/**
+ * Fetches the highest version with the same major version as currentVersion.
+ *
+ * @param packageName
+ * @param currentVersion
+ * @param options
+ * @returns
+ */
+export declare const minor: GetVersion;
+/**
+ * Fetches the highest version with the same minor and major version as currentVersion.
+ *
+ * @param packageName
+ * @param currentVersion
+ * @param options
+ * @returns
+ */
+export declare const patch: GetVersion;
+export default spawnNpm;