install-peerdeps
As seen on the README of Airbnb's ESLint config!
Disclaimer: Airbnb is not affiliated with, and does not endorse, this CLI tool
A command-line interface to install an NPM package and its peer dependencies automatically.
Starting with NPM v3.0, peer dependencies are not automatically installed on npm install
, and it can be a hassle to install them all manually. The install-peerdeps
tool makes the process fast and easy.
Also works with Yarn.
Quick Start
# If you're using npm
npm install -g install-peerdeps
# If you're using yarn
yarn global add install-peerdeps
cd my-project-directory
install-peerdeps <package>[@<version>]
The specified package along with its peer dependencies will be installed.
Why
It's true that on Linux you can run something like this to automatically install peerDeps (taken from AirBnb's eslint config repo):
(
export PKG=eslint-config-airbnb;
npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)
However, the above solution is hard to remember, and doesn't work on Windows. This tool aims to solve both of these problems.
Usage
Usage: install-peerdeps <package>[@<version>], default version is 'latest'
Installs the specified package along with correct peerDeps.
Options:
-V, --version output the version number
-d, --dev Install the package as a devDependency
-g, --global Install the package globally
-o, --only-peers Install only peerDependencies of the package
-S, --silent If using npm, don't save in package.json
-Y, --yarn Install with Yarn
-r, --registry <uri> Install from custom registry (defaults to NPM registry)
--dry-run Do not install packages, but show the install command that will be run
-a, --auth <token> Provide an NPM authToken for private packages.
-p, --proxy <http_proxy> Enable http proxy to connect to the registry
-x, --extra-args "<extra_args>" Extra arguments to pass through to NPM or Yarn
-h, --help output usage information
Extra Arguments
Only core Yarn and NPM arguments relating to package installation are officially provided by install-peerdeps
. However, if you'd like to pass through additional arguments, you may do so with --extra-args
. Here's how you'd install a package into a Yarn-workspace-enabled repository:
install-peerdeps <package> --dev -Y --extra-args "-W"
Here's how you'd use --extra-args
to pass a custom NPM config option (in this case, disabling strict-ssl
when accessing a custom registry over HTTPS):
install-peerdeps <package> -p http://proxy:8080 --extra-args "--strict-ssl false"
Examples
Basic Peer Dependency Installation
eslint-config-airbnb
requires quite a few peer dependencies. Here's what you'd do to install them all:
install-peerdeps eslint-config-airbnb --dev
install-peerdeps
will automatically detect whether you're using Yarn. If you are, it'll prompt you as to whether you want to use Yarn or npm to install the packages.
# If you're using npm
npm install eslint-config-airbnb eslint@^3.9.1 eslint-plugin-jsx-a11y@^2.2.3 eslint-plugin-import@^2.1.0 eslint-plugin
-react@^6.6.0 --save-dev
# If you're using yarn
yarn add eslint-config-airbnb eslint@^3.9.1 eslint-plugin-jsx-a11y@^2.2.3 eslint-plugin-import@^2.1.0 eslint-plugin
-react@^6.6.0 --dev
Installing a Different Version Tag
If you'd like to install a different version of a package than the latest (the default), simply specify the version like so:
install-peerdeps @angular/core@next
The tool will automatically install the version corresponding to the tag, as well as its peer dependencies:
...
Installing peerdeps for @angular/core@4.0.0-beta.1.
yarn add @angular/core rxjs@^5.0.1 zone.js@^0.7.2
yarn add v0.18.1
...
Installing from a Custom Registry
To install from a custom registry, use the --registry
option:
install-peerdeps my-custom-package --registry https://registry.mycompany.com
.
Installing a Private Package
To install a private npm package (either from npm or from a registry that uses an authorization header), use the auth option:
install-peerdeps my-private-package --auth your-npm-auth-token
Proxies
To use this tool with a proxy, set the HTTPS_PROXY
environment variable (if you're using a custom registry and it is only accessible over HTTP, though, set the HTTP_PROXY
environment variable).
Under the hood, this package uses the request
module to get package information from the registry and it spawns an NPM or Yarn child process for the actual installation.
request
respects the HTTP_PROXY
and HTTPS_PROXY
environment variables, and spawn
passes environment variables to the child process, so if you have the PROXY
environment variables correctly set, everything should work. Nonetheless, proxy support is a new addition to this tool (added in v1.4.0), so please leave an issue if you have any problems.
HTTPS_PROXY=https://proxy.mycompany.com/ install-peerdeps my-company-package
Alternatively, you may use the --proxy
flag like so:
install-peerdeps my-company-package --proxy https://proxy.mycompany.com/
Contributing
See CONTRIBUTING.md