🌈 nypm

Unified Package Manager for Node.js

🚧 This project is under development. Please follow issues for the roadmap. 🚧

What does nypm do?

✅ Supports npm, yarn and pnpm out of the box with a unified API

✅ Provides an API interface to interact with package managers

✅ Autodetects project's package manager using package.json and known lockfiles

✅ Auto-installs and use exactly expected version of package manager using nodejs/corepack

✅ Minimal implementation

nypm, detects package manager type and version and converts command into package manager CLI arguments. It then uses corepack to execute package manager's command (and download it if necessary).

  +------------------------------------+
  |                nypm                |
  +------------------------------------+
  +------------------------------------+
  |              Corepack              |
  +------------------------------------+
  +---------+  +---------+   +---------+
  |   npm   |  |  yarn   |   |  pnpm   |
  +---------+  +---------+   +---------+
  +------------------------------------+
  |         Node.js project            |
  +------------------------------------+

CLI Usage

[TBA]

API Usage

Install package:

# npm
npm install nypm

# yarn
yarn add nypm

# pnpm
pnpm install nypm

Import:

// ESM
import {
  detectPackageManager,
  addDependency,
  addDevDependency,
  removeDependendency,
} from "nypm";

// CommonJS
const {
  detectPackageManager,
  addDependency,
  addDevDependency,
  removeDependendency,
} = require("nypm");

💻 Development

Clone this repository
Play Nyan Cat in the background (really important!)
Enable Corepack using corepack enable (use npm i -g corepack for Node.js < 16.10)
Install dependencies using pnpm install
Run interactive tests using pnpm dev

Related Projects

NYPM is inspired from previous attempts and projects for unifying package manager exeperience.

License

Made with 💛

Published under MIT License.

dnldsht / nypm