preferred-pm

What is preferred-pm?

The preferred-pm npm package is designed to detect and suggest the preferred package manager for a given project. It checks for lock files such as package-lock.json, yarn.lock, or pnpm-lock.yaml to determine which package manager was previously used with the project and suggests using the same one for consistency.

What are preferred-pm's main functionalities?

Detecting preferred package manager

This feature allows you to detect the preferred package manager for the current project by analyzing the lock files present in the project directory. The code sample demonstrates how to use the package to find and log the preferred package manager.

const preferredPM = require('preferred-pm');

(async () => {
  const pm = await preferredPM(process.cwd());
  if (pm) {
    console.log(`The preferred package manager is ${pm.name}`);
  } else {
    console.log('No preferred package manager found');
  }
})();

Other packages similar to preferred-pm

which-pm-runs

This package can be used to detect which package manager executes the current process. It is similar to preferred-pm in that it helps identify the package manager in use, but it does so at runtime rather than by checking lock files.

check-package-manager

This package provides a way to check if the correct package manager is being used based on a configuration file. It is similar to preferred-pm in ensuring consistency in package manager usage but uses a different approach by relying on a config file.

README

preferred-pm

Returns the preferred package manager of a project

• Inside a Yarn workspace, Yarn is preferred.
• Inside a pnpm workspace, pnpm is preferred.
• If a package-lock.json is present, npm is preferred.
• If a yarn.lock is present, Yarn is preferred.
• If a pnpm-lock.yaml is present, pnpm is preferred.
• If a bun.lockb is present, Bun is preferred.
• If a node_modules is present, tries to detect which package manager installed it.

Installation

<pnpm|yarn|npm|bun> add preferred-pm

Usage

'use strict'
const preferredPM = require('preferred-pm')

preferredPM(process.cwd())
    .then(pm => console.log(pm))
//> {name: "npm", version: ">=5"}

Related

• which-pm - Detects what package manager was used for installation
• which-pm-runs - Detects what package manager executes the process

License

MIT © Zoltan Kochan