How to install npm peer dependencies automatically?

When it comes to automatically installing npm peer dependencies, there are several approaches. For instance, using npm and some third-party tools, I will explain how to automate this process.

1. Using npm's Built-in Features (npm 7 and above)

Starting with npm 7, npm has enhanced its handling of peer dependencies. In earlier versions, npm did not automatically install peer dependencies, but from npm 7 onwards, it attempts to automatically install all required peer dependencies. Consequently, when using npm 7 or higher, installing the primary dependencies will also automatically install the relevant peer dependencies.

Example:

If your project depends on react and react-dom, and you also use a plugin like material-ui which has peer dependencies on react and react-dom, simply run:

bash
npm install

npm will inspect the package.json file, automatically resolving and installing all necessary packages, including peer dependencies.

2. Using Third-Party Tools (e.g., npm 6 and below)

For users of older npm versions or when additional features such as more detailed dependency conflict management are needed, consider using third-party tools to automatically manage and install peer dependencies.

Using install-peerdeps

install-peerdeps is a command-line tool that automatically installs a package and its peer dependencies. This is particularly useful when working with older npm versions.

Installation Method:

First, globally install this tool:

bash
npm install -g install-peerdeps

Usage:

Then, install a package and its peer dependencies with:

bash
install-peerdeps <package-name>

For example, to install eslint-config-airbnb with its peer dependencies:

bash
install-peerdeps eslint-config-airbnb

This command automatically analyzes the peer dependencies of eslint-config-airbnb and installs them alongside the package in your project.

Conclusion

For users of npm 7 and above, it is recommended to utilize npm's built-in functionality, as it is the simplest and most direct approach. For users of older npm versions or when specific situations require more flexible management, consider using third-party tools like install-peerdeps. This ensures the project's dependency integrity and compatibility while automating the installation of peer dependencies.