yarn-or-npm

What is yarn-or-npm?

The yarn-or-npm package is a utility that helps developers determine whether to use Yarn or npm for running scripts and installing dependencies. It provides a simple API to detect the package manager being used in a project and execute commands accordingly.

What are yarn-or-npm's main functionalities?

Detecting the package manager

This feature allows you to detect whether Yarn or npm is being used in the current project. The code sample demonstrates how to require the yarn-or-npm package, call it to determine the package manager, and log the result.

const yarnOrNpm = require('yarn-or-npm');
const packageManager = yarnOrNpm();
console.log(`Using ${packageManager}`);

Running commands with the detected package manager

This feature allows you to run commands using the detected package manager. The code sample shows how to use the execSync function from the child_process module to run the install command with the detected package manager.

const yarnOrNpm = require('yarn-or-npm');
const { execSync } = require('child_process');
const packageManager = yarnOrNpm();
execSync(`${packageManager} install`);

Other packages similar to yarn-or-npm

which-pm-runs

The which-pm-runs package is a utility that detects which package manager (npm, Yarn, or pnpm) initiated the current process. Unlike yarn-or-npm, which-pm-runs focuses solely on detection and does not provide functionality for running commands.

preferred-pm

The preferred-pm package determines the preferred package manager for a given project by reading the project's configuration files. It supports npm, Yarn, and pnpm. While yarn-or-npm focuses on detecting and running commands, preferred-pm is more about identifying the preferred package manager based on project settings.

README

yarn-or-npm

Execute scripts with Yarn or npm.

yarn add -D yarn-or-npm
# or
npm i --save-dev yarn-or-npm

The client is determined by a series of ordered checks:

1. yarn.lock file is in the nearest package directory - yarn
2. package-lock.json file is in the nearest package directory - npm
3. yarn is installed - yarn
4. Fallback - npm

Module

import yarnOrNpm, { spawn, hasYarn, hasNpm } from 'yarn-or-npm';

// String of `yarn` or `npm` returned
console.log(yarnOrNpm());

// Boolean values for hasYarn, hasNpm
console.log(hasYarn());

// Spawn yarn or npm command
spawn(['init']);

// Spawn sync option
spawn.sync(['init'], { stdio: 'inherit' });

Under the covers, there are cached lookup values being used for efficiency. These can be manually cleared:

import yarnOrNpm from 'yarn-or-npm';
import { spawnSync } from 'child_process';

console.log(yarnOrNpm.hasYarn()); // false

spawnSync('npm', ['i', '-g', 'yarn'], { stdio: 'inherit' });

console.log(yarnOrNpm.hasYarn()); // false (cached)

yarnOrNpm.clearCache();
console.log(yarnOrNpm.hasYarn()); // true

CLI

yarn-or-npm <command>
# Can also use `yon` shorthand
yon <command>

Package

Modules with bin files can be called directly in package.json scripts:

{
  "devDependencies": {
    ...
    "yarn-or-npm": "^1.0.0"
  },
  "scripts": {
    "compile": "babel src --out-dir dist",
    "lint": "eslint .",
    "prepublish": "yarn-or-npm run lint && yarn-or-npm run compile"
  }
}