Install pnpm

https://pnpm.io/installation

Remove node_modules

npx npkill

Add a preinstall Hook

{
  "scripts": {
    "preinstall": "npx only-allow pnpm"
    // ...
  }
}

(Optional) Create pnpm-workspace.yaml

TIP

This touches on a software development strategy called monorepo.

packages:
  # include packages in subfolders (change as required)
  - 'apps/**'
  # all packages in direct subdirs of packages/
  - 'packages/**'
  # exclude packages that are inside test directories
  - '!**/test/**'

Remove workspaces from package.json.

(Optional) Warning When Running pnpm add

1. Add the -w flag when installing:

   pnpm add <pkg> -w

   INFO

   Some third-party scripts run pnpm add automatically, so you may not control the CLI options—see the next approach.

   This might not be the best practice in a monorepo setup.

2. Create an .npmrc file in the project root with the following content:

   ignore-workspace-root-check=true

Generate pnpm-lock.yaml from package-lock.json

pnpm import

Remove package-lock.json

rm -f package-lock.json

Install Dependencies with pnpm

# Alias: pnpm i
pnpm install

Replace npm run xxx with pnpm xxx

{
  "scripts": {
    "test": "npm run test", 
    "test": "pnpm test"
  }
}

Update engine in package.json

• https://pnpm.io/package_json#engines

TIP

This article references:

• How to migrate from yarn / npm to pnpm
• Migrate npm to pnpm