nypm

🌈 nypm

🌈 Unified Package Manager for Node.js (npm, pnpm, yarn), Bun and Deno.

✅ Supports npm, yarn, pnpm and bun and deno 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.

✅ corepack integration for pnpm and yarn.

nypm command

Install dependencies:

npx nypm i

Add a dependency:

npx nypm add defu

Remove a dependency:

npx nypm remove defu

API Usage

Install package:

# ✨ Auto-detect
npx nypm install nypm

# npm
npm install nypm

# yarn
yarn add nypm

# pnpm
pnpm install nypm

# bun
bun install nypm

# deno
deno install nypm

Import:

// ESM import
import { addDependency } from "nypm";

// or dynamic import
const { addDependency } = await import("nypm");

addDependency(name, options)

Adds dependency to the project.

addDevDependency(name, options)

Adds dev dependency to the project.

detectPackageManager(cwd, options)

Detect the package manager used in a directory (and up) by checking various sources:

• Use packageManager field from package.json
• Known lock files and other files

ensureDependencyInstalled(name, options)

Ensures dependency is installed.

installDependencies(options)

Installs project dependencies.

removeDependency(name, options)

Removes dependency from the project.

dedupeDependencies(options)

Dedupe project dependencies.

runScript(name, options)

Runs a script defined in the package.json file.

[!NOTE] For bun and deno it will remove the lockfile and reinstall all dependencies.

💻 Development

• Clone this repository
• Play Nyan Cat in the background (really important!)
• Enable Corepack using corepack enable
• 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 experience.

• pi0/yarnpm
• unjs/lmify
• antfu/ni
• antfu/install-pkg
• egoist/dum
• nodejs/corepack

License

Made with 💛

Published under MIT License.

Changelog

v0.6.0

compare changes

🚀 Enhancements

• Add runScript utility (#191)

🩹 Fixes

• ⚠️ Check exitCode for failed commands (2d6cfbf)
• dedupeDependencies: Use install for yarn v1 (8ec61f3)
• ⚠️ Correctly detect yarn majorVersion (#193)

💅 Refactors

• Remove ufo dependency (b295f7e)

📦 Build

• ⚠️ Esm-only (bd06ebc)

🏡 Chore

• Update deps (8c45496)
• Update pkg-types to v2 (b3169a0)
• Apply automated updates (f281923)

⚠️ Breaking Changes

• ⚠️ Check exitCode for failed commands (2d6cfbf)
• ⚠️ Correctly detect yarn majorVersion (#193)
• ⚠️ Esm-only (bd06ebc)

❤️ Contributors

• Lennart [e-mail]
• Pooya Parsa (@pi0)
• Damian Głowala (@DamianGlowala)